main.java.com.djrapitops.plan.systems.cache

Class GeolocationCache

java.lang.Object

main.java.com.djrapitops.plan.systems.cache.GeolocationCache

public class GeolocationCache
extends Object

This class contains the geolocation cache.

It caches all IPs with their matching country.

This cache uses the Google Guava Cache.

Since:

3.5.5

Author:

Fuzzlemann

Method Summary

Modifier and Type	Method and Description
static void	checkDB() Checks if the DB exists, if not, it downloads it
static void	clearCache() Clears the cache
static String	getCountry(String ipAddress) Retrieves the country in full length (e.g.
static boolean	isCached(String ipAddress) Checks if the IP Address is cached

Methods inherited from class java.lang.Object

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

Method Detail

getCountry

public static String getCountry(String ipAddress)

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

This method uses the geolocationCache, 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)

checkDB

public static void checkDB()
                    throws IOException

Checks if the DB exists, if not, it downloads it

Throws:

IOException - when an error at download or saving the DB happens

isCached

public static boolean isCached(String ipAddress)

Checks if the IP Address is cached

Parameters:

ipAddress - The IP Address which is checked

Returns:

true if the IP Address is cached

clearCache

public static void clearCache()

Clears the cache