PolicyContext
class.
* The PolicyContext
class provides methods for containers to
* register and activate container-specific PolicyContext
handlers.
* Policy
providers use the PolicyContext
class to
* activate handlers to obtain (from the container) additional policy relevant
* context to apply in their access decisions. All handlers registered and
* activated via the PolicyContext
class must implement the
* PolicyContextHandler
interface.
*
* @version $Rev$ $Date$
*/
public 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.
* @param key a String
PolicyContext/ class to
* activate the handler and obtain from it the 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().
* @param key a String that identifies the context object to be returned by
* the handler. The value of this paramter must not be null.
* @param 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.
* @return 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
*/
public Object getContext(String key, Object data) throws PolicyContextException;
}