org.jboss.security.auth.message.config

Class JBossServerAuthConfig

java.lang.Object

org.jboss.security.auth.message.config.JBossServerAuthConfig

All Implemented Interfaces:

AuthConfig, ServerAuthConfig

Direct Known Subclasses:

JBossWSServerAuthConfig

public class JBossServerAuthConfig
extends Object
implements ServerAuthConfig

Provides configuration for the server side

Since:

May 15, 2006

Version:

$Revision$

Author:

Anil Saldhana

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getAppContext() Get the application context identifier of this authentication context configuration object.
ServerAuthContext	getAuthContext(String authContextID, Subject serviceSubject, Map properties) Get a ServerAuthContext instance from this ServerAuthConfig.
String	getAuthContextID(MessageInfo messageInfo) Get the authentication context identifier corresponding to the request and response objects encapsulated in messageInfo.
String	getMessageLayer() Get the message layer name of this authentication context configuration object.
List	getServerAuthModules()
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

JBossServerAuthConfig

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

Create a new JBossServerAuthConfig.

Parameters:

layer - Message Layer

appContext - Application Context

handler - Callback Handler that will be passed to the modules

properties - Context Properties

Method Detail

getAuthContext

public ServerAuthContext getAuthContext(String authContextID,
                                        Subject serviceSubject,
                                        Map properties)
                                 throws AuthException

Description copied from interface: ServerAuthConfig

Get a ServerAuthContext instance from this ServerAuthConfig.

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

Specifically, this method accesses this ServerAuthConfig object with the argument authContextID to determine the ServerAuthModules that are to be encapsulated in the returned ServerAuthContext instance.

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

Specified by:

getAuthContext in interface ServerAuthConfig

Parameters:

authContextID - An 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 validateRequest method of the returned ServerAuthContext.

serviceSubject - A Subject that represents the source of the service response to be secured by the acquired authentication context. The principal 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 response) 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 ServerAuthContext instance that encapsulates the ServerAuthModules 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:

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

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.

See Also:

AuthConfig.getAppContext()

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()

getServerAuthModules

public List getServerAuthModules()

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.