javax.security.auth.message.config

Interface ServerAuthConfig

All Superinterfaces:

AuthConfig

public interface ServerAuthConfig
extends AuthConfig

This interface describes a configuration of ServerAuthConfiguration objects for a message layer and application context (e.g., the messaging context of a specific application, or set of applications).

Implementations of this interface are returned by an AnthConfigProvider.

Callers interact with a ServerAuthConfig to obtain ServerAuthContext objects suitable for processing a given message exchange at the layer and within the application context of the ServerAuthConfig. Each ServerAuthContext object is responsible for instantiating, initializing, and invoking the one or more ServerAuthModules encapsulated in the ServerAuthContext.

After having acquired a ServerAuthContext, a caller operates on the context to cause it to invoke the encapsulated ServerAuthModules to validate service requests and to secure service responses.

Since:

May 12, 2006

Version:

$Revision$

Author:

Anil Saldhana, Charlie Lai, Ron Monzillo (Javadoc for JSR-196)

Method Summary

Methods

Modifier and Type	Method and Description
ServerAuthContext	getAuthContext(String authContextID, Subject serviceSubject, Map properties) Get a ServerAuthContext instance from this ServerAuthConfig.

Methods inherited from interface javax.security.auth.message.config.AuthConfig

getAppContext, getAuthContextID, getMessageLayer, isProtected, refresh

Method Detail

getAuthContext

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

Get a ServerAuthContext instance from this ServerAuthConfig.

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

Specifically, this method accesses this ServerAuthConfig object with the argument operation 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 module's responsibility to enforce these policies when invoked.

Parameters:

operation - an operation identifier used to index the provided config, or null. This value must be identical to the value returned by the getOperation method for all AuthParam objects passed to the validateRequest method of the returned ServerAuthContext.

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 operation, or null (indicating that no modules are configured).

Throws:

AuthException - if this operation fails.