Package com.storedobject.common

Class IPLocation

java.lang.Object

com.storedobject.common.IPLocation

public class IPLocation
extends Object

The IPLocation class fetches location and network-related information of a given IP address by querying the external API provided by `ipinfo.io`. If no IP address is provided, the class defaults to retrieving information for the IP address of the local machine or network.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
IPLocation()	Constructs an instance of the IPLocation class with the local machine's IP address.
IPLocation(String ip)	Constructs an instance of the IPLocation class with a specified IP address.

Method Summary

Modifier and Type	Method	Description
String	getCity()	Retrieves the city associated with the current IP address.
String	getCountry()	Retrieves the country associated with the current IP address.
String	getHostName()	Retrieves the hostname associated with the current IPLocation instance.
String	getIP()	Retrieves the IP address associated with the current IPLocation instance.
Geolocation	getLocation()	Retrieves the geographical location associated with the current or specified IP address.
String	getOrganization()	Retrieves the organization associated with the current IP address.
String	getRegion()	Retrieves the region associated with the current IP address.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

IPLocation

public IPLocation()

Constructs an instance of the IPLocation class with the local machine's IP address. This constructor initializes the `IPLocation` object to fetch location and network-related information for the default IP address, which corresponds to the machine or network being used to execute the application.

IPLocation

public IPLocation(String ip)

Constructs an instance of the IPLocation class with a specified IP address. This constructor initializes the `IPLocation` object to fetch location and network-related information for the given IP address. If the provided IP address is invalid or empty, it will default to retrieving information based on the local machine's IP address.

Parameters:

ip - the IP address for which location and network-related information will be fetched. If an empty string is provided, the local machine's IP address will be used.

Method Details

getLocation

public Geolocation getLocation()

Retrieves the geographical location associated with the current or specified IP address. The location is parsed from a comma-separated string containing latitude and longitude values. If the location cannot be determined, this method returns null.

Returns:

a Geolocation object representing the latitude and longitude of the IP address, or null if the location is unavailable or cannot be parsed.

getIP

public String getIP()

Retrieves the IP address associated with the current IPLocation instance. If an error occurs or the IP address is unavailable, this method returns null.

Returns:

the IP address as a String, or null if the IP address is unavailable or an error occurs.

getHostName

public String getHostName()

Retrieves the hostname associated with the current IPLocation instance. If an error occurs or the hostname is unavailable, this method returns null.

Returns:

the hostname as a String, or null if the hostname is unavailable or an error occurs.

getCity

public String getCity()

Retrieves the city associated with the current IP address. If an error occurs or the city information is unavailable, this method returns null.

Returns:

the city as a String, or null if the city information is unavailable or an error occurs.

getRegion

public String getRegion()

Retrieves the region associated with the current IP address. If an error occurs or the region information is unavailable, this method returns null.

Returns:

the region as a String, or null if the region information is unavailable or an error occurs.

getCountry

public String getCountry()

Retrieves the country associated with the current IP address. If an error occurs or the country information is unavailable, this method returns null.

Returns:

the country as a String, or null if the country information is unavailable or an error occurs.

getOrganization

public String getOrganization()

Retrieves the organization associated with the current IP address. If an error occurs or the organization information is unavailable, this method returns null.

Returns:

the organization as a String, or null if the organization information is unavailable or an error occurs.

toString

public String toString()

Overrides:

toString in class Object