org.apereo.cas.authentication

Class UsernamePasswordCredential

java.lang.Object

org.apereo.cas.authentication.UsernamePasswordCredential

All Implemented Interfaces:

java.io.Serializable, Credential

Direct Known Subclasses:

RememberMeUsernamePasswordCredential

public class UsernamePasswordCredential
extends java.lang.Object
implements Credential, java.io.Serializable

Credential for authenticating with a username and password.

Since:

3.0.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHENTICATION_ATTRIBUTE_PASSWORD Authentication attribute name for password.

Fields inherited from interface org.apereo.cas.authentication.Credential

CREDENTIAL_TYPE_ATTRIBUTE, UNKNOWN_ID

Constructor Summary

Constructors

Constructor and Description
UsernamePasswordCredential() Default constructor.
UsernamePasswordCredential(java.lang.String userName, java.lang.String password) Creates a new instance with the given username and password.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getId() Gets a credential identifier that is safe to record for logging, auditing, or presentation to the user.
java.lang.String	getPassword()
java.lang.String	getUsername()
int	hashCode()
void	setPassword(java.lang.String password)
void	setUsername(java.lang.String userName)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

AUTHENTICATION_ATTRIBUTE_PASSWORD

public static final java.lang.String AUTHENTICATION_ATTRIBUTE_PASSWORD

Authentication attribute name for password.

See Also:

Constant Field Values

Constructor Detail

UsernamePasswordCredential

public UsernamePasswordCredential()

Default constructor.

UsernamePasswordCredential

public UsernamePasswordCredential(java.lang.String userName,
                                  java.lang.String password)

Creates a new instance with the given username and password.

Parameters:

userName - Non-null user name.

password - Non-null password.

Method Detail

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String userName)

getId

public java.lang.String getId()

Description copied from interface: Credential

Gets a credential identifier that is safe to record for logging, auditing, or presentation to the user. In most cases this has a natural meaning for most credential types (e.g. username, certificate DN), while for others it may be awkward to construct a meaningful identifier. In any case credentials require some means of identification for a number of cases and implementers should make a best effor to satisfy that need.

Specified by:

getId in interface Credential

Returns:

Non-null credential identifier. Implementers should return Credential.UNKNOWN_ID for cases where an ID is not readily available or meaningful.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object