com.ip2location

Class IP2Location

java.lang.Object

com.ip2location.IP2Location

public class IP2Location
extends Object

This class performs the lookup of IP2Location data from an IP address by reading a BIN file.

Example usage scenarios:

• Redirect based on country
• Digital rights management
• Web log stats and analysis
• Auto-selection of country on forms
• Filter access from countries you do not do business with
• Geo-targeting for increased sales and click-through
• And much, much more!

Copyright (c) 2002-2023 IP2Location.com

Version:

8.11.1

Author:

IP2Location.com

Field Summary

Fields

Modifier and Type	Field and Description
String	IPDatabasePath Sets the path for the BIN database (IPv4 BIN or IPv4+IPv6 BIN).
String	IPLicensePath Sets the path for the license key file.
boolean	UseMemoryMappedFile To use memory mapped file for faster queries, set to true.

Constructor Summary

Constructors

Constructor and Description
IP2Location()

Method Summary

Modifier and Type	Method and Description
void	Close() This function destroys the mapped bytes.
protected void	finalize() Deprecated.
IPResult	IPQuery(String IPAddress) This function to query IP2Location data.
void	Open(byte[] db)
void	Open(String DBPath) This function can be used to pre-load the BIN file.
void	Open(String DBPath, boolean UseMMF) This function can be used to initialize the component with params and pre-load the BIN file.

Methods inherited from class java.lang.Object

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

Field Detail

UseMemoryMappedFile

public boolean UseMemoryMappedFile

To use memory mapped file for faster queries, set to true.

IPDatabasePath

public String IPDatabasePath

Sets the path for the BIN database (IPv4 BIN or IPv4+IPv6 BIN).

IPLicensePath

public String IPLicensePath

Sets the path for the license key file.

Constructor Detail

IP2Location

public IP2Location()

Method Detail

Open

public void Open(String DBPath)
          throws IOException

This function can be used to pre-load the BIN file.

Parameters:

DBPath - The full path to the IP2Location BIN database file

Throws:

IOException - If an input or output exception occurred

Open

public void Open(String DBPath,
                 boolean UseMMF)
          throws IOException

This function can be used to initialize the component with params and pre-load the BIN file.

Parameters:

DBPath - The full path to the IP2Location BIN database file

UseMMF - Set to true to load the BIN database file into memory mapped file

Throws:

IOException - If an input or output exception occurred

Open

public void Open(byte[] db)
          throws IOException

Throws:

IOException

Close

public void Close()

This function destroys the mapped bytes.

finalize

protected void finalize()
                 throws Throwable

Deprecated.

Overrides:

finalize in class Object

Throws:

Throwable

IPQuery

public IPResult IPQuery(String IPAddress)
                 throws IOException

This function to query IP2Location data.

Parameters:

IPAddress - IP Address you wish to query

Returns:

IP2Location data

Throws:

IOException - If an input or output exception occurred