org.picketlink.authentication

Class BaseAuthenticator

java.lang.Object

org.picketlink.authentication.BaseAuthenticator

All Implemented Interfaces:

Authenticator

Direct Known Subclasses:

IdmAuthenticator

public abstract class BaseAuthenticator
extends Object
implements Authenticator

Abstract base class that Authenticator implementations can extend for convenience.

Author:

Shane Bryzak

Nested Class Summary

Nested classes/interfaces inherited from interface org.picketlink.authentication.Authenticator

Authenticator.AuthenticationStatus

Constructor Summary

Constructors

Constructor and Description
BaseAuthenticator()

Method Summary

Methods

Modifier and Type	Method and Description
Account	getAccount() Returns a Account if a successful authentication was made.
Authenticator.AuthenticationStatus	getStatus() Returns the current status of the authentication attempt.
void	postAuthenticate() Post-authentication logic.
protected void	setAccount(Account account)
protected void	setStatus(Authenticator.AuthenticationStatus status)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.picketlink.authentication.Authenticator

authenticate

Constructor Detail

BaseAuthenticator

public BaseAuthenticator()

Method Detail

getStatus

public Authenticator.AuthenticationStatus getStatus()

Description copied from interface: Authenticator

Returns the current status of the authentication attempt.

Specified by:

getStatus in interface Authenticator

Returns:

setStatus

protected void setStatus(Authenticator.AuthenticationStatus status)

setAccount

protected void setAccount(Account account)

getAccount

public Account getAccount()

Description copied from interface: Authenticator

Returns a Account if a successful authentication was made. Otherwise it should return null.

Specified by:

getAccount in interface Authenticator

Returns:

postAuthenticate

public void postAuthenticate()

Description copied from interface: Authenticator

Post-authentication logic. This method is always invoked after an authentication attempt.

Specified by:

postAuthenticate in interface Authenticator