Package org.pac4j.saml.logout.impl

Class SAML2LogoutValidator

java.lang.Object

org.pac4j.saml.profile.impl.AbstractSAML2ResponseValidator

org.pac4j.saml.logout.impl.SAML2LogoutValidator

All Implemented Interfaces:

SAML2ResponseValidator

public class SAML2LogoutValidator
extends AbstractSAML2ResponseValidator

Validator for SAML logout requests/responses from the IdP.

Since:

2.0.0

Author:

Matthieu Taggiasco, Jerome Leleu

Field Summary

Fields inherited from class org.pac4j.saml.profile.impl.AbstractSAML2ResponseValidator

acceptedSkew, decrypter, logger, logoutHandler, replayCache, signatureTrustEngineProvider, uriComparator

Constructor Summary

Constructors

Constructor	Description
SAML2LogoutValidator(SAML2SignatureTrustEngineProvider engine, org.opensaml.saml.saml2.encryption.Decrypter decrypter, org.pac4j.core.logout.handler.LogoutHandler logoutHandler, java.lang.String postLogoutURL, ReplayCacheProvider replayCache, net.shibboleth.utilities.java.support.net.URIComparator uriComparator)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getExpectedDestination()
java.lang.String	getPostLogoutURL()
protected org.pac4j.core.exception.http.HttpAction	handlePostLogoutResponse(SAML2MessageContext context)
boolean	isActionOnSuccess()
void	setActionOnSuccess(boolean actionOnSuccess)
void	setExpectedDestination(java.lang.String expectedDestination)
void	setIsPartialLogoutTreatedAsSuccess(boolean isPartialLogoutTreatedAsSuccess)
void	setPostLogoutURL(java.lang.String postLogoutURL)
org.pac4j.core.credentials.Credentials	validate(SAML2MessageContext context)	Validates the SAML protocol logout request/response.
protected void	validateDestinationEndpoint(org.opensaml.saml.saml2.core.LogoutResponse logoutResponse, SAML2MessageContext context)
protected void	validateLogoutRequest(org.opensaml.saml.saml2.core.LogoutRequest logoutRequest, SAML2MessageContext context, org.opensaml.xmlsec.signature.support.SignatureTrustEngine engine)	Validates the SAML logout request.
protected void	validateLogoutResponse(org.opensaml.saml.saml2.core.LogoutResponse logoutResponse, SAML2MessageContext context, org.opensaml.xmlsec.signature.support.SignatureTrustEngine engine)	Validates the SAML logout response.
protected void	validateSuccess(org.opensaml.saml.saml2.core.Status status)	Validates that the response is a success.

Methods inherited from class org.pac4j.saml.profile.impl.AbstractSAML2ResponseValidator

compareEndpoints, computeSloKey, decryptEncryptedId, isDateValid, isIssueInstantValid, setAcceptedSkew, validateIssueInstant, validateIssuer, validateIssuerIfItExists, validateSignature, validateSignatureIfItExists, verifyEndpoint, verifyMessageReplay

Methods inherited from class java.lang.Object

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

Constructor Detail

SAML2LogoutValidator

public SAML2LogoutValidator(SAML2SignatureTrustEngineProvider engine,
                            org.opensaml.saml.saml2.encryption.Decrypter decrypter,
                            org.pac4j.core.logout.handler.LogoutHandler logoutHandler,
                            java.lang.String postLogoutURL,
                            ReplayCacheProvider replayCache,
                            net.shibboleth.utilities.java.support.net.URIComparator uriComparator)

Method Detail

validate

public org.pac4j.core.credentials.Credentials validate(SAML2MessageContext context)

Validates the SAML protocol logout request/response.

Parameters:

context - the context

Returns:

the SAML credentials

handlePostLogoutResponse

protected org.pac4j.core.exception.http.HttpAction handlePostLogoutResponse(SAML2MessageContext context)

validateLogoutRequest

protected void validateLogoutRequest(org.opensaml.saml.saml2.core.LogoutRequest logoutRequest,
                                     SAML2MessageContext context,
                                     org.opensaml.xmlsec.signature.support.SignatureTrustEngine engine)

Validates the SAML logout request.

Parameters:

logoutRequest - the logout request

context - the context

engine - the signature engine

validateLogoutResponse

protected void validateLogoutResponse(org.opensaml.saml.saml2.core.LogoutResponse logoutResponse,
                                      SAML2MessageContext context,
                                      org.opensaml.xmlsec.signature.support.SignatureTrustEngine engine)

Validates the SAML logout response.

Parameters:

logoutResponse - the logout response

context - the context

engine - the signature engine

validateDestinationEndpoint

protected void validateDestinationEndpoint(org.opensaml.saml.saml2.core.LogoutResponse logoutResponse,
                                           SAML2MessageContext context)

validateSuccess

protected void validateSuccess(org.opensaml.saml.saml2.core.Status status)

Description copied from class: AbstractSAML2ResponseValidator

Validates that the response is a success.

Overrides:

validateSuccess in class AbstractSAML2ResponseValidator

Parameters:

status - the response status.

setActionOnSuccess

public void setActionOnSuccess(boolean actionOnSuccess)

setPostLogoutURL

public void setPostLogoutURL(java.lang.String postLogoutURL)

setExpectedDestination

public void setExpectedDestination(java.lang.String expectedDestination)

setIsPartialLogoutTreatedAsSuccess

public void setIsPartialLogoutTreatedAsSuccess(boolean isPartialLogoutTreatedAsSuccess)

getPostLogoutURL

public java.lang.String getPostLogoutURL()

isActionOnSuccess

public boolean isActionOnSuccess()

getExpectedDestination

public java.lang.String getExpectedDestination()