Package wt.auth
Interface AuthenticationHandler
- All Known Implementing Classes:
HTTPAuthentication,NullAuthentication
public interface AuthenticationHandler
Authentication handler interface.
This interface defines the interaction between the
Supported API: true
Authentication class and
classes which handle different client authentication shemes.
Supported API: true
-
Method Summary
Modifier and TypeMethodDescriptionbootstrap(MethodAuthenticator authenticator) Initialization method called from bootstrapping authenticator's init method.Get a bootstrapMethodAuthenticatorcapable of identifying the user.getBootstrapAuthenticator(String session_id) Get a bootstrapMethodAuthenticatorcapable of identifying the user for the given session.
-
Method Details
-
getBootstrapAuthenticator
MethodAuthenticator getBootstrapAuthenticator()Get a bootstrapMethodAuthenticatorcapable of identifying the user.
Supported API: true- Returns:
MethodAuthenticatorobject
-
getBootstrapAuthenticator
Get a bootstrapMethodAuthenticatorcapable of identifying the user for the given session.
Supported API: true- Parameters:
session_id- a string identifying the current session- Returns:
MethodAuthenticatorobject
-
bootstrap
Initialization method called from bootstrapping authenticator's init method. It can be used to convert bootstrapping authenticator into a real one or to send back another bootstrapping authenticator if the current one failed and there are other login mechanisms available. Should return null if the authenicator is not an instance used by this handler implementation.
Supported API: true- Parameters:
authenticator- theMethodAuthenticatorbeing initialized- Returns:
- replacement
MethodAuthenticatoror null if not our authenticator. - Throws:
AuthenticationException- if authentication failed
-