org.openbase.bco.authentication.lib

Class CredentialStore

java.lang.Object

org.openbase.bco.authentication.lib.CredentialStore

Direct Known Subclasses:

MockClientStore, MockCredentialStore

public class CredentialStore
extends Object

This class provides access to the storage of login credentials.

Author:

Constantin Romankiewicz

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<String,rst.domotic.authentication.LoginCredentialsType.LoginCredentials>	credentials
static String	SERVICE_SERVER_ID

Constructor Summary

Constructors

Constructor and Description
CredentialStore(String filename)

Method Summary

Modifier and Type	Method and Description
void	addCredentials(String id, byte[] credentials, boolean admin) Adds new credentials to the credentialStore.
byte[]	getCredentials(String userId) Get the encrypted login credentials for a given user.
AbstractMap.SimpleEntry<String,rst.domotic.authentication.LoginCredentialsType.LoginCredentials>	getFirstEntry() Get an entry by the specified index.
boolean	hasEntry(String id) Determines if there is an entry with given id.
boolean	hasOnlyServiceServer() Return whether the internal map only holds one entry for the service server.
void	init()
boolean	isAdmin(String userId) Tells whether a given user has administrator permissions.
boolean	isEmpty() Return whether the internal map is empty.
void	removeEntry(String id) Removes entry from credentialStore given id.
protected void	saveStore() Stores the credentials in a protobuf JSON file.
void	setAdmin(String userId, boolean isAdmin) Changes the admin flag of an entry.
void	setCredentials(String userId, byte[] credentials) Sets the login credentials for a given user.
void	shutdown()

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_SERVER_ID

public static final String SERVICE_SERVER_ID

See Also:

Constant Field Values

credentials

protected HashMap<String,rst.domotic.authentication.LoginCredentialsType.LoginCredentials> credentials

Constructor Detail

CredentialStore

public CredentialStore(String filename)

Method Detail

init

public void init()
          throws org.openbase.jul.exception.InitializationException

Throws:

org.openbase.jul.exception.InitializationException

saveStore

protected void saveStore()

Stores the credentials in a protobuf JSON file.

isEmpty

public boolean isEmpty()

Return whether the internal map is empty.

Returns:

true if no client/user is registered

hasOnlyServiceServer

public boolean hasOnlyServiceServer()

Return whether the internal map only holds one entry for the service server.

Returns:

true if no client/user is registered except the service server.

hasEntry

public boolean hasEntry(String id)

Determines if there is an entry with given id.

Parameters:

id - the id to check

Returns:

true if existent, false otherwise

getFirstEntry

public AbstractMap.SimpleEntry<String,rst.domotic.authentication.LoginCredentialsType.LoginCredentials> getFirstEntry()

Get an entry by the specified index. Usage only makes sense when there is only one entry in the credentialStore. Else an arbitrary entry would be returned.

Returns:

Returns null if the index would result in a NullPointerException.

removeEntry

public void removeEntry(String id)

Removes entry from credentialStore given id.

Parameters:

id - the credentials to remove

getCredentials

public byte[] getCredentials(String userId)
                      throws org.openbase.jul.exception.NotAvailableException

Get the encrypted login credentials for a given user.

Parameters:

userId - ID of the user whose credentials should be retrieved.

Returns:

The encrypted credentials, if they could be found.

Throws:

org.openbase.jul.exception.NotAvailableException - If the user does not exist in the credentials storage.

setCredentials

public void setCredentials(String userId,
                           byte[] credentials)

Sets the login credentials for a given user. If there is already an entry in the storage for this user, it will be replaced. Otherwise, a new entry will be created.

Parameters:

userId - ID of the user to modify.

credentials - New encrypted credentials.

addCredentials

public void addCredentials(String id,
                           byte[] credentials,
                           boolean admin)

Adds new credentials to the credentialStore.

Parameters:

id - id of client or user

credentials - password, public or private key

admin - admin flag

isAdmin

public boolean isAdmin(String userId)
                throws org.openbase.jul.exception.NotAvailableException

Tells whether a given user has administrator permissions.

Parameters:

userId - ID of the user whose credentials should be retrieved.

Returns:

Boolean value indicating whether the user has administrator permissions.

Throws:

org.openbase.jul.exception.NotAvailableException - If the user does not exist in the credentials storage.

setAdmin

public void setAdmin(String userId,
                     boolean isAdmin)
              throws org.openbase.jul.exception.NotAvailableException

Changes the admin flag of an entry.

Parameters:

userId - user to change flag of

isAdmin - boolean whether user is admin or not

Throws:

org.openbase.jul.exception.NotAvailableException - Throws if there is no user given userId

shutdown

public void shutdown()