com.ip2location

Class IP2LocationWebService

java.lang.Object

com.ip2location.IP2LocationWebService

public class IP2LocationWebService
extends Object

This class performs the lookup of IP2Location data from an IP address by querying the IP2Location Web Service.

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

Constructor Summary

Constructors

Constructor and Description
IP2LocationWebService()

Method Summary

Modifier and Type	Method and Description
com.google.gson.JsonObject	GetCredit() This function to check web service credit balance.
com.google.gson.JsonObject	IPQuery(String IPAddress) This function to query IP2Location data.
com.google.gson.JsonObject	IPQuery(String IPAddress, String Language) This function to query IP2Location data.
com.google.gson.JsonObject	IPQuery(String IPAddress, String[] AddOns, String Language) This function to query IP2Location data.
void	Open(String APIKey, String Package) This function initializes the params for the web service.
void	Open(String APIKey, String Package, boolean UseSSL) This function initializes the params for the web service.

Methods inherited from class java.lang.Object

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

Constructor Detail

IP2LocationWebService

public IP2LocationWebService()

Method Detail

Open

public void Open(String APIKey,
                 String Package)
          throws IllegalArgumentException

This function initializes the params for the web service.

Parameters:

APIKey - IP2Location Web Service API key

Package - IP2Location Web Service package (WS1 to WS25)

Throws:

IllegalArgumentException - If an invalid parameter is specified

Open

public void Open(String APIKey,
                 String Package,
                 boolean UseSSL)
          throws IllegalArgumentException

This function initializes the params for the web service.

Parameters:

APIKey - IP2Location Web Service API key

Package - IP2Location Web Service package (WS1 to WS25)

UseSSL - Set to true to call the web service using SSL

Throws:

IllegalArgumentException - If an invalid parameter is specified

IPQuery

public com.google.gson.JsonObject IPQuery(String IPAddress)
                                   throws IllegalArgumentException,
                                          RuntimeException

This function to query IP2Location data.

Parameters:

IPAddress - IP Address you wish to query

Returns:

IP2Location data

Throws:

IllegalArgumentException - If an invalid parameter is specified

RuntimeException - If an exception occurred at runtime

IPQuery

public com.google.gson.JsonObject IPQuery(String IPAddress,
                                          String Language)
                                   throws IllegalArgumentException,
                                          RuntimeException

This function to query IP2Location data.

Parameters:

IPAddress - IP Address you wish to query

Language - The translation language

Returns:

IP2Location data

Throws:

IllegalArgumentException - If an invalid parameter is specified

RuntimeException - If an exception occurred at runtime

IPQuery

public com.google.gson.JsonObject IPQuery(String IPAddress,
                                          String[] AddOns,
                                          String Language)
                                   throws IllegalArgumentException,
                                          RuntimeException

This function to query IP2Location data.

Parameters:

IPAddress - IP Address you wish to query

AddOns - The list of AddOns results to return

Language - The translation language

Returns:

IP2Location data

Throws:

IllegalArgumentException - If an invalid parameter is specified

RuntimeException - If an exception occurred at runtime

GetCredit

public com.google.gson.JsonObject GetCredit()
                                     throws IllegalArgumentException,
                                            RuntimeException

This function to check web service credit balance.

Returns:

Credit balance

Throws:

IllegalArgumentException - If an invalid parameter is specified

RuntimeException - If an exception occurred at runtime