OpenSaml4LogoutRequestResolver (spring-security-saml2-service-provider 5.8.1 API)

java.lang.Object
- org.springframework.security.saml2.provider.service.web.authentication.logout.OpenSaml4LogoutRequestResolver

All Implemented Interfaces:

Saml2LogoutRequestResolver
```
public final class OpenSaml4LogoutRequestResolver
extends java.lang.Object
implements Saml2LogoutRequestResolver
```
A Saml2LogoutRequestResolver for resolving SAML 2.0 Logout Requests with OpenSAML 4

Since:

5.6

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OpenSaml4LogoutRequestResolver.LogoutRequestParameters

Constructor Summary

Constructors
Constructor Description

OpenSaml4LogoutRequestResolver(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver)
Construct a OpenSaml4LogoutRequestResolver

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Saml2LogoutRequest`	`resolve(javax.servlet.http.HttpServletRequest request, org.springframework.security.core.Authentication authentication)`	Prepare to create, sign, and serialize a SAML 2.0 Logout Request.
`void`	`setClock(java.time.Clock clock)`	Use this `Clock` for determining the issued `Instant`
`void`	`setParametersConsumer(java.util.function.Consumer<OpenSaml4LogoutRequestResolver.LogoutRequestParameters> parametersConsumer)`	Set a `Consumer` for modifying the OpenSAML `LogoutRequest`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OpenSaml4LogoutRequestResolver
```
public OpenSaml4LogoutRequestResolver(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver)
```
    Construct a OpenSaml4LogoutRequestResolver
- Method Detail
  - resolve
```
public Saml2LogoutRequest resolve(javax.servlet.http.HttpServletRequest request,
                                  org.springframework.security.core.Authentication authentication)
```
    Prepare to create, sign, and serialize a SAML 2.0 Logout Request. By default, includes a NameID based on the Authentication instance.
    
    Specified by:
    
    resolve in interface Saml2LogoutRequestResolver
    
    Parameters:
    
    request - the HTTP request
    
    authentication - the current user
    
    Returns:
    
    a signed and serialized SAML 2.0 Logout Request
  - setParametersConsumer
```
public void setParametersConsumer(java.util.function.Consumer<OpenSaml4LogoutRequestResolver.LogoutRequestParameters> parametersConsumer)
```
    Set a Consumer for modifying the OpenSAML LogoutRequest
    
    Parameters:
    
    parametersConsumer - a consumer that accepts an OpenSaml4LogoutRequestResolver.LogoutRequestParameters
  - setClock
```
public void setClock(java.time.Clock clock)
```
    Use this Clock for determining the issued Instant
    
    Parameters:
    
    clock - the Clock to use