org.jboss.security.auth.callback

Class CallbackHandlerPolicyContextHandler

java.lang.Object

org.jboss.security.auth.callback.CallbackHandlerPolicyContextHandler

All Implemented Interfaces:

PolicyContextHandler

public class CallbackHandlerPolicyContextHandler
extends Object
implements PolicyContextHandler

A PolicyContextHandler implementation that allows a dynamic CallbackHandler to be associated with the current context for use with authentication.

Version:

$Revision$

Author:

Scott.Stark@jboss.org

Constructor Summary

Constructors

Constructor and Description
CallbackHandlerPolicyContextHandler()

Method Summary

Modifier and Type	Method and Description
Object	getContext(String key, Object data) Access the CallbackHandler policy context data.
String[]	getKeys() This public method returns the keys identifying the context objects supported by the handler.
static void	setCallbackHandler(CallbackHandler bean)
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

Constructor Detail

CallbackHandlerPolicyContextHandler

public CallbackHandlerPolicyContextHandler()

Method Detail

setCallbackHandler

public static void setCallbackHandler(CallbackHandler bean)

getContext

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

Access the CallbackHandler policy context data.

Specified by:

getContext in interface PolicyContextHandler

Parameters:

key - - "org.jboss.security.auth.spi.CallbackHandler"

data - currently unused

Returns:

The active CallbackHandler

Throws:

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