ClientAuthModulepublic interface ClientAuthModule | This interface describes a module that can be configured
for a ClientAuthContext. The main purpose of this module
is to secure requests and to validate received responses.
A module implementation must assume it may be used
to issue different requests as different clients.
It is the module implementation's responsibility to properly
store and restore any state as necessary.
A module that does not need to do so
may remain completely stateless.
Modules are passed a shared state Map that can be used
to save state across a sequence of calls from secureRequest
to validateResponse to disposeSubject.
The same Map instance is guaranteed to be passed to all methods
in the call sequence. Furthermore, it should be assumed that
each call sequence is passed its own unique shared state Map instance. |
| Methods Summary |
|---|
| public void | disposeSubject(javax.security.auth.Subject subject, java.util.Map sharedState)Dispose of the Subject.
Remove Principals or credentials from the Subject object
that were stored during validateResponse.
| | public void | initialize(AuthPolicy requestPolicy, AuthPolicy responsePolicy, javax.security.auth.callback.CallbackHandler handler, java.util.Map options)Initialize this module with a policy to enforce,
a CallbackHandler, and administrative options.
Either the the request policy or the response policy (or both)
must be non-null.
| | public void | secureRequest(AuthParam param, javax.security.auth.Subject subject, java.util.Map sharedState)Secure a request message.
Attach authentication credentials to an initial request,
sign/encrypt a request, or respond to a server challenge, for example.
| | public void | validateResponse(AuthParam param, javax.security.auth.Subject subject, java.util.Map sharedState)Validate received response.
Validation may include verifying signature in response,
or decrypting response contents, for example.
|
|
