org.jboss.security.auth.message.config

Class JBossAuthConfigProvider

java.lang.Object

org.jboss.security.auth.message.config.JBossAuthConfigProvider

All Implemented Interfaces:

AuthConfigProvider

public class JBossAuthConfigProvider
extends Object
implements AuthConfigProvider

Default Auth Config Provider

Since:

May 15, 2006

Version:

$Revision$

Author:

Anil Saldhana

Constructor Summary

Constructors

Constructor and Description
JBossAuthConfigProvider(Map<String,Object> props, AuthConfigFactory factory) Create a new JBossAuthConfigProvider.

Method Summary

Modifier and Type	Method and Description
ClientAuthConfig	getClientAuthConfig(String layer, String appContext, CallbackHandler handler) Get an instance of ClientAuthConfig from this provider.
ServerAuthConfig	getServerAuthConfig(String layer, String appContext, CallbackHandler handler) Get an instance of ServerAuthConfig from this provider.
void	refresh() Causes a dynamic configuration provider to update its internal state such that any resulting change to its state is reflected in the corresponding authentication context configuration objects previously created by the provider within the current process context.

Methods inherited from class java.lang.Object

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

Constructor Detail

JBossAuthConfigProvider

public JBossAuthConfigProvider(Map<String,Object> props,
                               AuthConfigFactory factory)

Create a new JBossAuthConfigProvider.

Parameters:

props - Context Properties

Method Detail

getClientAuthConfig

public ClientAuthConfig getClientAuthConfig(String layer,
                                            String appContext,
                                            CallbackHandler handler)
                                     throws AuthException

Description copied from interface: AuthConfigProvider

Get an instance of ClientAuthConfig from this provider.

The implementation of this method returns a ClientAuthConfig instance that describes the configuration of ClientAuthModules at a given message layer, and for use in an identified application context.

Specified by:

getClientAuthConfig in interface AuthConfigProvider

Parameters:

layer - A String identifying the message layer for the returned ClientAuthConfig object. This argument must not be null.

appContext - A String that identifies the messaging context for the returned ClientAuthConfig object. This argument must not be null.

handler - A CallbackHandler to be passed to the ClientAuthModules encapsulated by ClientAuthContext objects derived from the returned ClientAuthConfig. This argument may be null, in which case the implementation may assign a default handler to the configuration. The CallbackHandler assigned to the configuration must support the Callback objects required to be supported by the profile of this specification being followed by the messaging runtime. The CallbackHandler instance must be initialized with any application context needed to process the required callbacks on behalf of the corresponding application.

Returns:

A ClientAuthConfig Object that describes the configuration of ClientAuthModules at the message layer and messaging context identified by the layer and appContext arguments. This method does not return null.

Throws:

AuthException - If this factory does not support the assignment of a default CallbackHandler to the returned ClientAuthConfig.

See Also:

AuthConfigProvider.getClientAuthConfig(String, String, CallbackHandler)

getServerAuthConfig

public ServerAuthConfig getServerAuthConfig(String layer,
                                            String appContext,
                                            CallbackHandler handler)
                                     throws AuthException

Description copied from interface: AuthConfigProvider

Get an instance of ServerAuthConfig from this provider.

The implementation of this method returns a ServerAuthConfig instance that describes the configuration of ServerAuthModules at a given message layer, and for use in an identified application context.

Specified by:

getServerAuthConfig in interface AuthConfigProvider

Parameters:

layer - A String identifying the message layer for the returned ServerAuthConfig object. This argument must not be null.

appContext - A String that identifies the messaging context for the returned ServerAuthConfig object. This argument must not be null.

handler - A CallbackHandler to be passed to the ServerAuthModules encapsulated by ServerAuthContext objects derived from the returned ServerAuthConfig. This argument may be null, in which case the implementation may assign a default handler to the configuration. The CallbackHandler assigned to the configuration must support the Callback objects required to be supported by the profile of this specification being followed by the messaging runtime. The CallbackHandler instance must be initialized with any application context needed to process the required callbacks on behalf of the corresponding application.

Returns:

A ServerAuthConfig Object that describes the configuration of ServerAuthModules at a given message layer, and for a particular application context. This method does not return null.

Throws:

AuthException - If this provider does not support the assignment of a default CallbackHandler to the returned ServerAuthConfig.

See Also:

AuthConfigProvider.getServerAuthConfig(String, String, CallbackHandler)

refresh

public void refresh()

Description copied from interface: AuthConfigProvider

Causes a dynamic configuration provider to update its internal state such that any resulting change to its state is reflected in the corresponding authentication context configuration objects previously created by the provider within the current process context.

Specified by:

refresh in interface AuthConfigProvider

See Also:

AuthConfigProvider.refresh()