Package lumis.portal.geolocation

Interface IGeoLocationManagerSPI

All Superinterfaces:

IGeoLocationManager

All Known Implementing Classes:

GeoLocationManager

public interface IGeoLocationManagerSPI
extends IGeoLocationManager

Provides geo location related operations.

Since:

10.2.0

Version:

$Revision$ $Date$

Field Summary

Fields

Modifier and Type	Field	Description
static ILogger	LOGGER	Logger.

Method Summary

Modifier and Type	Method	Description
default void	deleteDatabase()	Delete the currently saved geolocation database;
default void	disable()	Disable geo location service.
default void	enable()	Enable geo location service.
default ExtendedGeoPoint	getGeoPointByServiceInterfaceRequest(IServiceInterfaceRequestSPI interfaceRequestSPI)	Returns the extended geo point based on the given request or null if Geolocation service is disabled or the address couldn't be found.
default void	init()	Initializes the GeoLocation Manager.

Methods inherited from interface lumis.portal.geolocation.IGeoLocationManager

getGeoPointByAddress, getGeoPointByIpOrHostName, getGeoPointByRequest

Field Detail

LOGGER

static final ILogger LOGGER

Logger.

Since:

10.2.0

Method Detail

init

default void init()

Initializes the GeoLocation Manager.

Since:

10.2.0

enable

default void enable()

Enable geo location service.

Since:

10.2.0

disable

default void disable()

Disable geo location service.

Since:

10.2.0

getGeoPointByServiceInterfaceRequest

default ExtendedGeoPoint getGeoPointByServiceInterfaceRequest(IServiceInterfaceRequestSPI interfaceRequestSPI)
                                                       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:

interfaceRequestSPI - 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

deleteDatabase

default void deleteDatabase()
                     throws FileCouldNotBeDeletedException,
                            java.io.IOException

Delete the currently saved geolocation database;

Throws:

FileCouldNotBeDeletedException - if this file could not be deleted

java.io.IOException - if other error occur

Since:

12.2.0