Top Description Methods
javax.security.auth.message.module

public Interface ClientAuthModule

extends ClientAuth
Imports
java.util.Map, javax.security.auth.callback.CallbackHandler, javax.security.auth.message.AuthException, .ClientAuth, .MessagePolicy, javax.security.auth.message.config.ClientAuthContext

A ClientAuthModule secures request messages, and validates received response messages.

A module implementation should assume it may be used to secure different requests as different clients. A module should also assume it may be used concurrently by multiple callers. It is the module implementation's responsibility to properly save and restore any state as necessary. A module that does not need to do so may remain completely stateless.

Every implementation of the interface must provide a public zero argument constructor.

See Also
ClientAuthContext

Method Summary

Modifier and TypeMethod and Description
public Class<T>[]

Returns:

An array of Class objects where each element defines a message type supported by the module. A module should return an array containing at least one element. An empty array indicates that the module will attempt to support any message type. This method never returns null.
getSupportedMessageTypes
()

Get the one or more Class objects representing the message types supported by the module.

public void
initialize(MessagePolicy
The request policy this module must enforce, or null.
requestPolicy
,
MessagePolicy
The response policy this module must enforce, or null.
responsePolicy
,
CallbackHandler
CallbackHandler used to request information.
handler
,
Map<K, V>
A Map of module-specific configuration properties.
options
)

Initialize this module with request and response message policies to enforce, a CallbackHandler, and any module-specific configuration properties.

Inherited from javax.security.auth.message.ClientAuth:
cleanSubjectsecureRequestvalidateResponse

Method Detail

getSupportedMessageTypesback to summary
public Class<T>[] getSupportedMessageTypes()

Get the one or more Class objects representing the message types supported by the module.

Returns:Class<T>[]

An array of Class objects where each element defines a message type supported by the module. A module should return an array containing at least one element. An empty array indicates that the module will attempt to support any message type. This method never returns null.

initializeback to summary
public void initialize(MessagePolicy requestPolicy, MessagePolicy responsePolicy, CallbackHandler handler, Map<K, V> options) throws AuthException

Initialize this module with request and response message policies to enforce, a CallbackHandler, and any module-specific configuration properties.

The request policy and the response policy must not both be null.

Parameters
requestPolicy:MessagePolicy

The request policy this module must enforce, or null.

responsePolicy:MessagePolicy

The response policy this module must enforce, or null.

handler:CallbackHandler

CallbackHandler used to request information.

options:Map<K, V>

A Map of module-specific configuration properties.

Exceptions
AuthException:
If module initialization fails, including for the case where the options argument contains elements that are not supported by the module.