com.ip2location.IP2LocationWebService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ip2location-java Show documentation
IP2Location Java Component enables applications to get info from IP address such as the visitor’s country, region, city, latitude, longitude, ZIP code, ISP name, domain name, time zone, connection speed, IDD code, area code, weather station code, weather station name, MCC, MNC, mobile brand name, elevation, usage type, address type, IAB category, district, autonomous system number (ASN) and autonomous system (AS).
The newest version!
package com.ip2location;

import java.util.regex.*;
import java.net.URL;
import java.net.URLEncoder;
import java.lang.StringBuffer; // JDK 1.4 does not support StringBuilder so can't use that

import com.google.gson.*;
import org.apache.commons.lang3.StringUtils;

/**
 * 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-2024 IP2Location.com
 * 
 *
 * @author IP2Location.com
 * @version 8.12.0
 */
public class IP2LocationWebService {
    private static final Pattern pattern = Pattern.compile("^[\\dA-Z]{10}$");
    private static final Pattern pattern2 = Pattern.compile("^WS\\d+$");

    private String _APIKey = "";
    private String _Package = "";
    private boolean _UseSSL = true;

    public IP2LocationWebService() {

    }

    /**
     * This function initializes the params for the web service.
     *
     * @param APIKey  IP2Location Web Service API key
     * @param Package IP2Location Web Service package (WS1 to WS25)
     * @throws IllegalArgumentException If an invalid parameter is specified
     */
    public void Open(String APIKey, String Package) throws IllegalArgumentException {
        Open(APIKey, Package, true);
    }

    /**
     * This function initializes the params for the web service.
     *
     * @param APIKey  IP2Location Web Service API key
     * @param Package IP2Location Web Service package (WS1 to WS25)
     * @param UseSSL  Set to true to call the web service using SSL
     * @throws IllegalArgumentException If an invalid parameter is specified
     */
    public void Open(String APIKey, String Package, boolean UseSSL) throws IllegalArgumentException {
        _APIKey = APIKey;
        _Package = Package;
        _UseSSL = UseSSL;

        CheckParams();
    }

    /**
     * This function validates the API key and package params.
     */
    private void CheckParams() throws IllegalArgumentException {
        if ((!pattern.matcher(_APIKey).matches()) && (!_APIKey.equals("demo"))) {
            throw new IllegalArgumentException("Invalid API key.");
        } else if (!pattern2.matcher(_Package).matches()) {
            throw new IllegalArgumentException("Invalid package name.");
        }
    }

    /**
     * This function to query IP2Location data.
     *
     * @param IPAddress IP Address you wish to query
     * @return IP2Location data
     * @throws IllegalArgumentException If an invalid parameter is specified
     * @throws RuntimeException         If an exception occurred at runtime
     */
    public JsonObject IPQuery(String IPAddress) throws IllegalArgumentException, RuntimeException {
        return IPQuery(IPAddress, null, "en");
    }

    /**
     * This function to query IP2Location data.
     *
     * @param IPAddress IP Address you wish to query
     * @param Language  The translation language
     * @return IP2Location data
     * @throws IllegalArgumentException If an invalid parameter is specified
     * @throws RuntimeException         If an exception occurred at runtime
     */
    public JsonObject IPQuery(String IPAddress, String Language) throws IllegalArgumentException, RuntimeException {
        return IPQuery(IPAddress, null, Language);
    }

    /**
     * This function to query IP2Location data.
     *
     * @param IPAddress IP Address you wish to query
     * @param AddOns    The list of AddOns results to return
     * @param Language  The translation language
     * @return IP2Location data
     * @throws IllegalArgumentException If an invalid parameter is specified
     * @throws RuntimeException         If an exception occurred at runtime
     */
    public JsonObject IPQuery(String IPAddress, String[] AddOns, String Language) throws IllegalArgumentException, RuntimeException {
        try {
            String myurl;
            String myjson;
            CheckParams(); // check here in case user haven't called Open yet

            StringBuffer bf = new StringBuffer();
            bf.append("http");
            if (_UseSSL) {
                bf.append("s");
            }
            bf.append("://api.ip2location.com/v2/?key=").append(_APIKey).append("&package=").append(_Package).append("&ip=").append(URLEncoder.encode(IPAddress, "UTF-8")).append("&lang=").append(URLEncoder.encode(Language, "UTF-8"));

            if ((AddOns != null) && (AddOns.length > 0)) {
                bf.append("&addon=").append(URLEncoder.encode(StringUtils.join(AddOns, ","), "UTF-8"));
            }
            myurl = bf.toString();

            myjson = Http.get(new URL(myurl));

            JsonParser parser = new JsonParser();
            JsonObject myresult = parser.parse(myjson).getAsJsonObject();
            return myresult;
        } catch (IllegalArgumentException ex) {
            throw ex;
        } catch (Exception ex2) {
            throw new RuntimeException(ex2);
        }
    }

    /**
     * This function to check web service credit balance.
     *
     * @return Credit balance
     * @throws IllegalArgumentException If an invalid parameter is specified
     * @throws RuntimeException         If an exception occurred at runtime
     */
    public JsonObject GetCredit() throws IllegalArgumentException, RuntimeException {
        try {
            String myurl;
            String myjson;
            CheckParams(); // check here in case user haven't called Open yet

            StringBuffer bf = new StringBuffer();
            bf.append("http");
            if (_UseSSL) {
                bf.append("s");
            }
            bf.append("://api.ip2location.com/v2/?key=").append(_APIKey).append("&check=true");

            myurl = bf.toString();

            myjson = Http.get(new URL(myurl));

            JsonParser parser = new JsonParser();
            JsonObject myresult = parser.parse(myjson).getAsJsonObject();
            return myresult;
        } catch (IllegalArgumentException ex) {
            throw ex;
        } catch (Exception ex2) {
            throw new RuntimeException(ex2);
        }
    }
}