org.apache.nifi.lookup.maxmind

Class IPLookupService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.lookup.maxmind.IPLookupService

All Implemented Interfaces:

ConfigurableComponent, ControllerService, LookupService<Record>, RecordLookupService

@Tags(value={"lookup","enrich","ip","geo","ipgeo","maxmind","isp","domain","cellular","anonymous","tor"})
 @CapabilityDescription(value="A lookup service that provides several types of enrichment information for IP addresses. The service is configured by providing a MaxMind Database file and specifying which types of enrichment should be provided for an IP Address or Hostname. Each type of enrichment is a separate lookup, so configuring the service to provide all of the available enrichment data may be slower than returning only a portion of the available enrichments. In order to use this service, a lookup must be performed using key of \'ip\' and a value that is a valid IP address or hostname. View the Usage of this component and choose to view Additional Details for more information, such as the Schema that pertains to the information that is returned.")
public class IPLookupService
extends AbstractControllerService
implements RecordLookupService

Field Summary

Fields

Modifier and Type	Field and Description
private String	databaseChecksum
private String	databaseFile
private long	databaseLastRefreshAttempt
private com.maxmind.geoip2.DatabaseReader	databaseReader
private Lock	dbWriteLock
(package private) static PropertyDescriptor	GEO_DATABASE_FILE
private static String	IP_KEY
(package private) static PropertyDescriptor	LOOKUP_ANONYMOUS_IP_INFO
(package private) static PropertyDescriptor	LOOKUP_CITY
(package private) static PropertyDescriptor	LOOKUP_CONNECTION_TYPE
(package private) static PropertyDescriptor	LOOKUP_DOMAIN
(package private) static PropertyDescriptor	LOOKUP_ISP
(package private) static long	REFRESH_THRESHOLD_MS
private static Set<String>	REQUIRED_KEYS

Constructor Summary

Constructors

Constructor and Description
IPLookupService()

Method Summary

Modifier and Type	Method and Description
void	closeReader()
private Record	createContainerRecord(Record geoRecord, Record ispRecord, String domainName, String connectionType, Record anonymousIpRecord)
private Record	createRecord(com.maxmind.geoip2.model.AnonymousIpResponse anonymousIp)
private Record	createRecord(com.maxmind.geoip2.model.CityResponse city)
private Record	createRecord(com.maxmind.geoip2.record.Country country)
private Record	createRecord(com.maxmind.geoip2.model.IspResponse isp)
private Record	createRecord(com.maxmind.geoip2.record.Subdivision subdivision)
private Optional<Record>	doLookup(com.maxmind.geoip2.DatabaseReader databaseReader, Map<String,Object> coordinates)
private String	getChecksum(File file)
Set<String>	getRequiredKeys()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
private void	loadDatabase(File dbFile, String dbFileChecksum)
Optional<Record>	lookup(Map<String,Object> coordinates)
void	onEnabled(ConfigurationContext context)
private void	refreshDatabase()
private boolean	shouldAttemptDatabaseRefresh()

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getConfigurationContext, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, init, initialize, isEnabled

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.lookup.RecordLookupService

getValueType

Methods inherited from interface org.apache.nifi.lookup.LookupService

lookup

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize, isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

databaseFile

private volatile String databaseFile

IP_KEY

private static final String IP_KEY

See Also:

Constant Field Values

REQUIRED_KEYS

private static final Set<String> REQUIRED_KEYS

databaseReader

private volatile com.maxmind.geoip2.DatabaseReader databaseReader

databaseChecksum

private volatile String databaseChecksum

databaseLastRefreshAttempt

private volatile long databaseLastRefreshAttempt

dbWriteLock

private final Lock dbWriteLock

REFRESH_THRESHOLD_MS

static final long REFRESH_THRESHOLD_MS

See Also:

Constant Field Values

GEO_DATABASE_FILE

static final PropertyDescriptor GEO_DATABASE_FILE

LOOKUP_CITY

static final PropertyDescriptor LOOKUP_CITY

LOOKUP_ISP

static final PropertyDescriptor LOOKUP_ISP

LOOKUP_DOMAIN

static final PropertyDescriptor LOOKUP_DOMAIN

LOOKUP_CONNECTION_TYPE

static final PropertyDescriptor LOOKUP_CONNECTION_TYPE

LOOKUP_ANONYMOUS_IP_INFO

static final PropertyDescriptor LOOKUP_ANONYMOUS_IP_INFO

Constructor Detail

IPLookupService

public IPLookupService()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onEnabled

@OnEnabled
public void onEnabled(ConfigurationContext context)
                          throws IOException

Throws:

IOException

getChecksum

private String getChecksum(File file)
                    throws IOException

Throws:

IOException

closeReader

@OnStopped
public void closeReader()
                            throws IOException

Throws:

IOException

getRequiredKeys

public Set<String> getRequiredKeys()

Specified by:

getRequiredKeys in interface LookupService<Record>

lookup

public Optional<Record> lookup(Map<String,Object> coordinates)
                        throws LookupFailureException

Specified by:

lookup in interface LookupService<Record>

Throws:

LookupFailureException

doLookup

private Optional<Record> doLookup(com.maxmind.geoip2.DatabaseReader databaseReader,
                                  Map<String,Object> coordinates)
                           throws LookupFailureException,
                                  com.maxmind.db.InvalidDatabaseException

Throws:

LookupFailureException

com.maxmind.db.InvalidDatabaseException

shouldAttemptDatabaseRefresh

private boolean shouldAttemptDatabaseRefresh()

refreshDatabase

private void refreshDatabase()
                      throws IOException

Throws:

IOException

loadDatabase

private void loadDatabase(File dbFile,
                          String dbFileChecksum)
                   throws IOException

Throws:

IOException

createRecord

private Record createRecord(com.maxmind.geoip2.model.CityResponse city)

createRecord

private Record createRecord(com.maxmind.geoip2.record.Subdivision subdivision)

createRecord

private Record createRecord(com.maxmind.geoip2.record.Country country)

createRecord

private Record createRecord(com.maxmind.geoip2.model.IspResponse isp)

createRecord

private Record createRecord(com.maxmind.geoip2.model.AnonymousIpResponse anonymousIp)

createContainerRecord

private Record createContainerRecord(Record geoRecord,
                                     Record ispRecord,
                                     String domainName,
                                     String connectionType,
                                     Record anonymousIpRecord)