Package org.jboss.security.identitytrust.modules

Class AbstractIdentityTrustModule

java.lang.Object

org.jboss.security.identitytrust.modules.AbstractIdentityTrustModule

All Implemented Interfaces:

IdentityTrustModule

Direct Known Subclasses:

AlwaysDenyTrustModule, AlwaysNotApplicableTrustModule, AlwaysPermitTrustModule, JavaEETrustModule

public abstract class AbstractIdentityTrustModule
extends Object
implements IdentityTrustModule

Abstract IdentityTrustModule that pulls in common stuff

Since:

Aug 2, 2007

Version:

$Revision$

Author:

Anil.Saldhana@redhat.com

Field Summary

Fields

Modifier and Type	Field	Description
protected CallbackHandler	callbackHandler
protected Map<String,Object>	options
protected SecurityContext	securityContext
protected Map<String,Object>	sharedState

Constructor Summary

Constructors

Constructor	Description
AbstractIdentityTrustModule()

Method Summary

Modifier and Type	Method	Description
boolean	abort()	Abort the Trust Process
boolean	commit()	The IdentityTrust Process has succeeded.
void	initialize(SecurityContext sc, CallbackHandler handler, Map<String,Object> sharedState, Map<String,Object> options)	Initialize the module with the SecurityContext on which trust decisions will be made
abstract IdentityTrustManager.TrustDecision	isTrusted()	Make the trust decision

Methods inherited from class java.lang.Object

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

Field Detail

securityContext

protected SecurityContext securityContext

callbackHandler

protected CallbackHandler callbackHandler

sharedState

protected Map<String,Object> sharedState

options

protected Map<String,Object> options

Constructor Detail

AbstractIdentityTrustModule

public AbstractIdentityTrustModule()

Method Detail

abort

public boolean abort()
              throws IdentityTrustException

Description copied from interface: IdentityTrustModule

Abort the Trust Process

Specified by:

abort in interface IdentityTrustModule

Returns:

true -abort process succeeded

Throws:

IdentityTrustException

See Also:

IdentityTrustModule.abort()

commit

public boolean commit()
               throws IdentityTrustException

Description copied from interface: IdentityTrustModule

The IdentityTrust Process has succeeded. The module can commit its decision (maybe to a Database)

Specified by:

commit in interface IdentityTrustModule

Returns:

- commit process succeeded

Throws:

IdentityTrustException

See Also:

IdentityTrustModule.commit()

initialize

public void initialize(SecurityContext sc,
                       CallbackHandler handler,
                       Map<String,Object> sharedState,
                       Map<String,Object> options)
                throws IdentityTrustException

Description copied from interface: IdentityTrustModule

Initialize the module with the SecurityContext on which trust decisions will be made

Specified by:

initialize in interface IdentityTrustModule

handler - a CallbackHandler if needed

sharedState - a Shared State passed to all modules

options - configured options

Throws:

IdentityTrustException

See Also:

IdentityTrustModule.initialize(SecurityContext, CallbackHandler, Map, Map)

isTrusted

public abstract IdentityTrustManager.TrustDecision isTrusted()
                                                      throws IdentityTrustException

Description copied from interface: IdentityTrustModule

Make the trust decision

Specified by:

isTrusted in interface IdentityTrustModule

Returns:

IdentityTrustManager.TrustDecision.Permit, IdentityTrustManager.TrustDecision.Deny, IdentityTrustManager.TrustDecision.NotApplicable

Throws:

IdentityTrustException

See Also:

IdentityTrustModule.isTrusted()