public class

SolarisLoginModule

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

This class is deprecated.
As of JDK1.4, replaced by com.sun.security.auth.module.UnixLoginModule. This LoginModule is entirely deprecated and is here to allow for a smooth transition to the new UnixLoginModule.

Class Overview

This LoginModule imports a user's Solaris Principal information (SolarisPrincipal, SolarisNumericUserPrincipal, and SolarisNumericGroupPrincipal) and associates them with the current 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.

Summary

Public Constructors
SolarisLoginModule()
Public Methods
boolean abort()
Abort the authentication (second phase).
boolean commit()
Commit the authentication (second phase).
void initialize(Subject subject, CallbackHandler callbackHandler, Map<String, ?> sharedState, Map<String, ?> options)
Initialize this LoginModule.
boolean login()
Authenticate the user (first phase).
boolean logout()
Logout the user

This method removes the Principals associated with the Subject.

[Expand]
Inherited Methods
From class java.lang.Object
From interface javax.security.auth.spi.LoginModule

Public Constructors

public SolarisLoginModule ()

Public Methods

public boolean abort ()

Abort 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 login and commit methods.

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 ()

Commit 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 Solaris authentication information succeeded), then this method associates the Solaris Principals with the Subject currently tied to the LoginModule. If this LoginModule's 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).

sharedState shared LoginModule state.

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

public boolean login ()

Authenticate the user (first phase).

The implementation of this method attempts to retrieve the user's Solaris Subject information by making a native Solaris system call.

Returns
  • true in all cases (this LoginModule should not be ignored).
Throws
FailedLoginException if attempts to retrieve the underlying system information fail.
LoginException

public boolean logout ()

Logout the user

This method removes the Principals associated with the Subject.

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