org.picketlink.idm.credential

Interface Credentials

All Known Implementing Classes:

AbstractBaseCredentials, DigestCredentials, TOTPCredentials, UsernamePasswordCredentials, X509CertificateCredentials

public interface Credentials

Represents the credentials the current user will use to authenticate, in addition to providing information about the current state of the validation process. Only used during the authentication process

Author:

Shane Bryzak

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Credentials.Status

Method Summary

Methods

Modifier and Type	Method and Description
Credentials.Status	getStatus() Returns the validation status.
Account	getValidatedAccount() Returns the Account instance used to validate the credential.
void	invalidate() Invalidates the credential.

Method Detail

getValidatedAccount

Account getValidatedAccount()

Returns the Account instance used to validate the credential.

Returns:

getStatus

Credentials.Status getStatus()

Returns the validation status.

Returns:

invalidate

void invalidate()

Invalidates the credential.