OpenSamlAuthenticationRequestFactory

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

All Implemented Interfaces:: Saml2AuthenticationRequestFactory

public class OpenSamlAuthenticationRequestFactory
extends java.lang.Object
implements Saml2AuthenticationRequestFactory

Since:: 5.2

Constructor Summary

Constructors
Constructor Description

OpenSamlAuthenticationRequestFactory()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`createAuthenticationRequest(Saml2AuthenticationRequest request)`	Creates an authentication request from the Service Provider, sp, to the Identity Provider, idp.
`void`	`setClock(java.time.Clock clock)`	' Use this `Clock` with `Instant.now()` for generating timestamps
`void`	`setProtocolBinding(java.lang.String protocolBinding)`	Sets the `protocolBinding` to use when generating authentication requests Acceptable values are `SAMLConstants.SAML2_POST_BINDING_URI` and `SAMLConstants.SAML2_REDIRECT_BINDING_URI`

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

- Constructor Detail
  - OpenSamlAuthenticationRequestFactory
```
public OpenSamlAuthenticationRequestFactory()
```
- Method Detail
  - createAuthenticationRequest
```
public java.lang.String createAuthenticationRequest(Saml2AuthenticationRequest request)
```
    Creates an authentication request from the Service Provider, sp, to the Identity Provider, idp. The authentication result is an XML string that may be signed, encrypted, both or neither.
    
    Specified by:
    
    createAuthenticationRequest in interface Saml2AuthenticationRequestFactory
    
    Parameters:
    
    request - - information about the identity provider, the recipient of this authentication request and accompanying data
    
    Returns:
    
    XML data in the format of a String. This data may be signed, encrypted, both signed and encrypted or neither signed and encrypted
  - setClock
```
public void setClock(java.time.Clock clock)
```
    ' Use this Clock with Instant.now() for generating timestamps
    
    Parameters:
    
    clock -
  - setProtocolBinding
```
public void setProtocolBinding(java.lang.String protocolBinding)
```
    Sets the protocolBinding to use when generating authentication requests Acceptable values are SAMLConstants.SAML2_POST_BINDING_URI and SAMLConstants.SAML2_REDIRECT_BINDING_URI
    
    Parameters:
    
    protocolBinding -
    
    Throws:
    
    java.lang.IllegalArgumentException - if the protocolBinding is not valid