- java.lang.Object
- 
- com.sun.security.auth.module.UnixLoginModule
 
- 
- All Implemented Interfaces:
- LoginModule
 
 public class UnixLoginModule extends Object implements LoginModule ThisLoginModuleimports a user's UnixPrincipalinformation (UnixPrincipal,UnixNumericUserPrincipal, andUnixNumericGroupPrincipal) and associates them with the currentSubject.This LoginModule recognizes the debug option. If set to true in the login Configuration, debug messages will be output to the output stream, System.out. 
- 
- 
Constructor SummaryConstructors Constructor Description UnixLoginModule()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanabort()Abort the authentication (second phase).booleancommit()Commit the authentication (second phase).voidinitialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)Initialize thisLoginModule.booleanlogin()Authenticate the user (first phase).booleanlogout()Logout the user
 
- 
- 
- 
Method Detail- 
initializepublic void initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options) Initialize thisLoginModule.- Specified by:
- initializein interface- LoginModule
- Parameters:
- subject- the- Subjectto be authenticated.
- callbackHandler- a- CallbackHandlerfor communicating with the end user (prompting for usernames and passwords, for example).
- sharedState- shared- LoginModulestate.
- options- options specified in the login- Configurationfor this particular- LoginModule.
 
 - 
loginpublic boolean login() throws LoginExceptionAuthenticate the user (first phase).The implementation of this method attempts to retrieve the user's Unix Subjectinformation by making a native Unix system call.- Specified by:
- loginin interface- LoginModule
- Returns:
- true in all cases (this LoginModuleshould not be ignored).
- Throws:
- FailedLoginException- if attempts to retrieve the underlying system information fail.
- LoginException- if the authentication fails
 
 - 
commitpublic boolean commit() throws LoginExceptionCommit the authentication (second phase).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 (the importing of the Unix authentication information succeeded), then this method associates the Unix Principals with the Subjectcurrently tied to theLoginModule. If this LoginModule's authentication attempted failed, then this method removes any state that was originally saved.- Specified by:
- commitin interface- LoginModule
- Returns:
- true if this LoginModule's own login and commit attempts succeeded, or false otherwise.
- Throws:
- LoginException- if the commit fails
 
 - 
abortpublic boolean abort() throws LoginExceptionAbort the authentication (second phase).This method is called if the LoginContext's overall authentication failed. (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules did not succeed). This method cleans up any state that was originally saved as part of the authentication attempt from the loginandcommitmethods.- Specified by:
- abortin interface- LoginModule
- Returns:
- false if this LoginModule's own login and/or commit attempts failed, and true otherwise.
- Throws:
- LoginException- if the abort fails
 
 - 
logoutpublic boolean logout() throws LoginExceptionLogout the userThis method removes the Principals associated with the Subject.- Specified by:
- logoutin interface- LoginModule
- Returns:
- true in all cases (this LoginModuleshould not be ignored).
- Throws:
- LoginException- if the logout fails
 
 
- 
 
-