org.objectweb.jonas.security.auth.spi.ClientLoginModule Class Reference

List of all members.

Public Member Functions
void	initialize (Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)
boolean	login () throws LoginException
boolean	commit () throws LoginException
boolean	abort () throws LoginException
boolean	logout () throws LoginException

---

Detailed Description

This class is used to propagate the Principal and roles to the server It doesn't make any authentication

Author:

Florent Benoit

Definition at line 51 of file ClientLoginModule.java.

---

Member Function Documentation

boolean org.objectweb.jonas.security.auth.spi.ClientLoginModule.abort (   )  throws LoginException

Method to abort the authentication process (phase 2). This method is called if the LoginContext's overall authentication failed. (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules did not succeed). If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login method), then this method cleans up any state that was originally saved. Returns: true if this method succeeded, or false if this LoginModule should be ignored. Exceptions: LoginException  if the abort fails Definition at line 177 of file ClientLoginModule.java.

boolean org.objectweb.jonas.security.auth.spi.ClientLoginModule.commit (   )  throws LoginException

Method to commit the authentication process (phase 2). This method is called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded). If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login method), then this method associates relevant Principals and Credentials with the Subject located in the LoginModule. If this LoginModule's own authentication attempted failed, then this method removes/destroys any state that was originally saved. Returns: true if this method succeeded, or false if this LoginModule should be ignored. Exceptions: LoginException  if the commit fails Definition at line 128 of file ClientLoginModule.java. References org.objectweb.security.context.SecurityCurrent.setGlobalSecurityContext(), and org.objectweb.security.context.SecurityCurrent.setSecurityContext().

Here is the call graph for this function:

void org.objectweb.jonas.security.auth.spi.ClientLoginModule.initialize (  Subject  subject, CallbackHandler  callbackHandler, Map  sharedState, Map  options )

Initialize this LoginModule. This method is called by the LoginContext after this LoginModule has been instantiated. The purpose of this method is to initialize this LoginModule with the relevant information. If this LoginModule does not understand any of the data stored in sharedState or options parameters, they can be ignored. Parameters: subject  the Subject to be authenticated. callbackHandler  a CallbackHandler for communicating with the end user (prompting for usernames and passwords, for example). sharedState  state shared with other configured LoginModules. options  options specified in the login Configuration for this particular LoginModule. Definition at line 96 of file ClientLoginModule.java.

boolean org.objectweb.jonas.security.auth.spi.ClientLoginModule.login (   )  throws LoginException

Method to authenticate a Subject (phase 1). The implementation of this method authenticates a Subject. For example, it may prompt for Subject information such as a username and password and then attempt to verify the password. This method saves the result of the authentication attempt as private state within the LoginModule. Returns: true if the authentication succeeded, or false if this LoginModule should be ignored. Exceptions: LoginException  if the authentication fails Definition at line 111 of file ClientLoginModule.java.

boolean org.objectweb.jonas.security.auth.spi.ClientLoginModule.logout (   )  throws LoginException

Method which logs out a Subject. An implementation of this method might remove/destroy a Subject's Principals and Credentials. Returns: true if this method succeeded, or false if this LoginModule should be ignored. Exceptions: LoginException  if the logout fails Definition at line 189 of file ClientLoginModule.java. References org.objectweb.security.context.SecurityCurrent.getCurrent(), and org.objectweb.security.context.SecurityCurrent.setSecurityContext().

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• src/org/objectweb/jonas/security/auth/spi/ClientLoginModule.java

---