Class Saml2LogoutRequest

java.lang.Object
org.springframework.security.saml2.provider.service.authentication.logout.Saml2LogoutRequest
All Implemented Interfaces:
Serializable
public final class Saml2LogoutRequest extends Object implements Serializable
A class that represents a signed and serialized SAML 2.0 Logout Request
Since:
5.6
See Also:

  • Method Details

    • getId

      public @Nullable String getId()
      The unique identifier for this Logout Request
      Returns:
      the Logout Request identifier

    • getLocation

      public 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 String getSamlRequest()
      Get the signed and serialized <saml2:LogoutRequest> payload
      Returns:
      the signed and serialized <saml2:LogoutRequest> payload

    • getRelayState

      public @Nullable String getRelayState()
      The relay state associated with this Logout Request
      Returns:
      the relay state

    • getParameter

      public @Nullable String getParameter(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 Map<String,String> getParameters()
      Get all parameters Useful when specifying additional query parameters for the Logout Request
      Returns:
      the Logout Request query parameters

    • getParametersQuery

      public @Nullable 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 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