Class UnixLoginModule
- All Implemented Interfaces:
LoginModule
LoginModule
imports a user's Unix
Principal
information (UnixPrincipal
,
UnixNumericUserPrincipal
,
and UnixNumericGroupPrincipal
)
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.
- Since:
- 1.4
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
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 thisLoginModule
.boolean
login()
Authenticate the user (first phase).boolean
logout()
Logout the userMethods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Modifier and TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.boolean
Indicates whether some other object is "equal to" this one.protected void
finalize()
Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class
<?> getClass()
Returns the runtime class of thisObject
.int
hashCode()
Returns a hash code value for this object.final void
notify()
Wakes up a single thread that is waiting on this object's monitor.final void
Wakes up all threads that are waiting on this object's monitor.toString()
Returns a string representation of the object.final void
wait()
Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final void
wait
(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final void
wait
(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Constructor Details
-
UnixLoginModule
public UnixLoginModule()Creates aUnixLoginModule
.
-
-
Method Details
-
initialize
public void initialize(Subject subject, CallbackHandler callbackHandler, Map<String, ?> sharedState, Map<String, ?> options) Initialize thisLoginModule
.- Specified by:
initialize
in interfaceLoginModule
- Parameters:
subject
- theSubject
to be authenticated.callbackHandler
- aCallbackHandler
for communicating with the end user (prompting for usernames and passwords, for example).sharedState
- sharedLoginModule
state.options
- options specified in the loginConfiguration
for this particularLoginModule
.
-
login
Authenticate the user (first phase).The implementation of this method attempts to retrieve the user's Unix
Subject
information by making a native Unix system call.- Specified by:
login
in interfaceLoginModule
- Returns:
- true in all cases (this
LoginModule
should not be ignored). - Throws:
FailedLoginException
- if attempts to retrieve the underlying system information fail.LoginException
- if the authentication fails
-
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 Unix authentication information succeeded), then this method associates the Unix Principals with the
Subject
currently tied to theLoginModule
. If this LoginModule's authentication attempted failed, then this method removes any state that was originally saved.- Specified by:
commit
in interfaceLoginModule
- Returns:
- true if this LoginModule's own login and commit attempts succeeded, or false otherwise.
- Throws:
LoginException
- if the commit fails
-
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
andcommit
methods.- Specified by:
abort
in interfaceLoginModule
- Returns:
- false if this LoginModule's own login and/or commit attempts failed, and true otherwise.
- Throws:
LoginException
- if the abort fails
-
logout
Logout the userThis method removes the Principals associated with the
Subject
.- Specified by:
logout
in interfaceLoginModule
- Returns:
- true in all cases (this
LoginModule
should not be ignored). - Throws:
LoginException
- if the logout fails
-