org.wso2.appserver.webapp.security.saml

Class SAML2SSOManager

java.lang.Object

org.wso2.appserver.webapp.security.saml.SAML2SSOManager

public class SAML2SSOManager
extends Object

This class manages the generation of varied request and response types that are utilized within the SAML 2.0 single-sign-on (SSO) and single-logout (SLO) processes.

Since:

6.0.0

Constructor Summary

Constructors

Constructor and Description
SAML2SSOManager(WebAppSingleSignOn context)

Method Summary

Modifier and Type	Method and Description
String	handleAuthenticationRequestForPOSTBinding(org.apache.catalina.connector.Request request) Handles a SAML 2.0 Authentication Request (AuthnRequest) for HTTP POST binding.
String	handleAuthenticationRequestForRedirectBinding(org.apache.catalina.connector.Request request) Handles a SAML 2.0 Authentication Request (AuthnRequest) for HTTP Redirect binding.
String	handleLogoutRequestForPOSTBinding(org.apache.catalina.connector.Request request) Handles a SAML 2.0 Logout Request (LogoutRequest) for SAML 2.0 HTTP POST binding.
String	handleLogoutRequestForRedirectBinding(org.apache.catalina.connector.Request request) Handles a SAML 2.0 Logout Request (LogoutRequest) for SAML 2.0 HTTP Redirect binding.
void	processResponse(org.apache.catalina.connector.Request request) Processes a SAML 2.0 response depending on its type, either a SAML 2.0 Response for a single-sign-on (SSO) SAML 2.0 Request by the client application or a SAML 2.0 Response for a single-logout (SLO) SAML 2.0 Request from a service provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

SAML2SSOManager

public SAML2SSOManager(WebAppSingleSignOn context)
                throws SSOException

Throws:

SSOException

Method Detail

handleAuthenticationRequestForPOSTBinding

public String handleAuthenticationRequestForPOSTBinding(org.apache.catalina.connector.Request request)
                                                 throws SSOException

Handles a SAML 2.0 Authentication Request (AuthnRequest) for HTTP POST binding.

Parameters:

request - the HTTP servlet request with SAML 2.0 message

Returns:

the HTML payload to be transmitted

Throws:

SSOException - if an error occurs when handling AuthnRequest

handleAuthenticationRequestForRedirectBinding

public String handleAuthenticationRequestForRedirectBinding(org.apache.catalina.connector.Request request)
                                                     throws SSOException

Handles a SAML 2.0 Authentication Request (AuthnRequest) for HTTP Redirect binding.

Parameters:

request - the HTTP servlet request with SAML 2.0 message

Returns:

the Identity Provider URL with the query string appended based on the SAML 2.0 Request and configurations

Throws:

SSOException - if an error occurs when handling AuthnRequest

handleLogoutRequestForPOSTBinding

public String handleLogoutRequestForPOSTBinding(org.apache.catalina.connector.Request request)
                                         throws SSOException

Handles a SAML 2.0 Logout Request (LogoutRequest) for SAML 2.0 HTTP POST binding.

Parameters:

request - the HTTP servlet request with SAML 2.0 message

Returns:

the HTML payload to be transmitted

Throws:

SSOException - if an error occurs when handling LogoutRequest

handleLogoutRequestForRedirectBinding

public String handleLogoutRequestForRedirectBinding(org.apache.catalina.connector.Request request)
                                             throws SSOException

Handles a SAML 2.0 Logout Request (LogoutRequest) for SAML 2.0 HTTP Redirect binding.

Parameters:

request - the HTTP servlet request with SAML message

Returns:

the Identity Provider URL with the query string appended based on the SAML 2.0 Request and configurations

Throws:

SSOException - if an error occurs when handling LogoutRequest

processResponse

public void processResponse(org.apache.catalina.connector.Request request)
                     throws SSOException

Processes a SAML 2.0 response depending on its type, either a SAML 2.0 Response for a single-sign-on (SSO) SAML 2.0 Request by the client application or a SAML 2.0 Response for a single-logout (SLO) SAML 2.0 Request from a service provider.

Parameters:

request - the servlet request processed

Throws:

SSOException - if SAML 2.0 response is null