com.softwareag.mobile.md.io

Class CredentialStore

java.lang.Object

com.softwareag.mobile.md.io.CredentialStore

All Implemented Interfaces:

ICredentialStorage

public class CredentialStore
extends java.lang.Object
implements ICredentialStorage

A class for storing credentials. The native implementation backing this class will vary depending on platform; it may be a dedicated "keychain" system managed by the OS, or a simple isolated storage file. It is advisable therefore to check the documentation thoroughly in order to verify that the native implementation underneath conforms to the use-case.
Important: In order to prevent data loss, only one copy of this Object should be created at any one time, and all Thread safety must be managed by the calling code.

Constructor Summary

Constructors

Constructor and Description
CredentialStore()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteCredentials(java.lang.String server) Delete a set of credentials for a server.
Credentials	getCredentialsForServer(java.lang.String server) Get the Credentials object set for this server.
static boolean	isStoreSupported() Determine if this class is supported with this combination of device, platform and OS version.
boolean	setCredentials(Credentials creds, java.lang.String server) Set the credentials for a given server.

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialStore

public CredentialStore()

Method Detail

isStoreSupported

public static boolean isStoreSupported()

Determine if this class is supported with this combination of device, platform and OS version.

Returns:

true if the class is supported, false otherwise.

setCredentials

public boolean setCredentials(Credentials creds,
                     java.lang.String server)

Set the credentials for a given server. Note that only one set of credentials can be stored per server String.

Specified by:

setCredentials in interface ICredentialStorage

Parameters:

creds - The Credentials obejct containing the login details.

server - The String representing the server that the credentials apply for.

Returns:

true if the Credentials have been set successfully.

Throws:

java.lang.NullPointerException - if server or creds are null.

deleteCredentials

public boolean deleteCredentials(java.lang.String server)

Delete a set of credentials for a server.

Specified by:

deleteCredentials in interface ICredentialStorage

Parameters:

server - The String representing the server that these Credentials were stored for.

Returns:

true if the delete was successful.

Throws:

java.lang.NullPointerException - if server is null.

getCredentialsForServer

public Credentials getCredentialsForServer(java.lang.String server)

Get the Credentials object set for this server.

Specified by:

getCredentialsForServer in interface ICredentialStorage

Parameters:

server - the String representing the server that the credentials have been saved for.

Returns:

a Credentials object with a username and password, or null if no data exists.

Throws:

java.lang.NullPointerException - if server is null.