org.n52.iceland.statistics.impl.geolocation

Class StatisticsLocationUtil

java.lang.Object

org.n52.iceland.statistics.impl.geolocation.StatisticsLocationUtil

All Implemented Interfaces:

Constructable, Destroyable, IAdminStatisticsLocation, IStatisticsLocationUtil

@Singleton
 @Configurable
public class StatisticsLocationUtil
extends Object
implements IStatisticsLocationUtil, IAdminStatisticsLocation, Constructable, Destroyable

Utility class for mapping objects to Elasticsearch specific Geolocation type objects

Nested Class Summary

Nested classes/interfaces inherited from interface org.n52.iceland.statistics.api.interfaces.geolocation.IAdminStatisticsLocation

IAdminStatisticsLocation.LocationDatabaseType

Constructor Summary

Constructors

Constructor and Description
StatisticsLocationUtil()

Method Summary

Modifier and Type	Method and Description
void	destroy()
String	getCityDbLoc()
String	getCountryDbLoc()
IAdminStatisticsLocation.LocationDatabaseType	getDbType()
String	getDownloadFolderPath()
void	init()
void	initDatabase(IAdminStatisticsLocation.LocationDatabaseType type, String pathToDatabase) Initialize the memory database.
Map<String,Object>	ip2SpatialData(IPAddress ip)
Map<String,Object>	ip2SpatialData(String host)
boolean	isAutoDownload()
boolean	isEnabled()
IPAddress	resolveOriginalIpAddress(RequestContext ctx) Resolves source IPAddress if there were a proxy get the original address
void	setAutoDownload(String choice)
void	setCityDbLoc(String cityDbLoc)
void	setCountryDbLoc(String countryDbLoc)
void	setDbType(String dbType)
void	setDownloadFolderPath(String downloadFolderPath)
void	setEnabled(boolean enabled)

Methods inherited from class java.lang.Object

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

Constructor Detail

StatisticsLocationUtil

public StatisticsLocationUtil()

Method Detail

ip2SpatialData

public Map<String,Object> ip2SpatialData(IPAddress ip)

Specified by:

ip2SpatialData in interface IStatisticsLocationUtil

ip2SpatialData

public Map<String,Object> ip2SpatialData(String host)

Specified by:

ip2SpatialData in interface IStatisticsLocationUtil

Parameters:

host - String of the IPv4 address e.g.: 123.123.123.123

Returns:

geo loation data in Elasticsearch's accept format

resolveOriginalIpAddress

public IPAddress resolveOriginalIpAddress(RequestContext ctx)

Resolves source IPAddress if there were a proxy get the original address

Specified by:

resolveOriginalIpAddress in interface IStatisticsLocationUtil

Parameters:

ctx - holder of the address

Returns:

caller source address

initDatabase

public void initDatabase(IAdminStatisticsLocation.LocationDatabaseType type,
                         String pathToDatabase)

Description copied from interface: IAdminStatisticsLocation

Initialize the memory database. The path and the LocationDatabaseType MUST match.

Specified by:

initDatabase in interface IAdminStatisticsLocation

Parameters:

type - type of the loaded database from file.

pathToDatabase - can be classpath:[path] or [absolute path] string to the appropriate file.

destroy

public void destroy()

Specified by:

destroy in interface Destroyable

isEnabled

public boolean isEnabled()

setEnabled

@Setting(value="statistics.geoloc.enabled")
public void setEnabled(boolean enabled)

isAutoDownload

public boolean isAutoDownload()

setAutoDownload

@Setting(value="statistics.geoloc.db_downloader")
public void setAutoDownload(String choice)

getDownloadFolderPath

public String getDownloadFolderPath()

setDownloadFolderPath

@Setting(value="statistics.geoloc.download_folder")
public void setDownloadFolderPath(String downloadFolderPath)

getCityDbLoc

public String getCityDbLoc()

setCityDbLoc

@Setting(value="statistics.geoloc.city_location")
public void setCityDbLoc(String cityDbLoc)

getCountryDbLoc

public String getCountryDbLoc()

setCountryDbLoc

@Setting(value="statistics.geoloc.country_location")
public void setCountryDbLoc(String countryDbLoc)

getDbType

public IAdminStatisticsLocation.LocationDatabaseType getDbType()

setDbType

@Setting(value="statistics.geoloc.db_type")
public void setDbType(String dbType)

init

public void init()

Specified by:

init in interface Constructable