Java Component User Manual - Copyright 2001-2014 IP2Location.com. All Rights Reserved. Visit our Web site at
←
→
Page content transcription
If your browser does not render page correctly, please read the page content below
Java
Component
User Manual
Developed by Hexasoft Development Sdn. Bhd.
Copyright © 2001-2014 IP2Location.com.
All Rights Reserved.
Visit our Web site at
http://www.ip2location.com
User
~ Bringing Geography to the InternetHOME
~
[Pick the date]INTRODUCTION
IP2Location™ is the solution for identifying the country origin, region, city, latitude, longitude,
ZIP code, ISP and domain name of your site visitors in real-time by using IP address. This
documentation provides detailed information to help you quickly get up to speed with our
products and master it in no time at all.
Developers use this Java component for projects related to:
Display native language and currency
Redirect based on country
Digital rights management
Prevent password sharing and abuse of service
Reduce credit card fraud
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
IP2Location™ Java component is written for Java SDK and optimized for any platforms with a Java
Virtual Machine installed.
SYSTEM REQUIREMENT
IP2Location™ Java Component has been developed to run exclusively under any platforms with a Java
Virtual Machine. This component required a local IP2Location™ database for lookup purpose. No
Internet connection is required to execute this component.
Minimum Requirements
• Java JDK 1.4 or later
Supported Platforms
Microsoft Windows XP or later (client OS)
Microsoft Windows Server 2003 or later (server OS)
MacOS
Unix/Linux
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
1Quick Start Guide
In this document, you will go through these basic steps to use IP2Location™ Java component:
1. Download and installing IP2Location Java Component
2. Test your Java Component installation
3. Start using IP2Location™ in your projects
4. Purchase license to remove random 5 second delay in demo version
5. Update IP2Location™ Component database
Note: For the demo version, you will have a random 5-second delay. Registered version has unlimited
real-time query without delay.
1) DOWNLOAD AND INSTALLING JAVA COMPONENT
1.1 Download Setup File
Please use the following URL to download the latest IP2Location™ Java Component together with
sample database.
http://www.ip2location.com/downloads/ip2location-java-component.zip
1.2 Component Installation
Installing the IP2Location Java component system is very easy. You just need to extract the ZIP file to
your local machine.
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
22) TESTING IP2LOCATION TM JAVA COMPONENT
2.1 Folders and Files Structure
You should found the following folders and files in the installation directory.
/demos/IP2LOCATION-LITE-DB1.BIN
/demos/IP2LOCATION-LITE-DB1.IPV6.BIN
/demos/Main.java
/libs/ip2location.jar
/README.txt
/License.txt
/ip2location_java_user_manual.pdf
2.2 Component Testing
Please open command prompt to rebuild and execute the application.
Sample Code for IP2Location Java Component
File located in :
/demos/Main.java
Windows & Linux Platforms
Compile Sample Code (Windows & Linux)
javac -classpath /IP2LocationJavaComponent/libs/ip2location.jar Main.java
Running Sample Code (Windows)
You will need Java JDK 1.4 or later. You can run Main.java like this:
java -cp /IP2LocationJavaComponent/libs/ip2location.jar; Main
(optional)
Running Sample Code (Linux)
You will need Java JDK 1.4 or later. You can run Main.java like this:
java -cp /IP2LocationJavaComponent/libs/ip2location.jar: Main
(optional)
with License.key (Windows)
java -cp /IP2LocationJavaComponent/libs/ip2location.jar; Main /Database/IP2LOCATION-LITE-DB1.BIN 200.0.0.1
without License.key (Windows)
java –cp /IP2LocationJavaComponent/libs/ip2location.jar; Main /Database/IP2LOCATION-LITE-DB1.BIN 200.0.0.1
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
33) IMPLEMENTING IP2LOCATION TM JAVA COMPONENT
3.1 IP2Location™ Objects Reference
Object: com.ip2location.IP2Location
Class Variables Description Type
IPDatabasePath Sets the IP2Location™ IPv4 String
database path. The component will
use the database in the component
directory by default.
IPAddress The IP Address you wish to query String
IPLicensePath Sets the license file path for String
component registration. The
component will use the license key
in the component directory by
default.
UseMemoryMappedFile Set to true to speed up queries by boolean
using more memory. Default is
false.
Method Description Return Type
IPQuery(String IPAddress) This function to query com.ip2location.IPResult
IP2Location data
Object: com.ip2location.IPResult
Method Description Return Type
getCountryShort() Returns the two-character String
country code based on ISO
3166.
getCountryLong() Returns the country name String
based on ISO 3166.
getRegion() Returns the region or state String
name.
getCity() Returns the city name. String
getLatitude() Returns the city latitude. Float
getLongitude() Returns the city longitude. Float
getZIPCode() Returns the United States ZIP String
code.
getTimeZone() Returns the Time zone in UTC String
(Coordinated Universal Time)
getISP() Returns the Internet Service String
Provider (ISP) name.
getDomain() Returns the Internet domain String
name associated to IP address
range.
getNetSpeed() Returns the Internet String
Connection Speed (DIAL)
DIAL-UP,(DSL) DSL/CABLE
or(COMP) COMPANY
getIDDCode() Returns the IDD prefix to call String
the city from another country
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
4Object: com.ip2location.IPResult
Method Description Return Type
getAreaCode() Returns the varying length String
number assigned to
geographic areas for call
between cities
getWeatherStationCode() Returns the special code to String
identify the nearest weather
observation station
getWeatherStationName() Returns the name of the String
nearest weather observation
station
getMCC() Returns the mobile country String
code
getMNC() Returns the mobile network String
code
getMobileBrand() Returns the mobile brand String
getElevation() Returns the elevation Float
getUsageType() Returns the usage type String
getStatus() Returns the status code of String
query.
toString() Returns the result in String String
format
* Note: Before retrieving the result please check the status of the result. If the result is
successfully retrieved it will return “OK” status. If not, an error has occurred.
** Note: If the fields are not supported by the database, the field will return the value
“Not_Supported”.
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
54. PURCHASE IP2LOCATIONTM JAVA COMPONENT
4.1 License Agreement
A license is required for each machine the product is installed on, including development or
staging machines. Please refer to the end of this document for the complete license agreement.
4.3 Purchase Instructions
Proceed to our order page. Fill out the online form and choose the correct number of licenses.
Once your order has been approved, you will receive your license file (License.Key) immediately
through email. Save the license file to the same directory as IP2Location.jar in IP2Location
directory to remove the random 5-second query delay.
Please visit http://www.ip2location.com for online order.
5. UPDATE COMPONENT DATABASE
5.1 Update Component Internal Database
The IP2Location™ Java Component depends to an internal database for lookup purpose. All
users with valid license will be allowed to download the monthly updates from the IP2Location™
download area during subscription period. To update, users need to replace the BIN database
with the latest one from the download area. The component will use the latest database once
the local copy has been updated. Please refer to the welcome email for more information
regarding download updates and account information.
6. UPDATE OR UNINSTALL COMPONENT
6.1 Upgrade Component
To upgrade a new version of the component, you need to download and extract the new
jar file and replace the old jar with this new one.
6.2 Update Database
To update the latest database, you can just replace the existing database binary file.
6.3 Uninstall Component
Just delete the jar file.
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
6APPENDIX I: ISO3166 COUNTRY CODE
This table lists all valid ISO3166 two characters country codes that returns from IP2Location™
Java component and explain the full country names for these country codes.
Country Code 2 Country Name
AD ANDORRA
AE UNITED ARAB EMIRATES
AF AFGHANISTAN
AG ANTIGUA AND BARBUDA
AI ANGUILLA
AL ALBANIA
AM ARMENIA
AO ANGOLA
AQ ANTARCTICA
AR ARGENTINA
AS AMERICAN SAMOA
AT AUSTRIA
AU AUSTRALIA
AW ARUBA
AX ÅLAND ISLANDS
AZ AZERBAIJAN
BA BOSNIA AND HERZEGOWINA
BB BARBADOS
BD BANGLADESH
BE BELGIUM
BF BURKINA FASO
BG BULGARIA
BH BAHRAIN
BI BURUNDI
BJ BENIN
BL SAINT BARTHÉLEMY
BM BERMUDA
BN BRUNEI DARUSSALAM
BO BOLIVIA
BQ BONAIRE, SINT EUSTATIUS AND SABA
BR BRAZIL
BS BAHAMAS
BT BHUTAN
BV BOUVET ISLAND
BW BOTSWANA
BY BELARUS
BZ BELIZE
CA CANADA
CC COCOS (KEELING) ISLANDS
CD CONGO, THE DEMOCRATIC REPUBLIC OF THE
CF CENTRAL AFRICAN REPUBLIC
CG CONGO
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
7Country Code 3 Country Name
CH SWITZERLAND
CI CÔTE D'IVOIRE
CK COOK ISLANDS
CL CHILE
CM CAMEROON
CN CHINA
CO COLOMBIA
CR COSTA RICA
CU CUBA
CV CAPE VERDE
CW CURAÇAO
CX CHRISTMAS ISLAND
CY CYPRUS
CZ CZECH REPUBLIC
DE GERMANY
DJ DJIBOUTI
DK DENMARK
DM DOMINICA
DO DOMINICAN REPUBLIC
DZ ALGERIA
EC ECUADOR
EE ESTONIA
EG EGYPT
EH WESTERN SAHARA
ER ERITREA
ES SPAIN
ET ETHIOPIA
FI FINLAND
FJ FIJI
FK FALKLAND ISLANDS (MALVINAS)
FM MICRONESIA, FEDERATED STATES OF
FO FAROE ISLANDS
FR FRANCE
GA GABON
GB GREAT BRITAIN
GD GRENADA
GE GEORGIA
GF FRENCH GUIANA
GG GUERNSEY
GH GHANA
GI GIBRALTAR
GL GREENLAND
GM GAMBIA
GN GUINEA
GP GUADELOUPE
GQ EQUATORIAL GUINEA
GR GREECE
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
8Country Code 4 Country Name
GS SOUTH GEORGIA & SOUTH SANDWICH ISLANDS
GT GUATEMALA
GU GUAM
GW GUINEA-BISSAU
GY GUYANA
HK HONG KONG
HM HEARD ISLAND AND MCDONALD ISLANDS
HN HONDURAS
HR CROATIA
HT HAITI
HU HUNGARY
ID INDONESIA
IE IRELAND
IL ISRAEL
IM ISLE OF MAN
IN INDIA
IO BRITISH INDIAN OCEAN TERRITORY
IQ IRAQ
IR IRAN, ISLAMIC REPUBLIC OF
IS ICELAND
IT ITALY
JE JERSEY
JM JAMAICA
JO JORDAN
JP JAPAN
KE KENYA
KG KYRGYZSTAN
KH CAMBODIA
KI KIRIBATI
KM COMOROS
KN SAINT KITTS AND NEVIS
KP KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF
KR KOREA, REPUBLIC OF
KW KUWAIT
KY CAYMAN ISLANDS
KZ KAZAKSTAN
LA LAO PEOPLE'S DEMOCRATIC REPUBLIC
LB LEBANON
LC SAINT LUCIA
LI LIECHTENSTEIN
LK SRI LANKA
LR LIBERIA
LS LESOTHO
LT LITHUANIA
LU LUXEMBOURG
LV LATVIA
LY LIBYA
MA MOROCCO
MC MONACO
MD MOLDOVA, REPUBLIC OF
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
9Country Code 5 Country Name
ME MONTENEGRO
MF SAINT MARTIN (FRENCH PART)
MG MADAGASCAR
MH MARSHALL ISLANDS
MK MACEDONIA, THE FORMER YUGOSLAV
ML MALI
MM MYANMAR
MN MONGOLIA
MO MACAU
MP NORTHERN MARIANA ISLANDS
MQ MARTINIQUE
MR MAURITANIA
MS MONTSERRAT
MT MALTA
MU MAURITIUS
MV MALDIVES
MW MALAWI
MX MEXICO
MY MALAYSIA
MZ MOZAMBIQUE
NA NAMIBIA
NC NEW CALEDONIA
NE NIGER
NF NORFOLK ISLAND
NG NIGERIA
NI NICARAGUA
NL NETHERLANDS
NO NORWAY
NP NEPAL
NR NAURU
NU NIUE
NZ NEW ZEALAND
OM OMAN
PA PANAMA
PE PERU
PF FRENCH POLYNESIA
PG PAPUA NEW GUINEA
PH PHILIPPINES
PK PAKISTAN
PL POLAND
PM SAINT PIERRE AND MIQUELON
PN PITCAIRN
PR PUERTO RICO
PS PALESTINIAN, STATE OF
PT PORTUGAL
PW PALAU
PY PARAGUAY
QA QATAR
RE RÉUNION
RO ROMANIA
RS SERBIA
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
10Country Code 6 Country Name
RU RUSSIAN FEDERATION
RW RWANDA
SA SAUDI ARABIA
SB SOLOMON ISLANDS
SC SEYCHELLES
SD SUDAN
SE SWEDEN
SG SINGAPORE
SH SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
SI SLOVENIA
SJ SVALBARD AND JAN MAYEN
SK SLOVAKIA
SL SIERRA LEONE
SM SAN MARINO
SN SENEGAL
SO SOMALIA
SR SURINAME
SS SOUTH SUDAN
ST SAO TOME AND PRINCIPE
SV EL SALVADOR
SX SINT MAARTEN (DUTCH PART)
SY SYRIAN ARAB REPUBLIC
SZ SWAZILAND
TC TURKS AND CAICOS ISLANDS
TD CHAD
TF FRENCH SOUTHERN TERRITORIES
TG TOGO
TH THAILAND
TJ TAJIKISTAN
TK TOKELAU
TL TIMOR-LESTE
TM TURKMENISTAN
TN TUNISIA
TO TONGA
TR TURKEY
TT TRINIDAD AND TOBAGO
TV TUVALU
TW TAIWAN, PROVINCE OF CHINA
TZ TANZANIA, UNITED REPUBLIC OF
UA UKRAINE
UG UGANDA
UK UNITED KINGDOM
UM UNITED STATES MINOR OUTLYING ISLANDS
US UNITED STATES
UY URUGUAY
UZ UZBEKISTAN
VA HOLY SEE (VATICAN CITY STATE)
VC SAINT VINCENT AND THE GRENADINES
VE VENEZUELA
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
11Country Code 7 Country Name
VG VIRGIN ISLANDS, BRITISH
VI VIRGIN ISLANDS, U.S.
VN VIET NAM
VU VANUATU
WF WALLIS AND FUTUNA
WS SAMOA
YE YEMEN
YT MAYOTTE
ZA SOUTH AFRICA
ZM ZAMBIA
ZW ZIMBABWE
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
12IP2LOCATIONTM JAVA COMPONENT LICENSE
AGREEMENT
IMPORTANT-READ CAREFULLY:
This License Agreement is a legal agreement between you (either an individual or a single
entity) and Hexasoft Development Sdn. Bhd., owner of IP2Location™ trademark, (“Hexasoft” or
“we”) for the Hexasoft developed IP2Location™ Java Component (hereafter referred to as the
SOFTWARE PRODUCT) accompanying this License Agreement, which includes web service
routines and data result(s). By exercising your rights to make and use copies of the
SOFTWARE PRODUCT, you agree to be bound by the terms of this License Agreement. If you
do not agree to the terms of this License Agreement, you may not use the SOFTWARE
PRODUCT.
GRANT OF LICENSE.
This License Agreement grants the following rights: You are granted the right to use the
SOFTWARE PRODUCT files on one computer in the Internet or Local Area Network (“LAN”).
You may not use the SOFTWARE PRODUCT files on multiple computers without matching
number of licenses.
DESCRIPTION OF LIMITATIONS.
You may not reverse engineer except and only to the extent that such activity is expressly
permitted by applicable law notwithstanding this limitation. Without prejudice to any other rights,
Hexasoft may terminate this License Agreement if you fail to comply with the terms and
conditions of this License Agreement. In such event, you must destroy all copies of the
SOFTWARE PRODUCT and all of its parts.
COPYRIGHT.
All title and copyrights in and to the SOFTWARE PRODUCT and any copies of the SOFTWARE
PRODUCT are owned by Hexasoft. The SOFTWARE PRODUCT is protected by copyright laws
and international treaty provisions.
NO WARRANTIES.
Hexasoft expressly disclaims any warranty for the SOFTWARE PRODUCT. The SOFTWARE
PRODUCT and any related documentation is provided "as is" without warranty of any kind,
either express or implied, including, without limitation, the implied warranties of merchantability
or fitness for a particular purpose. The entire risk arising out of use or performance of the
SOFTWARE PRODUCT remains with you.
LIMITATION OF LIABILITY.
Hexasoft’s entire liability and your exclusive remedy under this Agreement shall not exceed
fifteen dollars (US $15.00).
NO LIABILITY FOR CONSEQUENTIAL DAMAGES.
In no event shall Hexasoft nor anyone else who has been involved in the creation, production, or
delivery of the SOFTWARE PRODUCT be liable for any damages whatsoever (including,
without limitation, damages for loss of business profits, business interruption, loss of business
information, or any other pecuniary loss) arising out of the use of or inability to use this Hexasoft
product, even if Hexasoft has been advised of the possibility of such damages. Because some
states and jurisdictions do not allow the exclusion or limitation of liability for consequential or
incidental damages, the above limitation may not apply to you.
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
13MISCELLANEOUS
“IP2Location” is a trademark of Hexasoft Development Sdn. Bhd..
“Microsoft” is a registered trademark of Microsoft Corporation.
”Windows” is a registered trademark of Microsoft Corporation.
All other trademarks are the property of their respective owners.
Copyright © 2014 Hexasoft Development Sdn. Bhd., All Rights Reserved.
8 Hexasoft Development Sdn. Bhd.
1-2-15 Mayang Mall Kompleks,
Jalan Mayang Pasir 1,
11950 Bayan Baru,
Pulau Pinang,
Malaysia. Tel: (6)-04-640-2380
Fax: (6)-04-640-2381
Email: sales@ip2location.com
Copyright © 2001-2014 Hexasoft Development Sdn. Bhd. All Rights Reserved.
14You can also read
