*** This API provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.security.login
Class TrustedLoginModule

java.lang.Object
  |
  +--com.sas.services.security.login.TrustedLoginModule

All Implemented Interfaces:

Direct Known Subclasses:

public class TrustedLoginModule

extends Object

implements javax.security.auth.spi.LoginModule

Trusted login module. This is used to create credentials required for the proper operation of the SAS Java Platform when used in an environment where an external entity is controlling the authentication process. Usually that means a secured web container. This module is to be configured in a "stacked" JAAS configuration where a previously defined module is defined as required, and this module is defined as optional. Since this module's login always succeeds, JAAS needs to be configured in such a way that the success of an authentication is not solely dependent on this module.

The TrustedLoginModule accepts the following options: The userid that will be used for the password generation process. This userid has to be defined in the metadata server's trustedusers.txt file.

host	The DNS hostname that the metadata server to authenticate against is running on
port	The IP port that the metadata server is listening on for new connections
domain	The authentication domain that this module is authenticating in. Requests to authenticate users outside this domain will be ignored.
repository	The repository name that will be the default when the connection is returned. For the primary authentication, this will normally be the foundation.
trusteduser
trustedpw	The password for the trusted user that will perform the password generation.
encrypt	Flag indicating whether the connection to the server should be encrypted for authentication. The value should be "true" or "false".
debug	Set to "true" to output debug information to System.out

Since:

1.0

Field Summary

protected CallbackHandler	_callbackHandler
protected List	_credentials
protected boolean	_debug
protected String	_defaultHost
protected int	_defaultPort
protected String	_defaultRepository
protected List	_groups
protected String	_host
protected String	_password
protected int	_port
protected List	_principals
protected String	_repository
protected List	_roles
protected String	_username
protected ConnectionInterface	cx
protected ConnectionFactoryInterface	cxf
protected ConnectionInterface	tcx

Constructor Summary

TrustedLoginModule()

Method Summary

boolean	abort()
protected void	addDefaultCredential()
boolean	commit()
protected boolean	doLogin()
void	finalize()
void	initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)
boolean	login()
boolean	logout()

Methods inherited from class java.lang.Object

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

Field Detail

_callbackHandler

protected CallbackHandler _callbackHandler

_username

protected String _username

_password

protected String _password

_defaultHost

protected String _defaultHost

_defaultPort

protected int _defaultPort

_defaultRepository

protected String _defaultRepository

_host

protected String _host

_port

protected int _port

_repository

protected String _repository

_debug

protected boolean _debug

_principals

protected List _principals

_groups

protected List _groups

_credentials

protected List _credentials

_roles

protected List _roles

tcx

protected ConnectionInterface tcx

cxf

protected ConnectionFactoryInterface cxf

cx

protected ConnectionInterface cx

Constructor Detail

TrustedLoginModule

public TrustedLoginModule()

Method Detail

initialize

public void initialize(Subject subject,
                       CallbackHandler callbackHandler,
                       Map sharedState,
                       Map options)

Specified by:

initialize in interface LoginModule

See Also:

LoginModule.initialize(Subject, CallbackHandler, Map, Map)

login

public boolean login()
              throws LoginException

Specified by:

login in interface LoginModule

See Also:

LoginModule.login()

doLogin

protected boolean doLogin()
                   throws LoginException

addDefaultCredential

protected void addDefaultCredential()

commit

public boolean commit()
               throws LoginException

Specified by:

commit in interface LoginModule

See Also:

LoginModule.commit()

abort

public boolean abort()
              throws LoginException

Specified by:

abort in interface LoginModule

See Also:

LoginModule.abort()

logout

public boolean logout()
               throws LoginException

Specified by:

logout in interface LoginModule

See Also:

LoginModule.logout()

finalize

public void finalize()

Overrides:

finalize in class Object

*** This API provides Binary Compatibility only, not Source Compatibility ***