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

Interface AssertingPartyMetadata.Builder<B extends AssertingPartyMetadata.Builder<B>>

All Known Implementing Classes:
OpenSamlAssertingPartyDetails.Builder, RelyingPartyRegistration.AssertingPartyDetails.Builder
Enclosing interface:
AssertingPartyMetadata
public static interface AssertingPartyMetadata.Builder<B extends AssertingPartyMetadata.Builder<B>>

  • Method Details

    • entityId

      B entityId(String entityId)
      Set the asserting party's EntityID. Equivalent to the value found in the asserting party's <EntityDescriptor EntityID="..."/>
      Parameters:
      entityId - the asserting party's EntityID
      Returns:
      the AssertingPartyMetadata.Builder for further configuration

    • wantAuthnRequestsSigned

      B wantAuthnRequestsSigned(boolean wantAuthnRequestsSigned)
      Set the WantAuthnRequestsSigned setting, indicating the asserting party's preference that relying parties should sign the AuthnRequest before sending.
      Parameters:
      wantAuthnRequestsSigned - the WantAuthnRequestsSigned setting
      Returns:
      the AssertingPartyMetadata.Builder for further configuration

    • signingAlgorithms

      B signingAlgorithms(Consumer<List<String>> signingMethodAlgorithmsConsumer)
      Apply this Consumer to the list of SigningMethod Algorithms
      Parameters:
      signingMethodAlgorithmsConsumer - a Consumer of the list of SigningMethod Algorithms
      Returns:
      this AssertingPartyMetadata.Builder for further configuration
      Since:
      5.5

    • verificationX509Credentials

      B verificationX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer)
      Apply this Consumer to the list of Saml2X509Credentials
      Parameters:
      credentialsConsumer - a Consumer of the List of Saml2X509Credentials
      Returns:
      the RelyingPartyRegistration.Builder for further configuration
      Since:
      5.4

    • encryptionX509Credentials

      B encryptionX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer)
      Apply this Consumer to the list of Saml2X509Credentials
      Parameters:
      credentialsConsumer - a Consumer of the List of Saml2X509Credentials
      Returns:
      the RelyingPartyRegistration.Builder for further configuration
      Since:
      5.4

    • singleSignOnServiceLocation

      B singleSignOnServiceLocation(String singleSignOnServiceLocation)
      Set the SingleSignOnService Location.

      Equivalent to the value found in <SingleSignOnService Location="..."/> in the asserting party's <IDPSSODescriptor>.

      Parameters:
      singleSignOnServiceLocation - the SingleSignOnService Location
      Returns:
      the AssertingPartyMetadata.Builder for further configuration

    • singleSignOnServiceBinding

      B singleSignOnServiceBinding(Saml2MessageBinding singleSignOnServiceBinding)
      Set the SingleSignOnService Binding.

      Equivalent to the value found in <SingleSignOnService Binding="..."/> in the asserting party's <IDPSSODescriptor>.

      Parameters:
      singleSignOnServiceBinding - the SingleSignOnService Binding
      Returns:
      the AssertingPartyMetadata.Builder for further configuration

    • singleLogoutServiceLocation

      B singleLogoutServiceLocation(String singleLogoutServiceLocation)
      Set the SingleLogoutService Location

      Equivalent to the value found in <SingleLogoutService Location="..."/> in the asserting party's <IDPSSODescriptor>.

      Parameters:
      singleLogoutServiceLocation - the SingleLogoutService Location
      Returns:
      the AssertingPartyMetadata.Builder for further configuration
      Since:
      5.6

    • singleLogoutServiceResponseLocation

      B singleLogoutServiceResponseLocation(String singleLogoutServiceResponseLocation)
      Set the SingleLogoutService Response Location

      Equivalent to the value found in <SingleLogoutService ResponseLocation="..."/> in the asserting party's <IDPSSODescriptor>.

      Parameters:
      singleLogoutServiceResponseLocation - the SingleLogoutService Response Location
      Returns:
      the AssertingPartyMetadata.Builder for further configuration
      Since:
      5.6

    • singleLogoutServiceBinding

      B singleLogoutServiceBinding(Saml2MessageBinding singleLogoutServiceBinding)
      Set the SingleLogoutService Binding

      Equivalent to the value found in <SingleLogoutService Binding="..."/> in the asserting party's <IDPSSODescriptor>.

      Parameters:
      singleLogoutServiceBinding - the SingleLogoutService Binding
      Returns:
      the AssertingPartyMetadata.Builder for further configuration
      Since:
      5.6

    • build

      AssertingPartyMetadata build()
      Creates an immutable ProviderDetails object representing the configuration for an Identity Provider, IDP
      Returns:
      immutable ProviderDetails object