Class RegionLocationService

Method Details

• setGlobalCacheSize

  public static void setGlobalCacheSize(int size)

  Sets the maximum global cache size.

  Parameters:

  size - The size: must be larger than 100.

  Throws:

  IllegalArgumentException - If size is smaller than 100.

  IllegalStateException - If not called from the server.

• initialize

  public static void initialize(RegionLocationService service)

  Initializes the region location detection service with the service provider. This code is called from the server.

  Parameters:

  service - The RegionLocationDetectionService instance.

  Throws:

  NullPointerException - If the service is null.

  IllegalStateException - If RegionLocationService's service name is already initialized.

• shutdown

  public static void shutdown()

  Called when the server is shutting down and disposes all service providers.

  Throws:

  IllegalStateException - If this method is not called from the server.

• getNames

  public static String[] getNames()

  Gets the available names for the region location providers.

  Returns:

  The names.

• getDefaultName

  public static String getDefaultName()

  Gets the default region location provider name.

  Returns:

  The name, or null if no providers are initialized.

• getInstance

  public static RegionLocationService getInstance(String name)

  Gets an instance of a RegionLocationDetectionService.

  Parameters:

  name - The name of the RegionLocationDetectionService, null for default.

  Throws:

  IllegalArgumentException - If the name is invalid.

  IllegalStateException - If the service is not initiated with correct settings (such as keys, etc).

• configure

  public final void configure(int localCacheSize, boolean useGlobalCache, boolean doSaveToGlobalCache)

  Configures the service provider.

  Parameters:

  localCacheSize - Local cache size, zero for none.

  useGlobalCache - Flag to enable usage of global cache prior to asking the service provider.

  doSaveToGlobalCache - Flag to save requests answered by the service provider to the global cache.

  Throws:

  IllegalStateException - If provider is already configured.

• isAvailable

  protected boolean isAvailable()

  Returns if the service provider is available to use.

  Subclasses override this method to return another value than true.

  Returns:

  true for OK to use, false if not properly configured.

• getName

  public final String getName()

  Gets the name of the region location service.

  Returns:

  The name.

• createRegionLocation

  public final HostNameRegionLocation createRegionLocation(InetAddress address)

  Requests the region location from an IP address (version 4 or 6).

  Parameters:

  address - The IPv4/IPv6 address.

  Throws:

  NullPointerException - If address is null.

• createRegionLocation

  public final HostNameRegionLocation createRegionLocation(String host) throws UnknownHostException

  Requests the region location from a host name or IP address (version 4 or 6).

  Parameters:

  host - The host name or IPv4/IPv6 address.

  Throws:

  NullPointerException - If hostName is null.

  UnknownHostException - If hostName InetAddress cannot be determined.

• createRegionLocation

  public final HostNameRegionLocation createRegionLocation(HostNameOrAddress host)

  Requests a region location for a host name or IP address (version 4 or 6).

  Parameters:

  host - The host name or IPv4/IPv6 address.

  Throws:

  NullPointerException - If host is null.

• parse

  protected final JSONObject parse(URLConnection uc) throws IOException

  Process a HTTP[S] URL connection and return a JSONObject.

  Parameters:

  uc - The URLConnection, should be Http(s)UrlConnection.

  Returns:

  A JSONObject.

  Throws:

  IOException - For failures.

• isDisposed

  public boolean isDisposed()

  Checks if the service provider is disposed of.

  Returns:

  true if service provider is disposed of, false otherwise.

• request

  protected abstract RegionLocation request(String ipAddress) throws IOException, InterruptedIOException, InterruptedException

  Requests region location information from the service provider. When the request has completed with or without error, call

  Parameters:

  ipAddress - The IP address request.

  Returns:

  The region location information, must always be non-null.

  Throws:

  IOException - For I/O errors.

  InterruptedIOException - If an I/O operation is interrupted.

  InterruptedException - If thread is interrupted.

• onDisposed

  protected void onDisposed()

  Disposes of the region service provider. This is done by the server when it is shutting down. Any pending requests that are not yet processed are canceled by the framework.

  Subclasses override this method to perform some kind of custom clean-up such as e.g. closing a database.