IBM WebSphere Application ServerTM
Release 7

com.ibm.wsspi.wssecurity.auth.module
Class BSTokenLoginModule

java.lang.Object
  extended by com.ibm.wsspi.wssecurity.auth.module.BSTokenLoginModule
All Implemented Interfaces:
javax.security.auth.spi.LoginModule
Direct Known Subclasses:
PKCS7LoginModule, PkiPathLoginModule, X509LoginModule

public abstract class BSTokenLoginModule
extends java.lang.Object
implements javax.security.auth.spi.LoginModule

Base class for processing and validating the X509Certificate data.

See Also:
LoginModule

Field Summary
protected  byte[] _binary
           
protected  java.security.cert.X509Certificate _cert
           
protected  javax.security.auth.callback.CallbackHandler _handler
           
protected  SOAPMessageContext _messageContext
           
protected  java.util.Map _options
           
protected  java.util.Map _properties
           
protected  java.util.Map _sharedState
           
protected  javax.security.auth.Subject _subject
           
 
Constructor Summary
BSTokenLoginModule()
           
 
Method Summary
 boolean abort()
          Aborts the login process by removing the certificate data from the Subect.
 boolean commit()
          Commits the login process by adding the certificate data into the Subject.
 void initialize(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler handler, java.util.Map sharedState, java.util.Map options)
          Intializes this LoginModule.
 boolean login()
          Logs in to the login process.
 boolean logout()
          Logs out the login process.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_subject

protected javax.security.auth.Subject _subject

_handler

protected javax.security.auth.callback.CallbackHandler _handler

_sharedState

protected java.util.Map _sharedState

_options

protected java.util.Map _options

_binary

protected byte[] _binary

_properties

protected java.util.Map _properties

_messageContext

protected SOAPMessageContext _messageContext

_cert

protected java.security.cert.X509Certificate _cert
Constructor Detail

BSTokenLoginModule

public BSTokenLoginModule()
Method Detail

initialize

public void initialize(javax.security.auth.Subject subject,
                       javax.security.auth.callback.CallbackHandler handler,
                       java.util.Map sharedState,
                       java.util.Map options)
Intializes this LoginModule.

Specified by:
initialize in interface javax.security.auth.spi.LoginModule
Parameters:
subject - The Subject to be authenticated.
handler - The CallbackHandler used to gather login data from the user.
sharedState - State data shared between login modules.
options - A Map of key-value pairs specifying configuration options for this login module.
See Also:
LoginModule.initialize(Subject, CallbackHandler, Map, Map)

login

public boolean login()
              throws javax.security.auth.login.LoginException
Logs in to the login process.

Specified by:
login in interface javax.security.auth.spi.LoginModule
Returns:
true if the login is successful, false otherwise
Throws:
javax.security.auth.login.LoginException - if the login fails
See Also:
LoginModule.login()

commit

public boolean commit()
               throws javax.security.auth.login.LoginException
Commits the login process by adding the certificate data into the Subject.

Specified by:
commit in interface javax.security.auth.spi.LoginModule
Returns:
true if the commit is successful, false otherwise
Throws:
javax.security.auth.login.LoginException - if the commit fails
See Also:
LoginModule.commit()

abort

public boolean abort()
              throws javax.security.auth.login.LoginException
Aborts the login process by removing the certificate data from the Subect.

Specified by:
abort in interface javax.security.auth.spi.LoginModule
Returns:
true if the abort was successful, false otherwise
Throws:
javax.security.auth.login.LoginException - if the abort fails
See Also:
LoginModule.abort()

logout

public boolean logout()
               throws javax.security.auth.login.LoginException
Logs out the login process.

Specified by:
logout in interface javax.security.auth.spi.LoginModule
Returns:
true if the logout is successful, false otherwise
Throws:
javax.security.auth.login.LoginException - if the abort fails
See Also:
LoginModule.logout()

IBM WebSphere Application ServerTM
Release 7