ml.alternet.security.auth

Class Credentials

java.lang.Object

ml.alternet.security.auth.Credentials

All Implemented Interfaces:

Destroyable

public class Credentials
extends Object
implements Destroyable

User credentials are the more often just a password, but this class can also build credentials with common fields such as a user name, a realm (or domain), or any custom field. Each field is unique in this class.

Author:

Philippe Poulard

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Credentials.Checker Check some credentials with a given crypt.

Constructor Summary

Constructors

Constructor and Description
Credentials()

Method Summary

Modifier and Type	Method and Description
void	destroy() Invalidate these credentials ; act only on the password field.
static Credentials	fromPassword(char[] password) Create the credentials from a password.
static Credentials	fromPassword(Password password) Create the credentials from a password.
static Credentials	fromUserPassword(String username, char[] password) Create the credentials from a user and a password.
static Credentials	fromUserPassword(String username, Password password) Create the credentials from a user and a password.
<T> T	get(String field) Return a field value.
Password	getPassword() Return the password.
String	getRealm() Return the realm.
String	getUserName() Return the user name.
boolean	isDestroyed()
Credentials	withField(String field, Object data) Append a custom field to this credentials.
Credentials	withPassword(char[] password) Append a password field to this credentials.
Credentials	withPassword(Password password) Append a password field to this credentials.
Credentials	withRealm(String realm) Append a realm field to this credentials.
Credentials	withUser(String username) Append a user name field to this credentials.

Methods inherited from class java.lang.Object

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

Constructor Detail

Credentials

public Credentials()

Method Detail

fromPassword

public static Credentials fromPassword(Password password)

Create the credentials from a password.

Parameters:

password - The password.

Returns:

The credentials.

fromPassword

public static Credentials fromPassword(char[] password)

Create the credentials from a password.

Parameters:

password - The password.

Returns:

The credentials.

fromUserPassword

public static Credentials fromUserPassword(String username,
                                           Password password)

Create the credentials from a user and a password.

Parameters:

username - The user name.

password - The password.

Returns:

The credentials.

fromUserPassword

public static Credentials fromUserPassword(String username,
                                           char[] password)

Create the credentials from a user and a password.

Parameters:

username - The user name.

password - The password.

Returns:

The credentials.

withUser

public Credentials withUser(String username)

Append a user name field to this credentials.

Parameters:

username - The user name.

Returns:

The modified credentials.

withPassword

public Credentials withPassword(Password password)

Append a password field to this credentials.

Parameters:

password - The password.

Returns:

The modified credentials.

withPassword

public Credentials withPassword(char[] password)

Append a password field to this credentials.

Parameters:

password - The password.

Returns:

The modified credentials.

See Also:

PasswordManagerFactory.getStrongPasswordManager()

withRealm

public Credentials withRealm(String realm)

Append a realm field to this credentials.

Parameters:

realm - The realm.

Returns:

The modified credentials.

withField

public Credentials withField(String field,
                             Object data)

Append a custom field to this credentials.

Parameters:

field - The field name.

data - The field value.

Returns:

The modified credentials.

getUserName

public String getUserName()

Return the user name.

Returns:

The user name, or null

getPassword

public Password getPassword()

Return the password.

Returns:

The password, or null

getRealm

public String getRealm()

Return the realm.

Returns:

The realm, or null

get

public <T> T get(String field)

Return a field value.

Type Parameters:

T - The type of the field.

Parameters:

field - The field name.

Returns:

The field value, or null.

destroy

public void destroy()

Invalidate these credentials ; act only on the password field.

Specified by:

destroy in interface Destroyable

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable