File Doc Category Size Date Package
ClientAuthModule.java API Doc Glassfish v2 API 4393 Fri May 04 22:36:12 BST 2007 javax.security.auth.message.module

ClientAuthModule

public interface ClientAuthModule implements ClientAuth

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 contructor.

version: %I%, %G%
see: ClientAuthContext

Fields Summary
Constructors Summary
Methods Summary
public java.lang.Class[] getSupportedMessageTypes()
Get the one or more Class objects representing the message types supported by the module.
return
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.
public void initialize(MessagePolicy requestPolicy, MessagePolicy responsePolicy, javax.security.auth.callback.CallbackHandler handler, java.util.Map options)
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.
param
requestPolicy The request policy this module must enforce, or null.
param
responsePolicy The response policy this module must enforce, or null.
param
handler CallbackHandler used to request information.
param
options A Map of module-specific configuration properties.
exception
AuthException If module initialization fails, including for the case where the options argument contains elements that are not supported by the module.