-
- All Superinterfaces:
- ClientAuth
public interface ClientAuthModule extends 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 constructor.
- See Also:
ClientAuthContext
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description Class[]getSupportedMessageTypes()Get the one or more Class objects representing the message types supported by the module.voidinitialize(MessagePolicy requestPolicy, MessagePolicy responsePolicy, CallbackHandler handler, Map options)Initialize this module with request and response message policies to enforce, a CallbackHandler, and any module-specific configuration properties.-
Methods inherited from interface javax.security.auth.message.ClientAuth
cleanSubject, secureRequest, validateResponse
-
-
-
-
Method Detail
-
initialize
void initialize(MessagePolicy requestPolicy, MessagePolicy responsePolicy, CallbackHandler handler, Map 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- The request policy this module must enforce, or null.responsePolicy- The response policy this module must enforce, or null.handler- CallbackHandler used to request information.options- A Map of module-specific configuration properties.- Throws:
AuthException- If module initialization fails, including for the case where the options argument contains elements that are not supported by the module.
-
getSupportedMessageTypes
Class[] getSupportedMessageTypes()
Get the one or more Class objects representing the message types supported by the module.- 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.
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/security/auth/message/module/clientauthmodule.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.