com.maxmind.geoip2

Class DatabaseReader

java.lang.Object

com.maxmind.geoip2.DatabaseReader

All Implemented Interfaces:

DatabaseProvider, GeoIp2Provider, Closeable, AutoCloseable

public class DatabaseReader
extends Object
implements DatabaseProvider, Closeable

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.

Method Summary

Modifier and Type	Method and Description
AnonymousIpResponse	anonymousIp(InetAddress ipAddress) Look up an IP address in a GeoIP2 Anonymous IP.
CityResponse	city(InetAddress ipAddress)
void	close() Closes the database.
ConnectionTypeResponse	connectionType(InetAddress ipAddress) Look up an IP address in a GeoIP2 Connection Type database.
CountryResponse	country(InetAddress ipAddress)
DomainResponse	domain(InetAddress ipAddress) Look up an IP address in a GeoIP2 Domain database.
EnterpriseResponse	enterprise(InetAddress ipAddress) Look up an IP address in a GeoIP2 Enterprise database.
com.maxmind.db.Metadata	getMetadata()
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

Method Detail

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 CountryResponse country(InetAddress ipAddress)
                        throws IOException,
                               GeoIp2Exception

Specified by:

country in interface GeoIp2Provider

Parameters:

ipAddress - IPv4 or IPv6 address to lookup.

Returns:

A Country model for the requested IP address.

Throws:

IOException - if there is an IO error

GeoIp2Exception - if there is an error looking up the IP

city

public CityResponse city(InetAddress ipAddress)
                  throws IOException,
                         GeoIp2Exception

Specified by:

city in interface GeoIp2Provider

Parameters:

ipAddress - IPv4 or IPv6 address to lookup.

Returns:

A City model for the requested IP address.

Throws:

IOException - if there is an IO error

GeoIp2Exception - if there is an error looking up the IP

anonymousIp

public AnonymousIpResponse anonymousIp(InetAddress ipAddress)
                                throws IOException,
                                       GeoIp2Exception

Look up an IP address in a GeoIP2 Anonymous IP.

Specified by:

anonymousIp in interface DatabaseProvider

Parameters:

ipAddress - IPv4 or IPv6 address to lookup.

Returns:

a AnonymousIpResponse for the requested IP address.

Throws:

GeoIp2Exception - if there is an error looking up the IP

IOException - if there is an IO error

connectionType

public ConnectionTypeResponse connectionType(InetAddress ipAddress)
                                      throws IOException,
                                             GeoIp2Exception

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

Specified by:

connectionType in interface DatabaseProvider

Parameters:

ipAddress - IPv4 or IPv6 address to lookup.

Returns:

a ConnectTypeResponse for the requested IP address.

Throws:

GeoIp2Exception - if there is an error looking up the IP

IOException - if there is an IO error

domain

public DomainResponse domain(InetAddress ipAddress)
                      throws IOException,
                             GeoIp2Exception

Look up an IP address in a GeoIP2 Domain database.

Specified by:

domain in interface DatabaseProvider

Parameters:

ipAddress - IPv4 or IPv6 address to lookup.

Returns:

a DomainResponse for the requested IP address.

Throws:

GeoIp2Exception - if there is an error looking up the IP

IOException - if there is an IO error

enterprise

public EnterpriseResponse enterprise(InetAddress ipAddress)
                              throws IOException,
                                     GeoIp2Exception

Look up an IP address in a GeoIP2 Enterprise database.

Specified by:

enterprise in interface DatabaseProvider

Parameters:

ipAddress - IPv4 or IPv6 address to lookup.

Returns:

an EnterpriseResponse for the requested IP address.

Throws:

GeoIp2Exception - if there is an error looking up the IP

IOException - if there is an IO error

isp

public IspResponse isp(InetAddress ipAddress)
                throws IOException,
                       GeoIp2Exception

Look up an IP address in a GeoIP2 ISP database.

Specified by:

isp in interface DatabaseProvider

Parameters:

ipAddress - IPv4 or IPv6 address to lookup.

Returns:

an IspResponse for the requested IP address.

Throws:

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.