- java.lang.Object
- 
- com.sun.security.auth.module.NTLoginModule
 
- 
- All Implemented Interfaces:
- LoginModule
 
 public class NTLoginModule extends Object implements LoginModule ThisLoginModulerenders a user's NT security information as some number ofPrincipals and associates them with aSubject.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. This LoginModule also recognizes the debugNative option. If set to true in the login Configuration, debug messages from the native component of the module will be output to the output stream, System.out. - See Also:
- LoginModule
 
- 
- 
Constructor SummaryConstructors Constructor Description NTLoginModule()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanabort()This method is called if the LoginContext's overall authentication failed.booleancommit()This method is called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded).voidinitialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)Initialize thisLoginModule.booleanlogin()Import underlying NT system identity information.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). This particular LoginModule only extracts the underlying NT system information, so this parameter is ignored.
- sharedState- shared- LoginModulestate.
- options- options specified in the login- Configurationfor this particular- LoginModule.
 
 - 
loginpublic boolean login() throws LoginExceptionImport underlying NT system identity information.- Specified by:
- loginin interface- LoginModule
- Returns:
- true in all cases since this LoginModuleshould not be ignored.
- Throws:
- FailedLoginException- if the authentication fails.
- LoginException- if this- LoginModuleis unable to perform the authentication.
 
 - 
commitpublic boolean commit() throws LoginExceptionThis 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 loginmethod), then this method associates some number of variousPrincipals with theSubjectlocated in theLoginModuleContext. If this LoginModule's own 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 LoginExceptionThis 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 loginandcommitmethods), then this method cleans up any state that was originally saved.- 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 user.This method removes the NTUserPrincipal,NTDomainPrincipal,NTSidUserPrincipal,NTSidDomainPrincipal,NTSidGroupPrincipals, andNTSidPrimaryGroupPrincipalthat may have been added by thecommitmethod.- Specified by:
- logoutin interface- LoginModule
- Returns:
- true in all cases since this LoginModuleshould not be ignored.
- Throws:
- LoginException- if the logout fails.
 
 
- 
 
-