Package org.springframework.security.saml2.provider.service.authentication.logout

Class Saml2LogoutResponse

java.lang.Object

org.springframework.security.saml2.provider.service.authentication.logout.Saml2LogoutResponse

public final class Saml2LogoutResponse
extends java.lang.Object

A class that represents a signed and serialized SAML 2.0 Logout Response

Since:

5.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Saml2LogoutResponse.Builder

Method Summary

Modifier and Type	Method	Description
Saml2MessageBinding	getBinding()	Get the binding for the asserting party's SingleLogoutService
java.lang.String	getParameter(java.lang.String name)	Get the name parameter, a short-hand for getParameters().get(name) Useful when specifying additional query parameters for the Logout Response
java.util.Map<java.lang.String,java.lang.String>	getParameters()	Get all parameters Useful when specifying additional query parameters for the Logout Response
java.lang.String	getRelayState()	The relay state associated with this Logout Request
java.lang.String	getResponseLocation()	Get the response location of the asserting party's SingleLogoutService
java.lang.String	getSamlResponse()	Get the signed and serialized <saml2:LogoutResponse> payload
static Saml2LogoutResponse.Builder	withRelyingPartyRegistration(RelyingPartyRegistration registration)	Create a Saml2LogoutResponse.Builder instance from this RelyingPartyRegistration Specifically, this will pull the SingleLogoutService response location and binding from the RelyingPartyRegistration

Methods inherited from class java.lang.Object

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

Method Detail

getResponseLocation

public java.lang.String getResponseLocation()

Get the response location of the asserting party's SingleLogoutService

Returns:

the SingleLogoutService response location

getBinding

public Saml2MessageBinding getBinding()

Get the binding for the asserting party's SingleLogoutService

Returns:

the SingleLogoutService binding

getSamlResponse

public java.lang.String getSamlResponse()

Get the signed and serialized <saml2:LogoutResponse> payload

Returns:

the signed and serialized <saml2:LogoutResponse> payload

getRelayState

public java.lang.String getRelayState()

The relay state associated with this Logout Request

Returns:

the relay state

getParameter

public java.lang.String getParameter(java.lang.String name)

Get the name parameter, a short-hand for getParameters().get(name) Useful when specifying additional query parameters for the Logout Response

Parameters:

name - the parameter's name

Returns:

the parameter's value

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Get all parameters Useful when specifying additional query parameters for the Logout Response

Returns:

the Logout Response query parameters

withRelyingPartyRegistration

public static Saml2LogoutResponse.Builder withRelyingPartyRegistration(RelyingPartyRegistration registration)

Create a Saml2LogoutResponse.Builder instance from this RelyingPartyRegistration Specifically, this will pull the SingleLogoutService response location and binding from the RelyingPartyRegistration

Parameters:

registration - the RelyingPartyRegistration to use

Returns:

the Saml2LogoutResponse.Builder for further configurations