Class Saml2LogoutRequest
java.lang.Object
org.springframework.security.saml2.provider.service.authentication.logout.Saml2LogoutRequest
- All Implemented Interfaces:
Serializable
A class that represents a signed and serialized SAML 2.0 Logout Request
- Since:
- 5.6
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the binding for the asserting party's SingleLogoutServicegetId()
The unique identifier for this Logout RequestGet the location of the asserting party's SingleLogoutServicegetParameter
(String name) Get thename
parameters, a short-hand forgetParameters().get(name)
Useful when specifying additional query parameters for the Logout RequestGet all parameters Useful when specifying additional query parameters for the Logout RequestThe relay state associated with this Logout RequestThe identifier for theRelyingPartyRegistration
associated with this Logout RequestGet the signed and serialized <saml2:LogoutRequest> payloadstatic Saml2LogoutRequest.Builder
withRelyingPartyRegistration
(RelyingPartyRegistration registration) Create aSaml2LogoutRequest.Builder
instance from thisRelyingPartyRegistration
Specifically, this will pull the SingleLogoutService location and binding from theRelyingPartyRegistration
-
Method Details
-
getId
The unique identifier for this Logout Request- Returns:
- the Logout Request identifier
-
getLocation
Get the location of the asserting party's SingleLogoutService- Returns:
- the SingleLogoutService location
-
getBinding
Get the binding for the asserting party's SingleLogoutService- Returns:
- the SingleLogoutService binding
-
getSamlRequest
Get the signed and serialized <saml2:LogoutRequest> payload- Returns:
- the signed and serialized <saml2:LogoutRequest> payload
-
getRelayState
The relay state associated with this Logout Request- Returns:
- the relay state
-
getParameter
Get thename
parameters, a short-hand forgetParameters().get(name)
Useful when specifying additional query parameters for the Logout Request- Parameters:
name
- the parameter's name- Returns:
- the parameter's value
-
getParameters
Get all parameters Useful when specifying additional query parameters for the Logout Request- Returns:
- the Logout Request query parameters
-
getRelyingPartyRegistrationId
The identifier for theRelyingPartyRegistration
associated with this Logout Request- Returns:
- the
RelyingPartyRegistration
id
-
withRelyingPartyRegistration
public static Saml2LogoutRequest.Builder withRelyingPartyRegistration(RelyingPartyRegistration registration) Create aSaml2LogoutRequest.Builder
instance from thisRelyingPartyRegistration
Specifically, this will pull the SingleLogoutService location and binding from theRelyingPartyRegistration
- Parameters:
registration
- theRelyingPartyRegistration
to use- Returns:
- the
Saml2LogoutRequest.Builder
for further configurations
-