Saml2PostAuthenticationRequest (spring-security-docs-manual 5.5.3 API)

java.lang.Object
- org.springframework.security.saml2.provider.service.authentication.AbstractSaml2AuthenticationRequest
- - org.springframework.security.saml2.provider.service.authentication.Saml2PostAuthenticationRequest

```
public class Saml2PostAuthenticationRequest
extends AbstractSaml2AuthenticationRequest
```
Data holder for information required to send an AuthNRequest over a POST binding from the service provider to the identity provider https://www.oasis-open.org/committees/download.php/35711/sstc-saml-core-errata-2.0-wd-06-diff.pdf (line 2031)

Since:

5.3

See Also:

Saml2AuthenticationRequestFactory

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Saml2PostAuthenticationRequest.Builder
Builder class for a Saml2PostAuthenticationRequest object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Saml2MessageBinding`	`getBinding()`	Returns the binding this AuthNRequest will be sent and encoded with.
`static Saml2PostAuthenticationRequest.Builder`	`withAuthenticationRequestContext(Saml2AuthenticationRequestContext context)`	Constructs a `Saml2PostAuthenticationRequest.Builder` from a `Saml2AuthenticationRequestContext` object.

Methods inherited from class org.springframework.security.saml2.provider.service.authentication.AbstractSaml2AuthenticationRequest
getAuthenticationRequestUri, getRelayState, getSamlRequest

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

- Method Detail
  - getBinding
```
public Saml2MessageBinding getBinding()
```
    Description copied from class: AbstractSaml2AuthenticationRequest
    
    Returns the binding this AuthNRequest will be sent and encoded with. If Saml2MessageBinding.REDIRECT is used, the DEFLATE encoding will be automatically applied.
    
    Specified by:
    
    getBinding in class AbstractSaml2AuthenticationRequest
    
    Returns:
    
    Saml2MessageBinding.POST
  - withAuthenticationRequestContext
```
public static Saml2PostAuthenticationRequest.Builder withAuthenticationRequestContext(Saml2AuthenticationRequestContext context)
```
    Constructs a Saml2PostAuthenticationRequest.Builder from a Saml2AuthenticationRequestContext object. By default the AbstractSaml2AuthenticationRequest.getAuthenticationRequestUri() will be set to the Saml2AuthenticationRequestContext.getDestination() value.
    
    Parameters:
    
    context - input providing Destination, RelayState, and Issuer objects.
    
    Returns:
    
    a modifiable builder object