Package org.springframework.security.saml2.provider.service.authentication

Class Saml2AuthenticationRequest.Builder

java.lang.Object
org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequest.Builder
Enclosing class:
Saml2AuthenticationRequest
public static final class Saml2AuthenticationRequest.Builder extends Object
A builder for Saml2AuthenticationRequest.

  • Method Details

    • issuer

      public Saml2AuthenticationRequest.Builder issuer(String issuer)
      Sets the issuer for the authentication request.
      Parameters:
      issuer - - a required value
      Returns:
      this Builder

    • credentials

      public Saml2AuthenticationRequest.Builder credentials(Consumer<Collection<Saml2X509Credential>> credentials)
      Modifies the collection of Saml2X509Credential credentials used in communication between IDP and SP, specifically signing the authentication request. For example: Saml2X509Credential credential = ...; return Saml2AuthenticationRequest.withLocalSpEntityId("id") .credentials((c) -> c.add(credential)) ... .build();
      Parameters:
      credentials - - a consumer that can modify the collection of credentials
      Returns:
      this object

    • destination

      public Saml2AuthenticationRequest.Builder destination(String destination)
      Sets the Destination for the authentication request. Typically the Service Provider EntityID
      Parameters:
      destination - - a required value
      Returns:
      this Builder

    • assertionConsumerServiceUrl

      public Saml2AuthenticationRequest.Builder assertionConsumerServiceUrl(String assertionConsumerServiceUrl)
      Sets the assertionConsumerServiceURL for the authentication request. Typically the Service Provider EntityID
      Parameters:
      assertionConsumerServiceUrl - - a required value
      Returns:
      this Builder

    • build

      public Saml2AuthenticationRequest build()
      Creates a Saml2AuthenticationRequest object.
      Returns:
      the Saml2AuthenticationRequest object
      Throws:
      IllegalArgumentException - if a required property is not set