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 java.lang.Object
-
-
Method Summary
All Methods Instance Methods Concrete Methods 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 usedSaml2LogoutRequest
build()
Build theSaml2LogoutRequest
Saml2LogoutRequest.Builder
id(java.lang.String id)
This is the unique id used in thesamlRequest(java.lang.String)
Saml2LogoutRequest.Builder
location(java.lang.String location)
Use this location for the SAML 2.0 logout endpoint By default, the asserting party's endpoint is usedSaml2LogoutRequest.Builder
parameters(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.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 sentSaml2LogoutRequest.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 request is sentSaml2LogoutRequest.Builder
samlRequest(java.lang.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 Detail
-
samlRequest
public Saml2LogoutRequest.Builder samlRequest(java.lang.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. 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(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 Saml2LogoutRequest.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 request is sent- Parameters:
relayState
- the relay state- Returns:
- the
Saml2LogoutRequest.Builder
for further configurations
-
id
public Saml2LogoutRequest.Builder id(java.lang.String 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
public Saml2LogoutRequest.Builder parameters(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.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 sent- Parameters:
parametersConsumer
- theConsumer
- Returns:
- the
Saml2LogoutRequest.Builder
for further configurations
-
build
public Saml2LogoutRequest build()
Build theSaml2LogoutRequest
- Returns:
- a constructed
Saml2LogoutRequest
-
-