org.jboss.security.jacc

Class SubjectPolicyContextHandler

java.lang.Object

org.jboss.security.jacc.SubjectPolicyContextHandler

All Implemented Interfaces:

PolicyContextHandler

public class SubjectPolicyContextHandler
extends Object
implements PolicyContextHandler

A PolicyContextHandler for the current authenticated Subject.

Version:

$Revison:$

Author:

Scott.Stark@jboss.org, Anil.Saldhana@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static HashSet<Object>	EMPTY_SET

Constructor Summary

Constructors

Constructor and Description
SubjectPolicyContextHandler()

Method Summary

Modifier and Type	Method and Description
Object	getContext(String key, Object data) This public method is used by the PolicyContext class to activate the handler and obtain from it the context object identified by the (case-sensitive) key.
String[]	getKeys() This public method returns the keys identifying the context objects supported by the handler.
boolean	supports(String key) This public method returns a boolean result indicating whether or not the handler supports the context object identified by the (case-sensitive) key value.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_SET

public static final HashSet<Object> EMPTY_SET

Constructor Detail

SubjectPolicyContextHandler

public SubjectPolicyContextHandler()

Method Detail

getContext

public Object getContext(String key,
                         Object data)
                  throws PolicyContextException

Description copied from interface: PolicyContextHandler

This public method is used by the PolicyContext class to activate the handler and obtain from it the context object identified by the (case-sensitive) key. In addition to the key, the handler will be activated with the handler data value associated within the PolicyContext class with the thread on which the call to this method is made.

Note that the policy context identifier associated with a thread is available to the handler by calling PolicyContext.getContextID().

Specified by:

getContext in interface PolicyContextHandler

Parameters:

key - - a String that identifies the context object to be returned by the handler. The value of this parameter must not be null.

data - - the handler data Object associated with the thread on which the call to this method has been made. Note that the value passed through this parameter may be null.

Returns:

The container and handler specific Object containing the desired context. A null value may be returned if the value of the corresponding context is null.

Throws:

PolicyContextException - - if the implementation throws a checked exception that has not been accounted for by the method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.

getKeys

public String[] getKeys()
                 throws PolicyContextException

Description copied from interface: PolicyContextHandler

This public method returns the keys identifying the context objects supported by the handler. The value of each key supported by a handler must be a non-null String value.

Specified by:

getKeys in interface PolicyContextHandler

Returns:

an array containing String values identifying the context objects supported by the handler. The array must not contain duplicate key values. In the unlikely case that the Handler supports no keys, the handler must return a zero length array. The value null must never be returned by this method.

Throws:

PolicyContextException - - if the implementation throws a checked exception that has not been accounted for by the method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.

supports

public boolean supports(String key)
                 throws PolicyContextException

Description copied from interface: PolicyContextHandler

This public method returns a boolean result indicating whether or not the handler supports the context object identified by the (case-sensitive) key value.

Specified by:

supports in interface PolicyContextHandler

Parameters:

key - - a String value identifying a context object that could be supported by the handler. The value of this parameter must not be null.

Returns:

a boolean indicating whether or not the context object corresponding to the argument key is handled by the handler.

Throws:

PolicyContextException - - if the implementation throws a checked exception that has not been accounted for by the method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.