Class Saml2LogoutResponse
java.lang.Object
org.springframework.security.saml2.provider.service.authentication.logout.Saml2LogoutResponse
A class that represents a signed and serialized SAML 2.0 Logout Response
- Since:
- 5.6
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the binding for the asserting party's SingleLogoutServicegetParameter
(String name) Get thename
parameter, a short-hand forgetParameters().get(name)
Useful when specifying additional query parameters for the Logout ResponseGet all parameters Useful when specifying additional query parameters for the Logout ResponseGet an encoded query string of all parameters.The relay state associated with this Logout RequestGet the response location of the asserting party's SingleLogoutServiceGet the signed and serialized <saml2:LogoutResponse> payloadstatic Saml2LogoutResponse.Builder
withRelyingPartyRegistration
(RelyingPartyRegistration registration) Create aSaml2LogoutResponse.Builder
instance from thisRelyingPartyRegistration
Specifically, this will pull the SingleLogoutService response location and binding from theRelyingPartyRegistration
-
Method Details
-
getResponseLocation
Get the response location of the asserting party's SingleLogoutService- Returns:
- the SingleLogoutService response location
-
getBinding
Get the binding for the asserting party's SingleLogoutService- Returns:
- the SingleLogoutService binding
-
getSamlResponse
Get the signed and serialized <saml2:LogoutResponse> payload- Returns:
- the signed and serialized <saml2:LogoutResponse> payload
-
getRelayState
The relay state associated with this Logout Request- Returns:
- the relay state
-
getParameter
Get thename
parameter, a short-hand forgetParameters().get(name)
Useful when specifying additional query parameters for the Logout Response- Parameters:
name
- the parameter's name- Returns:
- the parameter's value
-
getParameters
Get all parameters Useful when specifying additional query parameters for the Logout Response- Returns:
- the Logout Response query parameters
-
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 aSaml2LogoutResponse.Builder
instance from thisRelyingPartyRegistration
Specifically, this will pull the SingleLogoutService response location and binding from theRelyingPartyRegistration
- Parameters:
registration
- theRelyingPartyRegistration
to use- Returns:
- the
Saml2LogoutResponse.Builder
for further configurations
-