public class

NTLoginModule

extends Object
implements LoginModule
java.lang.Object
   ↳ com.sun.security.auth.module.NTLoginModule

Class Overview

This LoginModule renders a user's NT security information as some number of Principals and associates them with a Subject.

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

Summary

Public Constructors
NTLoginModule()
Public Methods
boolean abort()

This method is called if the LoginContext's overall authentication failed.

boolean commit()

This method is called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded).

void initialize(Subject subject, CallbackHandler callbackHandler, Map<String, ?> sharedState, Map<String, ?> options)
Initialize this LoginModule.
boolean login()
Import underlying NT system identity information.
boolean logout()
Logout the user.
[Expand]
Inherited Methods
From class java.lang.Object
From interface javax.security.auth.spi.LoginModule

Public Constructors

public NTLoginModule ()

Public Methods

public boolean abort ()

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 and commit methods), then this method cleans up any state that was originally saved.

Returns
  • false if this LoginModule's own login and/or commit attempts failed, and true otherwise.
Throws
LoginException if the abort fails.

public boolean commit ()

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 some number of various Principals with the Subject located in the LoginModuleContext. If this LoginModule's own authentication attempted failed, then this method removes any state that was originally saved.

Returns
  • true if this LoginModule's own login and commit attempts succeeded, or false otherwise.
Throws
LoginException if the commit fails.

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

Initialize this LoginModule.

Parameters
subject the Subject to be authenticated.

callbackHandler a CallbackHandler for 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 LoginModule state.

options options specified in the login Configuration for this particular LoginModule.

public boolean login ()

Import underlying NT system identity information.

Returns
  • true in all cases since this LoginModule should not be ignored.
Throws
FailedLoginException if the authentication fails.

LoginException if this LoginModule is unable to perform the authentication.

public boolean logout ()

Logout the user.

This method removes the NTUserPrincipal, NTDomainPrincipal, NTSidUserPrincipal, NTSidDomainPrincipal, NTSidGroupPrincipals, and NTSidPrimaryGroupPrincipal that may have been added by the commit method.

Returns
  • true in all cases since this LoginModule should not be ignored.
Throws
LoginException if the logout fails.