org.apache.nifi.lookup.maxmind

Class DatabaseReader

java.lang.Object

org.apache.nifi.lookup.maxmind.DatabaseReader

All Implemented Interfaces:

com.maxmind.geoip2.GeoIp2Provider, Closeable, AutoCloseable

public class DatabaseReader
extends Object
implements com.maxmind.geoip2.GeoIp2Provider, Closeable

This class was copied from https://raw.githubusercontent.com/maxmind/GeoIP2-java/master/src/main/java/com/maxmind/geoip2/DatabaseReader.java It is written by Maxmind and it is available under Apache Software License V2 The modification we're making to the code below is to stop using exceptions for mainline flow control. Specifically we don't want to throw an exception simply because an address was not found.

Instances of this class provide a reader for the GeoIP2 database format. IP addresses can be looked up using the get method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseReader.Builder Constructs a Builder for the DatabaseReader.

Field Summary

Fields

Modifier and Type	Field and Description
private com.fasterxml.jackson.databind.ObjectMapper	om
private com.maxmind.db.Reader	reader

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DatabaseReader(DatabaseReader.Builder builder)

Method Summary

Modifier and Type	Method and Description
com.maxmind.geoip2.model.AnonymousIpResponse	anonymousIp(InetAddress ipAddress) Look up an IP address in a GeoIP2 Anonymous IP.
com.maxmind.geoip2.model.CityResponse	city(InetAddress ipAddress)
void	close() Closes the database.
com.maxmind.geoip2.model.ConnectionTypeResponse	connectionType(InetAddress ipAddress) Look up an IP address in a GeoIP2 Connection Type database.
com.maxmind.geoip2.model.CountryResponse	country(InetAddress ipAddress)
com.maxmind.geoip2.model.DomainResponse	domain(InetAddress ipAddress) Look up an IP address in a GeoIP2 Domain database.
private <T> T	get(InetAddress ipAddress, Class<T> cls, boolean hasTraits, String type)
com.maxmind.db.Metadata	getMetadata()
com.maxmind.geoip2.model.IspResponse	isp(InetAddress ipAddress) Look up an IP address in a GeoIP2 ISP database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

reader

private final com.maxmind.db.Reader reader

om

private final com.fasterxml.jackson.databind.ObjectMapper om

Constructor Detail

DatabaseReader

private DatabaseReader(DatabaseReader.Builder builder)
                throws IOException

Throws:

IOException

Method Detail

get

private <T> T get(InetAddress ipAddress,
                  Class<T> cls,
                  boolean hasTraits,
                  String type)
           throws IOException,
                  com.maxmind.geoip2.exception.AddressNotFoundException

Parameters:

ipAddress - IPv4 or IPv6 address to lookup.

Returns:

An object of type T with the data for the IP address or null if no information could be found for the given IP address

Throws:

IOException - if there is an error opening or reading from the file.

com.maxmind.geoip2.exception.AddressNotFoundException

close

public void close()
           throws IOException

Closes the database.

If you are using FileMode.MEMORY_MAPPED, this will not unmap the underlying file due to a limitation in Java's MappedByteBuffer. It will however set the reference to the buffer to null, allowing the garbage collector to collect it.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O error occurs.

country

public com.maxmind.geoip2.model.CountryResponse country(InetAddress ipAddress)
                                                 throws IOException,
                                                        com.maxmind.geoip2.exception.GeoIp2Exception

Specified by:

country in interface com.maxmind.geoip2.GeoIp2Provider

Throws:

IOException

com.maxmind.geoip2.exception.GeoIp2Exception

city

public com.maxmind.geoip2.model.CityResponse city(InetAddress ipAddress)
                                           throws IOException,
                                                  com.maxmind.geoip2.exception.GeoIp2Exception

Specified by:

city in interface com.maxmind.geoip2.GeoIp2Provider

Throws:

IOException

com.maxmind.geoip2.exception.GeoIp2Exception

anonymousIp

public com.maxmind.geoip2.model.AnonymousIpResponse anonymousIp(InetAddress ipAddress)
                                                         throws IOException,
                                                                com.maxmind.geoip2.exception.GeoIp2Exception

Look up an IP address in a GeoIP2 Anonymous IP.

Parameters:

ipAddress - IPv4 or IPv6 address to lookup.

Returns:

a AnonymousIpResponse for the requested IP address.

Throws:

com.maxmind.geoip2.exception.GeoIp2Exception - if there is an error looking up the IP

IOException - if there is an IO error

connectionType

public com.maxmind.geoip2.model.ConnectionTypeResponse connectionType(InetAddress ipAddress)
                                                               throws IOException,
                                                                      com.maxmind.geoip2.exception.GeoIp2Exception

Look up an IP address in a GeoIP2 Connection Type database.

Parameters:

ipAddress - IPv4 or IPv6 address to lookup.

Returns:

a ConnectTypeResponse for the requested IP address.

Throws:

com.maxmind.geoip2.exception.GeoIp2Exception - if there is an error looking up the IP

IOException - if there is an IO error

domain

public com.maxmind.geoip2.model.DomainResponse domain(InetAddress ipAddress)
                                               throws IOException,
                                                      com.maxmind.geoip2.exception.GeoIp2Exception

Look up an IP address in a GeoIP2 Domain database.

Parameters:

ipAddress - IPv4 or IPv6 address to lookup.

Returns:

a DomainResponse for the requested IP address.

Throws:

com.maxmind.geoip2.exception.GeoIp2Exception - if there is an error looking up the IP

IOException - if there is an IO error

isp

public com.maxmind.geoip2.model.IspResponse isp(InetAddress ipAddress)
                                         throws IOException,
                                                com.maxmind.geoip2.exception.GeoIp2Exception

Look up an IP address in a GeoIP2 ISP database.

Parameters:

ipAddress - IPv4 or IPv6 address to lookup.

Returns:

an IspResponse for the requested IP address.

Throws:

com.maxmind.geoip2.exception.GeoIp2Exception - if there is an error looking up the IP

IOException - if there is an IO error

getMetadata

public com.maxmind.db.Metadata getMetadata()

Returns:

the metadata for the open MaxMind DB file.