com.filenet.api.util

Class WSILoginModule

java.lang.Object

com.filenet.api.util.WSILoginModule

All Implemented Interfaces:

javax.security.auth.spi.LoginModule

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

Provides authentication for the FileNet P8 Content Engine web services (SOAP-based) protocol. (Note that "WSI" refers to the web service interface to the FileNet P8 Content Engine.) When the Content Engine Java API is used over this protocol, username/password credentials are the only supported authentication mechanism, and this login module must be used to perform a Java™ Authentication and Authorization Service (JAAS) login.

Note that a user of the Content Engine Java API never directly creates or uses an instance of this class. Rather, the API user obtains a JAAS LoginContext, using a JAAS configuration that specifies the WSILoginModule, and calls the login() method on the JAAS LoginContext. The JAAS runtime framework will invoke this WSILoginModule.

The methods and parameters used in this WSILoginModule conform to the standard JAAS LoginModule interface. For information on these methods and their parameters, refer to JAAS documentation for javax.security.auth.spi.LoginModule.

Constructor Summary

Constructors

Constructor and Description
WSILoginModule()

Method Summary

Modifier and Type	Method and Description
boolean	abort() The standard javax.security.auth.spi.LoginModule.abort() method.
boolean	commit() The standard javax.security.auth.spi.LoginModule.commit() method.
void	initialize(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler callbackHandler, java.util.Map sharedState, java.util.Map options) The standard javax.security.auth.spi.LoginModule.initialize() method.
boolean	login() The standard javax.security.auth.spi.LoginModule.login() method.
boolean	logout() The standard javax.security.auth.spi.LoginModule.logout() method.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WSILoginModule

public WSILoginModule()

Method Detail

initialize

public void initialize(javax.security.auth.Subject subject,
                       javax.security.auth.callback.CallbackHandler callbackHandler,
                       java.util.Map sharedState,
                       java.util.Map options)

The standard javax.security.auth.spi.LoginModule.initialize() method. Refer to the Java™ 2 Platform Standard Edition (J2SE) documentation for details about the use of this method.

Specified by:

initialize in interface javax.security.auth.spi.LoginModule

login

public boolean login()
              throws javax.security.auth.login.LoginException

The standard javax.security.auth.spi.LoginModule.login() method. Refer to the J2SE documentation for details about the use of this method.

Specified by:

login in interface javax.security.auth.spi.LoginModule

Throws:

javax.security.auth.login.LoginException

commit

public boolean commit()

The standard javax.security.auth.spi.LoginModule.commit() method. Refer to the J2SE documentation for details about the use of this method.

Specified by:

commit in interface javax.security.auth.spi.LoginModule

abort

public boolean abort()

The standard javax.security.auth.spi.LoginModule.abort() method. Refer to the J2SE documentation for details about the use of this method.

Specified by:

abort in interface javax.security.auth.spi.LoginModule

logout

public boolean logout()

The standard javax.security.auth.spi.LoginModule.logout() method. Refer to the J2SE documentation for details about the use of this method.

Specified by:

logout in interface javax.security.auth.spi.LoginModule