net.sf.basedb.core.authentication

Interface AuthenticationManager

All Superinterfaces:

Action

All Known Implementing Classes:

OldAuthenticationWrapperFactory.OldAuthenticationManager

public interface AuthenticationManager
extends Action

Action interface for external authentication. Action factories are called with a AuthenticationContext object as the InvokationContext.getClientContext(). Use AuthenticationContext.getLoginRequest() to get information about the login and password used for logging in.

Since:

3.3

Author:

Nicklas

Method Summary

Modifier and Type	Method and Description
AuthenticatedUser	authenticate() Try to authenticate a user given the login information passed to the factory in the AuthenticationContext.

Method Detail

authenticate

AuthenticatedUser authenticate()

Try to authenticate a user given the login information passed to the factory in the AuthenticationContext. There are three outcomes from this method:

• The login request was valid: An AuthenticationInformation object should be returned with at least the external id of the user.
• The login request was invalid: An AuthenticationException (or a subclass) should be thrown
• It was not possible to know if the request was invalid or not: null should be returned to let the authentication continue with another action or internal authentication.

Returns:

An AuthenticationInformation object if the user was authenticated, null if this action doesn't know if the login is valid or not

Throws:

AuthenticationException - If the user was not authenticated