public interface WSTrustRequestHandler
The WSTrustRequestHandler
interface defines the methods that will be responsible for handling the different
types of
WS-Trust request messages.
Modifier and Type | Method and Description |
---|---|
RequestSecurityTokenResponse |
cancel(RequestSecurityToken request,
Principal callerPrincipal)
Cancels the security token as specified in the request message.
|
void |
initialize(STSConfiguration configuration)
Initializes the concrete
WSTrustRequestHandler instance. |
RequestSecurityTokenResponse |
issue(RequestSecurityToken request,
Principal callerPrincipal)
Generates a security token according to the information specified in the request message and returns the created
token in
the response.
|
Document |
postProcess(Document rstrDocument,
RequestSecurityToken request)
Perform Post Processing on the generated RSTR Collection Document Steps such as signing and encryption need to
be
done
here.
|
RequestSecurityTokenResponse |
renew(RequestSecurityToken request,
Principal callerPrincipal)
Renews the security token as specified in the request message, returning the renewed token in the response.
|
RequestSecurityTokenResponse |
validate(RequestSecurityToken request,
Principal callerPrincipal)
Validates the security token as specified in the request message.
|
void initialize(STSConfiguration configuration)
Initializes the concrete WSTrustRequestHandler
instance.
configuration
- a reference to object that contains the STS configuration.RequestSecurityTokenResponse issue(RequestSecurityToken request, Principal callerPrincipal) throws WSTrustException
Generates a security token according to the information specified in the request message and returns the created token in the response.
request
- the security token request message.callerPrincipal
- the Principal
of the ws-trust token requester.RequestSecurityTokenResponse
containing the generated token.WSTrustException
- if an error occurs while handling the request message.RequestSecurityTokenResponse renew(RequestSecurityToken request, Principal callerPrincipal) throws WSTrustException
Renews the security token as specified in the request message, returning the renewed token in the response.
request
- the request message that contains the token to be renewed.callerPrincipal
- the Principal
of the ws-trust token requester.RequestSecurityTokenResponse
containing the renewed token.WSTrustException
- if an error occurs while handling the renewal process.RequestSecurityTokenResponse cancel(RequestSecurityToken request, Principal callerPrincipal) throws WSTrustException
Cancels the security token as specified in the request message.
request
- the request message that contains the token to be canceled.callerPrincipal
- the Principal
of the ws-trust token requester.RequestSecurityTokenResponse
indicating whether the token has been canceled or not.WSTrustException
- if an error occurs while handling the cancellation process.RequestSecurityTokenResponse validate(RequestSecurityToken request, Principal callerPrincipal) throws WSTrustException
Validates the security token as specified in the request message.
request
- the request message that contains the token to be validated.callerPrincipal
- the Principal
of the ws-trust token requester.RequestSecurityTokenResponse
containing the validation status or a new token.WSTrustException
- if an error occurs while handling the validation process.Document postProcess(Document rstrDocument, RequestSecurityToken request) throws WSTrustException
rstrDocument
- request
- WSTrustException
Copyright © 2020 JBoss by Red Hat. All rights reserved.