com.djrapitops.plan.system.cache

Class GeolocationCache

java.lang.Object

com.djrapitops.plan.system.cache.GeolocationCache

All Implemented Interfaces:

SubSystem

@Singleton
public class GeolocationCache
extends java.lang.Object
implements SubSystem

This class contains the geolocation cache.

It caches all IPs with their matching country.

Constructor Summary

Constructors

Constructor and Description
GeolocationCache(Locale locale, PlanFiles files, PlanConfig config, com.djrapitops.plugin.logging.console.PluginLogger logger)

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clears the cache
void	disable() Performs disable actions for the subsystem
void	enable() Performs enable actions for the subsystem.
java.lang.String	getCountry(java.lang.String ipAddress) Retrieves the country in full length (e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeolocationCache

@Inject
public GeolocationCache(Locale locale,
                                PlanFiles files,
                                PlanConfig config,
                                com.djrapitops.plugin.logging.console.PluginLogger logger)

Method Detail

enable

public void enable()
            throws EnableException

Description copied from interface: SubSystem

Performs enable actions for the subsystem.

Specified by:

enable in interface SubSystem

Throws:

EnableException - If an error occurred during enable and it is fatal to the subsystem.

getCountry

public java.lang.String getCountry(java.lang.String ipAddress)

Retrieves the country in full length (e.g. United States) from the IP Address.

This method uses cached, every first access is getting cached and then retrieved later.

Parameters:

ipAddress - The IP Address from which the country is retrieved

Returns:

The name of the country in full length.

An exception from that rule is when the country is unknown or the retrieval of the country failed in any way, if that happens, "Not Known" will be returned.

See Also:

getUnCachedCountry(String)

disable

public void disable()

Description copied from interface: SubSystem

Performs disable actions for the subsystem

Specified by:

disable in interface SubSystem

clearCache

public void clearCache()

Clears the cache