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

Class Saml2LogoutRequest.Builder

java.lang.Object

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

Enclosing class:

Saml2LogoutRequest

public static final class Saml2LogoutRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Saml2LogoutRequest.Builder	binding(Saml2MessageBinding binding)	Use this SAML 2.0 Message Binding By default, the asserting party's configured binding is used
Saml2LogoutRequest	build()	Build the Saml2LogoutRequest
Saml2LogoutRequest.Builder	id(String id)	This is the unique id used in the samlRequest(java.lang.String)
Saml2LogoutRequest.Builder	location(String location)	Use this location for the SAML 2.0 logout endpoint By default, the asserting party's endpoint is used
Saml2LogoutRequest.Builder	parameters(Consumer<Map<String,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 request is sent
Saml2LogoutRequest.Builder	parametersQuery(Function<Map<String,String>,String> encoder)	Use this strategy for converting parameters into an encoded query string.
Saml2LogoutRequest.Builder	relayState(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 request is sent
Saml2LogoutRequest.Builder	samlRequest(String samlRequest)	Use this signed and serialized and Base64-encoded <saml2:LogoutRequest> 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 Details

samlRequest

public Saml2LogoutRequest.Builder samlRequest(String samlRequest)

Use this signed and serialized and Base64-encoded <saml2:LogoutRequest> 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 request is sent

Parameters:

samlRequest - the <saml2:LogoutRequest> to use

Returns:

the Saml2LogoutRequest.Builder for further configurations

See Also:

• Saml2LogoutRequestResolver

binding

public Saml2LogoutRequest.Builder binding(Saml2MessageBinding binding)

Use this SAML 2.0 Message Binding By default, the asserting party's configured binding is used

Parameters:

binding - the SAML 2.0 Message Binding to use

Returns:

the Saml2LogoutRequest.Builder for further configurations

location

public Saml2LogoutRequest.Builder location(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 Saml2LogoutRequest.Builder relayState(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 request is sent

Parameters:

relayState - the relay state

Returns:

the Saml2LogoutRequest.Builder for further configurations

id

public Saml2LogoutRequest.Builder id(String id)

This is the unique id used in the samlRequest(java.lang.String)

Parameters:

id - the Logout Request id

Returns:

the Saml2LogoutRequest.Builder for further configurations

parameters

public Saml2LogoutRequest.Builder parameters(Consumer<Map<String,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 request is sent

Parameters:

parametersConsumer - the Consumer

Returns:

the Saml2LogoutRequest.Builder for further configurations

parametersQuery

public Saml2LogoutRequest.Builder parametersQuery(Function<Map<String,String>,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

build

public Saml2LogoutRequest build()

Build the Saml2LogoutRequest

Returns:

a constructed Saml2LogoutRequest