IdentityTrustModule (PicketBox- Parent 5.1.0.Final API)

All Known Implementing Classes:

AbstractIdentityTrustModule, AlwaysDenyTrustModule, AlwaysNotApplicableTrustModule, AlwaysPermitTrustModule, JavaEETrustModule
```
public interface IdentityTrustModule
```
IdentityTrustModule that is capable of making trust decisions

Since:

Aug 2, 2007

Version:

$Revision$

Author:

Anil.Saldhana@redhat.com

Method Summary

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

- Method Detail
  - abort
```
boolean abort()
       throws IdentityTrustException
```
    Abort the Trust Process
    
    Returns:
    
    true -abort process succeeded
    
    Throws:
    
    IdentityTrustException
  - commit
```
boolean commit()
        throws IdentityTrustException
```
    The IdentityTrust Process has succeeded. The module can commit its decision (maybe to a Database)
    
    Returns:
    
    - commit process succeeded
    
    Throws:
    
    IdentityTrustException
  - initialize
```
void initialize(SecurityContext securityContext,
                CallbackHandler handler,
                Map<String,Object> sharedState,
                Map<String,Object> options)
         throws IdentityTrustException
```
    Initialize the module with the SecurityContext on which trust decisions will be made
    
    Parameters:
    
    securityContext -
    
    handler - a CallbackHandler if needed
    
    sharedState - a Shared State passed to all modules
    
    options - configured options
    
    Throws:
    
    IdentityTrustException
  - isTrusted
```
IdentityTrustManager.TrustDecision isTrusted()
                                      throws IdentityTrustException
```
    Make the trust decision
    
    Returns:
    
    IdentityTrustManager.TrustDecision.Permit, IdentityTrustManager.TrustDecision.Deny, IdentityTrustManager.TrustDecision.NotApplicable
    
    Throws:
    
    IdentityTrustException