Class Saml2LogoutRequest.Builder
java.lang.Object
org.springframework.security.saml2.provider.service.authentication.logout.Saml2LogoutRequest.Builder
- Enclosing class:
- Saml2LogoutRequest
-
Method Summary
Modifier and TypeMethodDescriptionbinding
(Saml2MessageBinding binding) Use this SAML 2.0 Message Binding By default, the asserting party's configured binding is usedbuild()
Build theSaml2LogoutRequest
This is the unique id used in thesamlRequest(java.lang.String)
Use this location for the SAML 2.0 logout endpoint By default, the asserting party's endpoint is usedparameters
(Consumer<Map<String, String>> parametersConsumer) Use thisConsumer
to modify the set of query parameters No parameter should be URL-encoded as this will be done when the request is sentUse this strategy for converting parameters into an encoded query string.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 sentsamlRequest
(String samlRequest) Use this signed and serialized and Base64-encoded <saml2:LogoutRequest> Note that if using the Redirect binding, the value should bedeflated
and then Base64-encoded.
-
Method Details
-
samlRequest
Use this signed and serialized and Base64-encoded <saml2:LogoutRequest> Note that if using the Redirect binding, the value should bedeflated
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:
-
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
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
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
This is the unique id used in thesamlRequest(java.lang.String)
- Parameters:
id
- the Logout Request id- Returns:
- the
Saml2LogoutRequest.Builder
for further configurations
-
parameters
Use thisConsumer
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
- theConsumer
- Returns:
- the
Saml2LogoutRequest.Builder
for further configurations
-
parametersQuery
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 doingparameterEncoder((params) -> encodedValue)
.- Parameters:
encoder
- the strategy to use- Returns:
- the
Saml2LogoutRequest.Builder
for further configurations - Since:
- 5.8
-
build
Build theSaml2LogoutRequest
- Returns:
- a constructed
Saml2LogoutRequest
-