LoginModule (GNU Classpath 0.94-pre Documentation)

The base interface for login methods in the Java Authentication and Authorization Service (JAAS).

This interface is used by service providers that implement login services, and is used internally by the JAAS system. It is not useful to application programmers, who should use the {@link javax.security.auth.login.LoginContext} instead.

Method Summary
boolean	abort() Abort the current login attempt.
boolean	commit() Commit the current login attempt.
void	initialize(Subject subject, CallbackHandler handler, Map<String,?> sharedState, Map<String,?> options) Initializes this login module.
boolean	login() Authenticates a subject to the system.
boolean	logout() Logs a subject out.

Method Detail

abort

Abort the current login attempt. This is called after {@link #login()} if the overall login attempt fails (that is, if one of the other login modules that is REQUIRED or REQUISITE fails). This method should clean up this module's saved state, if any.

Returns: True if the abort succeeded, or false if this module should be ignored.

Throws: LoginException If the abort fails.

commit

Commit the current login attempt. This is called after {@link #login()} if the overall login attempt succeeds (that is, all methods have satisfied all REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL module requirements).

Returns: True if the commit succeeded, or false if this module should be ignored.

Throws: LoginException If the commit fails.

initialize

public void initialize(Subject subject, CallbackHandler handler, Map<String,?> sharedState, Map<String,?> options)

Initializes this login module. This method is called when the instance implementing this interface is instantiated, and should perform any initialization based on the given parameters. Implementations should ignore state variables and options they do not recognize.

Parameters: subject The subject being authenticated. handler The callback handler for user input. sharedState A mapping that is shared between all login modules. options A mapping of options given to this module.

Authenticates a subject to the system. This is the primary mechanism by which subjects are authenticated, and typically implementations will ask for credentials (for example, a user name and password) which will then be verified.

Returns: True if the subject was authenticated, or false if this module should be ignored.

Throws: LoginException If this method fails.

logout

Logs a subject out. This is primarily used for modules that must destroy or remove the authentication state associated with a logged-in subject.

Returns: True if the logout succeeds, or false if this module should be ignored.