org.picketlink.identity.federation.core.wstrust

Interface WSTrustRequestHandler

All Known Implementing Classes:

StandardRequestHandler

public interface WSTrustRequestHandler

The WSTrustRequestHandler interface defines the methods that will be responsible for handling the different types of WS-Trust request messages.

Author:

Stefan Guilhen

Method Summary

Methods

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.

Method Detail

initialize

void initialize(STSConfiguration configuration)

Initializes the concrete WSTrustRequestHandler instance.

Parameters:

configuration - a reference to object that contains the STS configuration.

issue

RequestSecurityTokenResponse issue(RequestSecurityToken request,
                                 Principal callerPrincipal)
                                   throws org.picketlink.common.exceptions.fed.WSTrustException

Generates a security token according to the information specified in the request message and returns the created token in the response.

Parameters:

request - the security token request message.

callerPrincipal - the Principal of the ws-trust token requester.

Returns:

a RequestSecurityTokenResponse containing the generated token.

Throws:

org.picketlink.common.exceptions.fed.WSTrustException - if an error occurs while handling the request message.

renew

RequestSecurityTokenResponse renew(RequestSecurityToken request,
                                 Principal callerPrincipal)
                                   throws org.picketlink.common.exceptions.fed.WSTrustException

Renews the security token as specified in the request message, returning the renewed token in the response.

Parameters:

request - the request message that contains the token to be renewed.

callerPrincipal - the Principal of the ws-trust token requester.

Returns:

a RequestSecurityTokenResponse containing the renewed token.

Throws:

org.picketlink.common.exceptions.fed.WSTrustException - if an error occurs while handling the renewal process.

cancel

RequestSecurityTokenResponse cancel(RequestSecurityToken request,
                                  Principal callerPrincipal)
                                    throws org.picketlink.common.exceptions.fed.WSTrustException

Cancels the security token as specified in the request message.

Parameters:

request - the request message that contains the token to be canceled.

callerPrincipal - the Principal of the ws-trust token requester.

Returns:

a RequestSecurityTokenResponse indicating whether the token has been canceled or not.

Throws:

org.picketlink.common.exceptions.fed.WSTrustException - if an error occurs while handling the cancellation process.

validate

RequestSecurityTokenResponse validate(RequestSecurityToken request,
                                    Principal callerPrincipal)
                                      throws org.picketlink.common.exceptions.fed.WSTrustException

Validates the security token as specified in the request message.

Parameters:

request - the request message that contains the token to be validated.

callerPrincipal - the Principal of the ws-trust token requester.

Returns:

a RequestSecurityTokenResponse containing the validation status or a new token.

Throws:

org.picketlink.common.exceptions.fed.WSTrustException - if an error occurs while handling the validation process.

postProcess

Document postProcess(Document rstrDocument,
                   RequestSecurityToken request)
                     throws org.picketlink.common.exceptions.fed.WSTrustException

Perform Post Processing on the generated RSTR Collection Document Steps such as signing and encryption need to be done here.

Parameters:

rstrDocument -

request -

Returns:

Throws:

org.picketlink.common.exceptions.fed.WSTrustException