Package org.apache.archiva.redback.authentication

Interface AuthenticationManager

All Known Implementing Classes:

DefaultAuthenticationManager

public interface AuthenticationManager

AuthenticationManager:

Author:

Jesse McConnell, Martin Stockhammer

Method Summary

Modifier and Type	Method	Description
AuthenticationResult	authenticate(AuthenticationDataSource source)	Authenticates by calling all authenticators in the defined order.
List<Authenticator>	getAuthenticators()	Returns the list of authenticators in the same order as they are called for authentication
List<AuthenticatorControl>	getControls()	Returns the authenticator controls that are used to control the order and actions during authentication.
String	getId()	Returns the identifier of this authentication manager
void	modifyControl(AuthenticatorControl control)	Modifies the control for a single authenticator
void	setControls(List<AuthenticatorControl> controlList)	Sets the list of authenticator controls

Method Detail

getId

String getId()

Returns the identifier of this authentication manager

Returns:

the identifier string

getAuthenticators

List<Authenticator> getAuthenticators()

Returns the list of authenticators in the same order as they are called for authentication

Returns:

the list of authenticators.

authenticate

AuthenticationResult authenticate(AuthenticationDataSource source)
                           throws AccountLockedException,
                                  AuthenticationException,
                                  MustChangePasswordException

Authenticates by calling all authenticators in the defined order.

Parameters:

source - the authentication data

Returns:

the result that gives information, if the authentication was successful

Throws:

AccountLockedException - if the account is locked

AuthenticationException - if something unexpected happend during authentication

MustChangePasswordException - if the user has to change his password

getControls

List<AuthenticatorControl> getControls()

Returns the authenticator controls that are used to control the order and actions during authentication.

Returns:

the list of controls

setControls

void setControls(List<AuthenticatorControl> controlList)

Sets the list of authenticator controls

Parameters:

controlList - the list of control instances

modifyControl

void modifyControl(AuthenticatorControl control)

Modifies the control for a single authenticator

Parameters:

control - the authenticator control