AbstractSaml2AuthenticationRequest.Builder (spring-security-docs-manual 5.5.3 API)

java.lang.Object
- org.springframework.security.saml2.provider.service.authentication.AbstractSaml2AuthenticationRequest.Builder<T>

Direct Known Subclasses:

Saml2PostAuthenticationRequest.Builder, Saml2RedirectAuthenticationRequest.Builder

Enclosing class:

AbstractSaml2AuthenticationRequest
```
public static class AbstractSaml2AuthenticationRequest.Builder<T extends AbstractSaml2AuthenticationRequest.Builder<T>>
extends java.lang.Object
```
A builder for AbstractSaml2AuthenticationRequest and its subclasses.

Constructor Summary

Constructors
Modifier Constructor Description

protected Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected T`	`_this()`	Casting the return as the generic subtype, when returning itself
`T`	`authenticationRequestUri(java.lang.String authenticationRequestUri)`	Sets the `authenticationRequestUri`, a URL that will receive the AuthNRequest message
`T`	`relayState(java.lang.String relayState)`	Sets the `RelayState` parameter that will accompany this AuthNRequest
`T`	`samlRequest(java.lang.String samlRequest)`	Sets the `SAMLRequest` parameter that will accompany this AuthNRequest

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

- Constructor Detail
  - Builder
```
protected Builder()
```
- Method Detail
  - _this
```
protected final T _this()
```
    Casting the return as the generic subtype, when returning itself
    
    Returns:
    
    this object
  - relayState
```
public T relayState(java.lang.String relayState)
```
    Sets the RelayState parameter that will accompany this AuthNRequest
    
    Parameters:
    
    relayState - the relay state value, unencoded. if null or empty, the parameter will be removed from the map.
    
    Returns:
    
    this object
  - samlRequest
```
public T samlRequest(java.lang.String samlRequest)
```
    Sets the SAMLRequest parameter that will accompany this AuthNRequest
    
    Parameters:
    
    samlRequest - the SAMLRequest parameter.
    
    Returns:
    
    this object
  - authenticationRequestUri
```
public T authenticationRequestUri(java.lang.String authenticationRequestUri)
```
    Sets the authenticationRequestUri, a URL that will receive the AuthNRequest message
    
    Parameters:
    
    authenticationRequestUri - the relay state value, unencoded.
    
    Returns:
    
    this object