org.jasig.cas.authentication

Class OneTimePasswordCredential

java.lang.Object

org.jasig.cas.authentication.AbstractCredential

org.jasig.cas.authentication.OneTimePasswordCredential

All Implemented Interfaces:

Serializable, Credential, CredentialMetaData

public class OneTimePasswordCredential
extends AbstractCredential

Describes a one-time-password credential that contains an optional unique identifier and required password. The primary difference between this component and UsernamePasswordCredential is that the username/ID is optional in the former and requisite in the latter.

This class implements CredentialMetaData since the one-time-password is safe for long-term storage after authentication. Note that metadata is stored only _after_ authentication, at which time the OTP has already been consumed and by definition is no longer useful for authentication.

Since:

4.0

Author:

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
OneTimePasswordCredential(String password) Creates a one-time-password with just a password.
OneTimePasswordCredential(String id, String password) Creates a one-time-password with unique ID and password.

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Gets the unique ID commonly used to look up a one-time password in a system of record.
String	getPassword() Gets the cleartext one-time password value.

Methods inherited from class org.jasig.cas.authentication.AbstractCredential

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

OneTimePasswordCredential

public OneTimePasswordCredential(String password)

Creates a one-time-password with just a password.

Parameters:

password - Non-null cleartext one-time password value.

OneTimePasswordCredential

public OneTimePasswordCredential(String id,
                         String password)

Creates a one-time-password with unique ID and password.

Parameters:

id - Identifier that is commonly used to look up one-time password in system of record.

password - Non-null cleartext one-time password value.

Method Detail

getPassword

public String getPassword()

Gets the cleartext one-time password value.

Returns:

Non-null one-time password.

getId

public String getId()

Gets the unique ID commonly used to look up a one-time password in a system of record.

Returns:

Possibly null unique ID.