org.jboss.security.auth.message.config

Class JBossClientAuthConfig

java.lang.Object

org.jboss.security.auth.message.config.JBossClientAuthConfig

All Implemented Interfaces:

AuthConfig, ClientAuthConfig

Direct Known Subclasses:

JBossWSClientAuthConfig

public class JBossClientAuthConfig
extends Object
implements ClientAuthConfig

Default Client Authentication Configuration

Since:

May 15, 2006

Version:

$Revision$

Author:

Anil Saldhana

Constructor Summary

Constructors

Constructor and Description
JBossClientAuthConfig(String layer, String appContext, CallbackHandler handler, Map properties) Create a new JBossClientAuthConfig.

Method Summary

Modifier and Type	Method and Description
String	getAppContext() Get the application context identifier of this authentication context configuration object.
ClientAuthContext	getAuthContext(String authContextID, Subject clientSubject, Map properties) Get a ClientAuthContext instance from this ClientAuthConfig.
String	getAuthContextID(MessageInfo messageInfo) Get the authentication context identifier corresponding to the request and response objects encapsulated in messageInfo.
List	getClientAuthModules()
String	getMessageLayer() Get the message layer name of this authentication context configuration object.
boolean	isProtected() Used to determine whether the authentication context configuration object encapsulates any protected authentication contexts.
void	refresh() Causes a dynamic authentication context configuration object to update the internal state that it uses to process calls to its getAuthContext method.

Methods inherited from class java.lang.Object

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

Constructor Detail

JBossClientAuthConfig

public JBossClientAuthConfig(String layer,
                             String appContext,
                             CallbackHandler handler,
                             Map properties)

Create a new JBossClientAuthConfig.

Parameters:

layer - Message Layer

appContext - Application Context

handler - Callback Handler to be passed to auth modules

properties - Contextual properties

Method Detail

getAuthContext

public ClientAuthContext getAuthContext(String authContextID,
                                        Subject clientSubject,
                                        Map properties)
                                 throws AuthException

Description copied from interface: ClientAuthConfig

Get a ClientAuthContext instance from this ClientAuthConfig.

The implementation of this method returns a ClientAuthContext instance that encapsulates the ClientAuthModules used to secure and validate requests/responses associated with the given authContextID.

Specifically, this method accesses this ClientAuthConfig object with the argument authContextID to determine the ClientAuthModules that are to be encapsulated in the returned ClientAuthContext instance.

The ClientAuthConfig object establishes the request and response MessagePolicy objects that are passed to the encapsulated modules when they are initialized by the returned ClientAuthContext instance. It is the modules' responsibility to enforce these policies when invoked.

Specified by:

getAuthContext in interface ClientAuthConfig

Parameters:

authContextID - An String identifier used to index the provided config, or null. This value must be identical to the value returned by the getAuthContextID method for all MessageInfo objects passed to the secureRequest method of the returned ClientAuthContext.

clientSubject - A Subject that represents the source of the service request to be secured by the acquired authentication context. The principals and credentials of the Subject may be used to select or acquire the authentication context. If the Subject is not null, additional Principals or credentials (pertaining to the source of the request) may be added to the Subject. A null value may be passed for this parameter.

properties - A Map object that may be used by the caller to augment the properties that will be passed to the encapsulated modules at module initialization. The null value may be passed for this parameter.

Returns:

A ClientAuthContext instance that encapsulates the ClientAuthModules used to secure and validate requests/responses associated with the given authContextID, or null (indicating that no modules are configured).

Throws:

AuthException - If this method fails.

See Also:

ClientAuthConfig.getAuthContext(String, javax.security.auth.Subject, java.util.Map)

getMessageLayer

public String getMessageLayer()

Description copied from interface: AuthConfig

Get the message layer name of this authentication context configuration object.

Specified by:

getMessageLayer in interface AuthConfig

Returns:

The message layer name of this configuration object, or null if the configuration object pertains to an unspecified message layer.

See Also:

AuthConfig.getMessageLayer()

refresh

public void refresh()

Description copied from interface: AuthConfig

Causes a dynamic authentication context configuration object to update the internal state that it uses to process calls to its getAuthContext method.

Specified by:

refresh in interface AuthConfig

See Also:

AuthConfig.refresh()

getClientAuthModules

public List getClientAuthModules()

getAppContext

public String getAppContext()

Description copied from interface: AuthConfig

Get the application context identifier of this authentication context configuration object.

Specified by:

getAppContext in interface AuthConfig

Returns:

The String identifying the application context of this configuration object, or null if the configuration object pertains to an unspecified application context.

getAuthContextID

public String getAuthContextID(MessageInfo messageInfo)

Description copied from interface: AuthConfig

Get the authentication context identifier corresponding to the request and response objects encapsulated in messageInfo.

Specified by:

getAuthContextID in interface AuthConfig

Parameters:

messageInfo - A contextual Object that encapsulates the client request and server response objects.

Returns:

The authentication context identifier corresponding to the encapsulated request and response objects, or null.

isProtected

public boolean isProtected()

Description copied from interface: AuthConfig

Used to determine whether the authentication context configuration object encapsulates any protected authentication contexts.

Specified by:

isProtected in interface AuthConfig

Returns:

True if the configuration object encapsulates at least one protected authentication context. Otherwise, this method returns false.