Class Saml2LogoutResponse

java.lang.Object
org.springframework.security.saml2.provider.service.authentication.logout.Saml2LogoutResponse
public final class Saml2LogoutResponse extends Object
A class that represents a signed and serialized SAML 2.0 Logout Response
Since:
5.6

  • Method Details

    • getResponseLocation

      public 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 String getSamlResponse()
      Get the signed and serialized <saml2:LogoutResponse> payload
      Returns:
      the signed and serialized <saml2:LogoutResponse> 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 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 Map<String,String> getParameters()
      Get all parameters Useful when specifying additional query parameters for the Logout Response
      Returns:
      the Logout Response 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

    • 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