org.picketlink.identity.federation.core.saml.workflow

Class ServiceProviderSAMLWorkflow

java.lang.Object

org.picketlink.identity.federation.core.saml.workflow.ServiceProviderSAMLWorkflow

public class ServiceProviderSAMLWorkflow
extends Object

Common methods used by the SAML Service Provider

Since:

December 03, 2013

Author:

Anil Saldhana

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceProviderSAMLWorkflow.RedirectionHandler Class that handles the web container specific behavior for POST and REDIRECT workflows

Constructor Summary

Constructors

Constructor and Description
ServiceProviderSAMLWorkflow()

Method Summary

Modifier and Type	Method and Description
boolean	isGlobalLogout(HttpServletRequest request) Indicates if the current request is a GlobalLogout request.
boolean	isLocalLogoutRequest(HttpServletRequest request) Verify whether a HttpServletRequest is for Local Logout
void	sendHttpPostBindingRequest(String destination, Document samlDocument, String relayState, HttpServletResponse response, boolean willSendRequest) Sends a HTTP POST request to the IDP.
void	sendHttpRedirectRequest(String destination, Document samlDocument, String relayState, HttpServletResponse response, boolean willSendRequest, String destinationQueryStringWithSignature) Sends a HTTP Redirect request to the IDP.
void	sendRequestToIDP(String destination, Document samlDocument, String relayState, HttpServletResponse response, boolean willSendRequest, String destinationQueryStringWithSignature, boolean httpPostBinding) Send the request to the IDP.
void	sendToLogoutPage(HttpServletRequest request, HttpServletResponse response, HttpSession session, ServletContext servletContext, String logOutPage)
ServiceProviderSAMLWorkflow	setRedirectionHandler(ServiceProviderSAMLWorkflow.RedirectionHandler theHandler) Set a web container specific ServiceProviderSAMLWorkflow.RedirectionHandler
boolean	validate(HttpServletRequest request) Perform validation of the request object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceProviderSAMLWorkflow

public ServiceProviderSAMLWorkflow()

Method Detail

setRedirectionHandler

public ServiceProviderSAMLWorkflow setRedirectionHandler(ServiceProviderSAMLWorkflow.RedirectionHandler theHandler)

Set a web container specific ServiceProviderSAMLWorkflow.RedirectionHandler

Parameters:

theHandler -

Returns:

ServiceProviderSAMLWorkflow for chaining methods

validate

public boolean validate(HttpServletRequest request)

Perform validation of the request object

Parameters:

request -

Returns:

isGlobalLogout

public boolean isGlobalLogout(HttpServletRequest request)

Indicates if the current request is a GlobalLogout request.

Parameters:

request -

Returns:

isLocalLogoutRequest

public boolean isLocalLogoutRequest(HttpServletRequest request)

Verify whether a HttpServletRequest is for Local Logout

Parameters:

request -

Returns:

sendToLogoutPage

public void sendToLogoutPage(HttpServletRequest request,
                             HttpServletResponse response,
                             HttpSession session,
                             ServletContext servletContext,
                             String logOutPage)
                      throws IOException,
                             ServletException

Throws:

IOException

ServletException

sendRequestToIDP

public void sendRequestToIDP(String destination,
                             Document samlDocument,
                             String relayState,
                             HttpServletResponse response,
                             boolean willSendRequest,
                             String destinationQueryStringWithSignature,
                             boolean httpPostBinding)
                      throws ProcessingException,
                             ConfigurationException,
                             IOException

Send the request to the IDP. Subclasses should override this method to implement how requests must be sent to the IDP.

Parameters:

destination - idp url

samlDocument - request or response document

relayState -

response -

willSendRequest - are we sending Request or Response to IDP

destinationQueryStringWithSignature - used only with Redirect binding and with signature enabled.

httpPostBinding -

Throws:

ProcessingException

ConfigurationException

IOException

sendHttpRedirectRequest

public void sendHttpRedirectRequest(String destination,
                                    Document samlDocument,
                                    String relayState,
                                    HttpServletResponse response,
                                    boolean willSendRequest,
                                    String destinationQueryStringWithSignature)
                             throws IOException,
                                    ProcessingException,
                                    ConfigurationException

Sends a HTTP Redirect request to the IDP.

Parameters:

destination -

relayState -

response -

willSendRequest -

destinationQueryStringWithSignature -

Throws:

IOException

UnsupportedEncodingException

ConfigurationException

ProcessingException

sendHttpPostBindingRequest

public void sendHttpPostBindingRequest(String destination,
                                       Document samlDocument,
                                       String relayState,
                                       HttpServletResponse response,
                                       boolean willSendRequest)
                                throws ProcessingException,
                                       IOException,
                                       ConfigurationException

Sends a HTTP POST request to the IDP.

Parameters:

destination -

samlDocument -

relayState -

response -

willSendRequest -

Throws:

TrustKeyProcessingException

ProcessingException

IOException

ConfigurationException