com.github.vatbub.safeAPIKeyStore.client

Class APIKeyClient

java.lang.Object

com.github.vatbub.safeAPIKeyStore.client.APIKeyClient

public class APIKeyClient
extends Object

Communicates with an APIKey-server to retrieve api keys. Intended for static use.

Author:

Frederik Kammel

Method Summary

Modifier and Type	Method and Description
static String	getApiKey(String serverHost, int serverPort, String apiKeyName) Retrieves the specified api key from the specified server.
static String	getApiKey(String serverHost, int serverPort, String apiKeyName, int responseTimeoutInMilliSeconds) Retrieves the specified api key from the specified server.
static String	getApiKey(String serverHost, String apiKeyName) Retrieves the specified api key from the specified server.

Methods inherited from class java.lang.Object

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

Method Detail

getApiKey

public static String getApiKey(String serverHost,
                               String apiKeyName)
                        throws InternalServerException,
                               TimeoutException,
                               IOException

Retrieves the specified api key from the specified server. Assumes that the server runs on the default port (1650).

Parameters:

serverHost - The host address of the server.

apiKeyName - The name of the api key to retrieve

Returns:

The requested api key or null in case of unexpected errors.

Throws:

IOException - In case the connection with the server cannot be established or the received key cannot be decrypted.

TimeoutException - If the server takes more than 10 seconds time to respond.

InternalServerException - If something went wrong on the server side

getApiKey

public static String getApiKey(String serverHost,
                               int serverPort,
                               String apiKeyName)
                        throws TimeoutException,
                               InternalServerException,
                               IOException

Retrieves the specified api key from the specified server.

Parameters:

serverHost - The host address of the server.

serverPort - The port that the server is running on

apiKeyName - The name of the api key to retrieve

Returns:

The requested api key or null in case of unexpected errors.

Throws:

IOException - In case the connection with the server cannot be established or the received key cannot be decrypted.

TimeoutException - If the server takes more than 10 seconds time to respond.

InternalServerException - If something went wrong on the server side

getApiKey

public static String getApiKey(String serverHost,
                               int serverPort,
                               String apiKeyName,
                               int responseTimeoutInMilliSeconds)
                        throws IOException,
                               TimeoutException,
                               InternalServerException

Retrieves the specified api key from the specified server.

Parameters:

serverHost - The host address of the server.

serverPort - The port that the server is running on

apiKeyName - The name of the api key to retrieve

responseTimeoutInMilliSeconds - Time in milliseconds after which the request is aborted if no response was received from the server.

Returns:

The requested api key or null in case of unexpected errors.

Throws:

IOException - In case the connection with the server cannot be established or the received key cannot be decrypted.

TimeoutException - If the server takes more than the specified time to respond.

InternalServerException - If something went wrong on the server side