com.github.vatbub.safeAPIKeyStore.server

Class Server

java.lang.Object

com.github.vatbub.safeAPIKeyStore.server.Server

public class Server
extends Object

The API key server.

Constructor Summary

Constructors

Constructor and Description
Server(int port, File apiKeysFile) Launches a server on the specified port with the specified api keys.
Server(int port, String apiKeysFileName) Launches a server on the specified port with the specified api keys.

Method Summary

Modifier and Type	Method and Description
Object	createResponse(Object receivedObject) Called when the server receives an object.
Properties	getApiKeys() Returns the currently served api keys
void	readUsedPublicKeys() Causes the server to re-read the already used (and thus blocked) public RSA keys from disk.
void	readUsedPublicKeys(String filePath) Causes the server to re-read the already used (and thus blocked) public RSA keys from disk.
boolean	resetPermanently() Resets the list of used public RSA keys permanently by deleting the corresponding file on the drive.
boolean	resetPermanently(String pathToUsedKeysFile) Resets the list of used public RSA keys permanently by deleting the corresponding file on the drive.
void	resetTemporarily() Resets the list of public RSA keys temporarily (until the server is rebooted)
void	saveUsedPublicKeys() Saves the list of used (and thus blocked) public RSA keys to the default location (<appDataPath>/com.github.vatbub.safeAPIKeyStore.server/usedPublicKeys)
void	saveUsedPublicKeys(String filePath) Saves the list of used (and thus blocked) public RSA keys to the specified location
void	stop() Shuts the server down.

Methods inherited from class java.lang.Object

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

Constructor Detail

Server

public Server(int port,
              String apiKeysFileName)
       throws IOException

Launches a server on the specified port with the specified api keys.

Parameters:

port - The port to run the server on

apiKeysFileName - The absolute or relative file path to the properties-file that contains the api keys to serve

Throws:

IOException - If the server fails to launch for any reason.

Server

public Server(int port,
              File apiKeysFile)
       throws IOException

Launches a server on the specified port with the specified api keys.

Parameters:

port - The port to run the server on

apiKeysFile - The properties-file that contains the api keys to serve

Throws:

IOException - If the server fails to launch for any reason.

Method Detail

getApiKeys

public Properties getApiKeys()

Returns the currently served api keys

Returns:

The currently served api keys

createResponse

public Object createResponse(Object receivedObject)

Called when the server receives an object. Override this method if you wish to modify the server's default response.

Parameters:

receivedObject - The object received by the server

Returns:

The object to send as a response. Set this to null to send no response at all

readUsedPublicKeys

public void readUsedPublicKeys()

Causes the server to re-read the already used (and thus blocked) public RSA keys from disk. Reads the list from the default location (<appDataPath>/com.github.vatbub.safeAPIKeyStore.server/usedPublicKeys)

readUsedPublicKeys

public void readUsedPublicKeys(String filePath)

Causes the server to re-read the already used (and thus blocked) public RSA keys from disk.

Parameters:

filePath - The absolute or relative path to the file to read the used keys list from

saveUsedPublicKeys

public void saveUsedPublicKeys()
                        throws FileNotFoundException

Saves the list of used (and thus blocked) public RSA keys to the default location (<appDataPath>/com.github.vatbub.safeAPIKeyStore.server/usedPublicKeys)

Throws:

FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

saveUsedPublicKeys

public void saveUsedPublicKeys(String filePath)
                        throws FileNotFoundException

Saves the list of used (and thus blocked) public RSA keys to the specified location

Parameters:

filePath - The absolute or relative path to the file to save the list in

Throws:

FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

resetPermanently

public boolean resetPermanently()

Resets the list of used public RSA keys permanently by deleting the corresponding file on the drive. If the file cannot be deleted for any reason, a temporary reset is performed (server will be reset until rebooted) This method assumes that the list was saved on the default location (<appDataPath>/com.github.vatbub.safeAPIKeyStore.server/usedPublicKeys).

Returns:

true if the server was reset permanently, false if only temporarily

See Also:

resetTemporarily()

resetPermanently

public boolean resetPermanently(String pathToUsedKeysFile)

Resets the list of used public RSA keys permanently by deleting the corresponding file on the drive. If the file cannot be deleted for any reason, a temporary reset is performed (server will be reset until rebooted)

Parameters:

pathToUsedKeysFile - The absolute or relative path to the file that contains the list of used public RSA keys

Returns:

true if the server was reset permanently, false if only temporarily

See Also:

resetTemporarily()

resetTemporarily

public void resetTemporarily()

Resets the list of public RSA keys temporarily (until the server is rebooted)

stop

public void stop()

Shuts the server down.