-
- All Superinterfaces:
- ClientAuth
public interface ClientAuthContext extends ClientAuth
This ClientAuthContext class encapsulates ClientAuthModules that are used to secure service requests made by a client, and to validate any responses received to those requests. A caller typically uses this class in the following manner:- Retrieve an instance of this class by using ClientAuthConfig.getAuthContext.
- Invoke secureRequest.
ClientAuthContext implementation invokes secureRequest of one or more encapsulated ClientAuthModules. Modules might attach credentials to request (for example, a user name and password), and/or secure the request (for example, sign and encrypt the request). - Send request and receive response.
- Invoke validateResponse.
ClientAuthContext implementation invokes validateResponse of one or more encapsulated ClientAuthModules. Modules verify or decrypt response as necessary. - Invoke cleanSubject method (as necessary) to clean up any authentication state in Subject.
A ClientAuthContext instance may be used concurrently by multiple callers.
Implementations of this interface are responsible for constructing and initializing the encapsulated modules. The initialization step includes passing the relevant request and response MessagePolicy objects to the encapsulated modules. The MessagePolicy objects are obtained by the ClientAuthConfig instance used to obtain the ClientAuthContext object. See
ClientAuthConfig.getAuthContext
for more information.Implementations of this interface are instantiated by their associated configuration object such that they know which modules to invoke, in what order, and how results returned by preceding modules are to influence subsequent module invocations.
Calls to the inherited methods of this interface delegate to the corresponding methods of the encapsulated authentication modules.
- See Also:
ClientAuthConfig
,ClientAuthModule
-
-
Method Summary
-
Methods inherited from interface javax.security.auth.message.ClientAuth
cleanSubject, secureRequest, validateResponse
-
-
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/config/clientauthcontext.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.