org.jboss.wsf.stack.cxf.jaspi.config

Class JBossWSClientAuthConfig

java.lang.Object

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

org.jboss.wsf.stack.cxf.jaspi.config.JBossWSClientAuthConfig

All Implemented Interfaces:

AuthConfig, ClientAuthConfig

public class JBossWSClientAuthConfig
extends JBossClientAuthConfig

JBossWS ClientAuthConfig implementation to obtain ClientAuthContext

Author:

Jim Ma

Constructor Summary

Constructors

Constructor and Description
JBossWSClientAuthConfig(String layer, String appContext, CallbackHandler handler, Map properties)

Method Summary

Modifier and Type	Method and Description
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()

Methods inherited from class org.jboss.security.auth.message.config.JBossClientAuthConfig

getAppContext, getMessageLayer, isProtected, refresh

Methods inherited from class java.lang.Object

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

Constructor Detail

JBossWSClientAuthConfig

public JBossWSClientAuthConfig(String layer,
                               String appContext,
                               CallbackHandler handler,
                               Map 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

Overrides:

getAuthContext in class JBossClientAuthConfig

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)

getClientAuthModules

public List getClientAuthModules()

Overrides:

getClientAuthModules in class JBossClientAuthConfig

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

Overrides:

getAuthContextID in class JBossClientAuthConfig

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.