public class SimpleClientAuthModule extends Object implements ClientAuthModule
Constructor and Description |
---|
SimpleClientAuthModule(Class[] supportedTypes) |
Modifier and Type | Method and Description |
---|---|
void |
cleanSubject(MessageInfo messageInfo,
Subject subject)
Remove implementation specific principals and credentials from the subject.
|
Class[] |
getSupportedMessageTypes()
Get the one or more Class objects representing the message types supported by the module.
|
void |
initialize(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.
|
AuthStatus |
secureRequest(MessageInfo param,
Subject source)
Secure a service request message before sending it to the service.
|
AuthStatus |
validateResponse(MessageInfo messageInfo,
Subject source,
Subject recipient)
Validate a received service response.
|
public SimpleClientAuthModule(Class[] supportedTypes)
public void initialize(MessagePolicy requestPolicy, MessagePolicy responsePolicy, CallbackHandler handler, Map options) throws AuthException
ClientAuthModule
The request policy and the response policy must not both be null.
initialize
in interface ClientAuthModule
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.AuthException
- If module initialization fails, including for the case where the options argument contains
elements that are not supported by the module.ClientAuthModule.initialize(javax.security.auth.message.MessagePolicy, javax.security.auth.message.MessagePolicy, javax.security.auth.callback.CallbackHandler, java.util.Map)
public AuthStatus secureRequest(MessageInfo param, Subject source) throws AuthException
ClientAuth
This method is called to transform the request message acquired by calling getRequestMessage (on messageInfo) into the mechanism-specific form to be sent by the runtime.
This method conveys the outcome of its message processing either by returning an AuthStatus value or by throwing an AuthException.
secureRequest
in interface ClientAuth
param
- A contextual object that encapsulates the client request and server response objects, and that may
be used to save state across a sequence of calls made to the methods of this interface for the purpose of completing
a secure message exchange.source
- A Subject that represents the source of the service request, or null. It may be used by the
method implementation as the source of Principals or credentials to be used to secure the request. If the Subject is
not null, the method implementation may add additional Principals or credentials (pertaining to the source of the
service request) to the Subject.validateResponse
must be able to
obtain the original application request message.
AuthException
- When the message processing failed without establishing a failure response message (in
messageInfo).ClientAuth.secureRequest(javax.security.auth.message.MessageInfo, javax.security.auth.Subject)
public AuthStatus validateResponse(MessageInfo messageInfo, Subject source, Subject recipient) throws AuthException
ClientAuth
This method is called to transform the mechanism-specific response message acquired by calling getResponseMessage (on messageInfo) into the validated application message to be returned to the message processing runtime. If the response message is a (mechanism-specific) meta-message, the method implementation must attempt to transform the meta-message into the next mechanism-specific request message to be sent by the runtime.
This method conveys the outcome of its message processing either by returning an AuthStatus value or by throwing an AuthException.
validateResponse
in interface ClientAuth
messageInfo
- A contextual object that encapsulates the client request and server response objects, and that may
be used to save state across a sequence of calls made to the methods of this interface for the purpose of completing
a secure message exchange.source
- A Subject that represents the recipient of the service response, or null. It may be used by the
method implementation as the source of Principals or credentials to be used to validate the response. If the Subject
is not null, the method implementation may add additional Principals or credentials (pertaining to the recipient of
the service request) to the Subject.recipient
- A Subject that represents the source of the service response, or null. If the Subject is not
null, the method implementation may add additional Principals or credentials (pertaining to the source of the service
response) to the Subject.AuthException
- When the message processing failed without establishing a failure response message (in
messageInfo).ClientAuth.validateResponse(javax.security.auth.message.MessageInfo, javax.security.auth.Subject, javax.security.auth.Subject)
public Class[] getSupportedMessageTypes()
ClientAuthModule
getSupportedMessageTypes
in interface ClientAuthModule
ClientAuthModule.getSupportedMessageTypes()
public void cleanSubject(MessageInfo messageInfo, Subject subject) throws AuthException
ClientAuth
cleanSubject
in interface ClientAuth
messageInfo
- A contextual object that encapsulates the client request and server response objects, and that may
be used to save state across a sequence of calls made to the methods of this interface for the purpose of completing
a secure message exchange.subject
- The Subject instance from which the Principals and credentials are to be removed.AuthException
- If an error occurs during the Subject processing.ClientAuth.cleanSubject(javax.security.auth.message.MessageInfo, javax.security.auth.Subject)
Copyright © 2021 JBoss by Red Hat. All rights reserved.