org.jasig.cas.authentication

Class UsernamePasswordCredential

java.lang.Object

org.jasig.cas.authentication.UsernamePasswordCredential

All Implemented Interfaces:

Serializable, Credential

Direct Known Subclasses:

RememberMeUsernamePasswordCredential

public class UsernamePasswordCredential
extends Object
implements Credential, Serializable

Credential for authenticating with a username and password.

Since:

3.0

Author:

Scott Battaglia, Marvin S. Addison

See Also:

Serialized Form

Field Summary

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

UNKNOWN_ID

Constructor Summary

Constructors

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

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UsernamePasswordCredential

public UsernamePasswordCredential()

Default constructor.

UsernamePasswordCredential

public UsernamePasswordCredential(String userName,
                          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 final String getPassword()

Returns:

Returns the password.

setPassword

public final void setPassword(String password)

Parameters:

password - The password to set.

getUsername

public final String getUsername()

Returns:

Returns the userName.

setUsername

public final void setUsername(String userName)

Parameters:

userName - The userName to set.

getId

public String getId()

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 String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object