eu.fthevenet.util.auth

Class CredentialsEntry

java.lang.Object

eu.fthevenet.util.auth.CredentialsEntry

public class CredentialsEntry
extends java.lang.Object

Defines an immutable set of credentials

Author:

Frederic Thevenet

Field Summary

Fields

Modifier and Type	Field and Description
static CredentialsEntry	CANCELLED A canceled credential set.
static CredentialsEntry	EMPTY An empty credential set.

Constructor Summary

Constructors

Constructor and Description
CredentialsEntry(java.lang.String login, char[] password) Initializes a new instance of the CredentialsEntry class

Method Summary

Modifier and Type	Method and Description
void	clearPassword() Overwrites the array backing the principle's password property.
static CredentialsEntry	copyOf(CredentialsEntry credentials) Creates a deep clone of the provided CredentialsEntry instance.
java.lang.String	getLogin() Returns the principle's login
char[]	getPwd() Returns the principle's password
boolean	isFilled() Returns true if the current set of credentials have been filled-in, false otherwise.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final CredentialsEntry EMPTY

An empty credential set.

This specific credential set should be used to intend that no credentials where explicitly provided

CANCELLED

public static final CredentialsEntry CANCELLED

A canceled credential set.

This specific credential set should be used to intend that the query for explicit credentials was initiated but canceled

Constructor Detail

CredentialsEntry

public CredentialsEntry(java.lang.String login,
                        char[] password)

Initializes a new instance of the CredentialsEntry class

Parameters:

login - the principle's login

password - the principle's password

Method Detail

copyOf

public static CredentialsEntry copyOf(CredentialsEntry credentials)

Creates a deep clone of the provided CredentialsEntry instance.

Parameters:

credentials - the CredentialsEntry instance to copy.

Returns:

a deep clone of the provided CredentialsEntry instance.

getPwd

public char[] getPwd()

Returns the principle's password

Returns:

the password

getLogin

public java.lang.String getLogin()

Returns the principle's login

Returns:

the principle's login

isFilled

public boolean isFilled()

Returns true if the current set of credentials have been filled-in, false otherwise.

Returns:

true if the current set of credentials have been filled-in, false otherwise.

clearPassword

public void clearPassword()

Overwrites the array backing the principle's password property.