Class Saml2LogoutResponse
- java.lang.Object
-
- org.springframework.security.saml2.provider.service.authentication.logout.Saml2LogoutResponse
-
public final class Saml2LogoutResponse extends java.lang.Object
A class that represents a signed and serialized SAML 2.0 Logout Response- Since:
- 5.6
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Saml2LogoutResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Saml2MessageBinding
getBinding()
Get the binding for the asserting party's SingleLogoutServicejava.lang.String
getParameter(java.lang.String name)
Get thename
parameter, a short-hand forgetParameters().get(name)
Useful when specifying additional query parameters for the Logout Responsejava.util.Map<java.lang.String,java.lang.String>
getParameters()
Get all parameters Useful when specifying additional query parameters for the Logout Responsejava.lang.String
getParametersQuery()
Get an encoded query string of all parameters.java.lang.String
getRelayState()
The relay state associated with this Logout Requestjava.lang.String
getResponseLocation()
Get the response location of the asserting party's SingleLogoutServicejava.lang.String
getSamlResponse()
Get 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 Detail
-
getResponseLocation
public java.lang.String getResponseLocation()
Get the response location of the asserting party's SingleLogoutService- Returns:
- the SingleLogoutService response location
-
getBinding
public Saml2MessageBinding getBinding()
Get the binding for the asserting party's SingleLogoutService- Returns:
- the SingleLogoutService binding
-
getSamlResponse
public java.lang.String getSamlResponse()
Get the signed and serialized <saml2:LogoutResponse> payload- Returns:
- the signed and serialized <saml2:LogoutResponse> payload
-
getRelayState
public java.lang.String getRelayState()
The relay state associated with this Logout Request- Returns:
- the relay state
-
getParameter
public java.lang.String getParameter(java.lang.String name)
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
public java.util.Map<java.lang.String,java.lang.String> getParameters()
Get all parameters Useful when specifying additional query parameters for the Logout Response- Returns:
- the Logout Response query parameters
-
getParametersQuery
public java.lang.String 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
-
-