ServerAuthModulepublic interface ServerAuthModule | This interface describes a module that can be configured
for a ServerAuthContext. The main purpose of this module
is to validate client requests and to secure responses back to the client.
A module implementation must assume it may be shared
across different requests from different clients.
It is the module implementation's responsibility to properly
store and restore any state necessary to associate new requests
with previous responses. 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 validateRequest
to secureResponse 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 validateRequest.
| | 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 | secureResponse(AuthParam param, javax.security.auth.Subject subject, java.util.Map sharedState)Secure the response to the client
(sign and encrypt the response, for example).
| | public void | validateRequest(AuthParam param, javax.security.auth.Subject subject, java.util.Map sharedState)Authenticate a client request.
The AuthParam input parameter encapsulates the client request and
server response objects. This ServerAuthModule validates the client
request object (decrypts content and verifies a signature, for example).
|
|
