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

Class Saml2LogoutRequest

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

public final class Saml2LogoutRequest
extends java.lang.Object
implements java.io.Serializable

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

Since:

5.6

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Saml2LogoutRequest.Builder

Method Summary

Modifier and Type	Method	Description
Saml2MessageBinding	getBinding()	Get the binding for the asserting party's SingleLogoutService
java.lang.String	getId()	The unique identifier for this Logout Request
java.lang.String	getLocation()	Get the location of the asserting party's SingleLogoutService
java.lang.String	getParameter(java.lang.String name)	Get the name parameters, a short-hand for getParameters().get(name) Useful when specifying additional query parameters for the Logout Request
java.util.Map<java.lang.String,java.lang.String>	getParameters()	Get all parameters Useful when specifying additional query parameters for the Logout Request
java.lang.String	getParametersQuery()	Get an encoded query string of all parameters.
java.lang.String	getRelayState()	The relay state associated with this Logout Request
java.lang.String	getRelyingPartyRegistrationId()	The identifier for the RelyingPartyRegistration associated with this Logout Request
java.lang.String	getSamlRequest()	Get the signed and serialized <saml2:LogoutRequest> payload
static Saml2LogoutRequest.Builder	withRelyingPartyRegistration(RelyingPartyRegistration registration)	Create a Saml2LogoutRequest.Builder instance from this RelyingPartyRegistration Specifically, this will pull the SingleLogoutService 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

getId

public java.lang.String getId()

The unique identifier for this Logout Request

Returns:

the Logout Request identifier

getLocation

public java.lang.String getLocation()

Get the location of the asserting party's SingleLogoutService

Returns:

the SingleLogoutService location

getBinding

public Saml2MessageBinding getBinding()

Get the binding for the asserting party's SingleLogoutService

Returns:

the SingleLogoutService binding

getSamlRequest

public java.lang.String getSamlRequest()

Get the signed and serialized <saml2:LogoutRequest> payload

Returns:

the signed and serialized <saml2:LogoutRequest> 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 parameters, a short-hand for getParameters().get(name) Useful when specifying additional query parameters for the Logout Request

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 Request

Returns:

the Logout Request query parameters

getParametersQuery

public java.lang.String getParametersQuery()

Get an encoded query string of all parameters. Resulting query does not contain a leading question mark.

Returns:

an encoded string of all parameters

Since:

5.8

getRelyingPartyRegistrationId

public java.lang.String getRelyingPartyRegistrationId()

The identifier for the RelyingPartyRegistration associated with this Logout Request

Returns:

the RelyingPartyRegistration id

withRelyingPartyRegistration

public static Saml2LogoutRequest.Builder withRelyingPartyRegistration(RelyingPartyRegistration registration)

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

Parameters:

registration - the RelyingPartyRegistration to use

Returns:

the Saml2LogoutRequest.Builder for further configurations