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

Class Saml2LogoutResponse.Builder

  • Enclosing class:
    Saml2LogoutResponse
    public static final class Saml2LogoutResponse.Builder
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Saml2LogoutResponse.Builder binding​(Saml2MessageBinding binding)
      Use this SAML 2.0 Message Binding By default, the asserting party's configured binding is used
      Saml2LogoutResponse build()
      Build the Saml2LogoutResponse
      Saml2LogoutResponse.Builder location​(java.lang.String location)
      Use this location for the SAML 2.0 logout endpoint By default, the asserting party's endpoint is used
      Saml2LogoutResponse.Builder parameters​(java.util.function.Consumer<java.util.Map<java.lang.String,​java.lang.String>> parametersConsumer)
      Use this Consumer to modify the set of query parameters No parameter should be URL-encoded as this will be done when the response is sent, though any signature specified should be Base64-encoded
      Saml2LogoutResponse.Builder parametersQuery​(java.util.function.Function<java.util.Map<java.lang.String,​java.lang.String>,​java.lang.String> encoder)
      Use this strategy for converting parameters into an encoded query string.
      Saml2LogoutResponse.Builder relayState​(java.lang.String relayState)
      Use this value for the relay state when sending the Logout Request to the asserting party It should not be URL-encoded as this will be done when the response is sent
      Saml2LogoutResponse.Builder samlResponse​(java.lang.String samlResponse)
      Use this signed and serialized and Base64-encoded <saml2:LogoutResponse> Note that if using the Redirect binding, the value should be deflated and then Base64-encoded.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • samlResponse

        public Saml2LogoutResponse.Builder samlResponse​(java.lang.String samlResponse)
        Use this signed and serialized and Base64-encoded <saml2:LogoutResponse> Note that if using the Redirect binding, the value should be deflated and then Base64-encoded. It should not be URL-encoded as this will be done when the response is sent
        Parameters:
        samlResponse - the <saml2:LogoutResponse> to use
        Returns:
        the Saml2LogoutResponse.Builder for further configurations
        See Also:
        Saml2LogoutResponseResolver

      • location

        public Saml2LogoutResponse.Builder location​(java.lang.String location)
        Use this location for the SAML 2.0 logout endpoint By default, the asserting party's endpoint is used
        Parameters:
        location - the SAML 2.0 location to use
        Returns:
        the Saml2LogoutRequest.Builder for further configurations

      • relayState

        public Saml2LogoutResponse.Builder relayState​(java.lang.String relayState)
        Use this value for the relay state when sending the Logout Request to the asserting party It should not be URL-encoded as this will be done when the response is sent
        Parameters:
        relayState - the relay state
        Returns:
        the Saml2LogoutResponse.Builder for further configurations

      • parameters

        public Saml2LogoutResponse.Builder parameters​(java.util.function.Consumer<java.util.Map<java.lang.String,​java.lang.String>> parametersConsumer)
        Use this Consumer to modify the set of query parameters No parameter should be URL-encoded as this will be done when the response is sent, though any signature specified should be Base64-encoded
        Parameters:
        parametersConsumer - the Consumer
        Returns:
        the Saml2LogoutResponse.Builder for further configurations

      • parametersQuery

        public Saml2LogoutResponse.Builder parametersQuery​(java.util.function.Function<java.util.Map<java.lang.String,​java.lang.String>,​java.lang.String> encoder)
        Use this strategy for converting parameters into an encoded query string. The resulting query does not contain a leading question mark. In the event that you already have an encoded version that you want to use, you can call this by doing parameterEncoder((params) -> encodedValue).
        Parameters:
        encoder - the strategy to use
        Returns:
        the Saml2LogoutRequest.Builder for further configurations
        Since:
        5.8