Package lumis.portal.geolocation

Interface IGeoLocationManager

All Known Subinterfaces:

IGeoLocationManagerSPI

All Known Implementing Classes:

GeoLocationManager

@StableMinor(version="17.0",
             sinceVersion="10.2")
public interface IGeoLocationManager

Provides geo location related actions.

Since:

10.2.0

Version:

$Revision: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $

Field Summary

Fields

Modifier and Type	Field	Description
static ILogger	LOGGER	This class' logger.

Method Summary

Modifier and Type	Method	Description
ExtendedGeoPoint	getGeoPointByAddress(java.net.InetAddress address)	Returns the extended geo point based on the given ip address or null if Geolocation service is disabled or the address couldn't be found.
default ExtendedGeoPoint	getGeoPointByIpOrHostName(java.lang.String ipOrHost)	Returns the extended geo point based on the given ip address or host name or null if Geolocation service is disabled or the address couldn't be found.
default ExtendedGeoPoint	getGeoPointByRequest(HttpServletRequest request)	Returns the extended geo point based on the given request or null if Geolocation service is disabled or the address couldn't be found.

Field Detail

LOGGER

static final ILogger LOGGER

This class' logger.

Since:

10.2.0

Method Detail

getGeoPointByRequest

default ExtendedGeoPoint getGeoPointByRequest(HttpServletRequest request)
                                       throws java.net.UnknownHostException

Returns the extended geo point based on the given request or null if Geolocation service is disabled or the address couldn't be found. Gets the location of remote address.

Parameters:

request - the request.

Returns:

the extended geo point based on the given request or null if Geolocation service is disabled or the address couldn't be found.

Throws:

java.net.UnknownHostException

Since:

10.2.0

getGeoPointByIpOrHostName

default ExtendedGeoPoint getGeoPointByIpOrHostName(java.lang.String ipOrHost)
                                            throws java.net.UnknownHostException

Returns the extended geo point based on the given ip address or host name or null if Geolocation service is disabled or the address couldn't be found.

Parameters:

ipOrHost - the ip address or host name.

Returns:

the extended geo point based on the given ip address or host name or null if Geolocation service is disabled or the address couldn't be found.

Throws:

java.net.UnknownHostException

Since:

10.2.0

getGeoPointByAddress

ExtendedGeoPoint getGeoPointByAddress(java.net.InetAddress address)

Returns the extended geo point based on the given ip address or null if Geolocation service is disabled or the address couldn't be found.

Parameters:

address - the ip address.

Returns:

the extended geo point based on the given ip address or null if Geolocation service is disabled or the address couldn't be found.

Since:

10.2.0