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

Class RelyingPartyRegistration.Builder

  • Enclosing class:
    RelyingPartyRegistration
    public static final class RelyingPartyRegistration.Builder
extends java.lang.Object

    • Method Detail

      • registrationId

        public RelyingPartyRegistration.Builder registrationId​(java.lang.String id)
        Sets the registrationId template. Often be used in URL paths
        Parameters:
        id - registrationId for this object, should be unique
        Returns:
        this object

      • remoteIdpEntityId

        @Deprecated
public RelyingPartyRegistration.Builder remoteIdpEntityId​(java.lang.String entityId)
        Deprecated.
        use #providerDetails(Consumer< ProviderDetails.Builder >)
        Sets the entityId for the remote asserting party, the Identity Provider.
        Parameters:
        entityId - the IDP entityId
        Returns:
        this object

      • assertionConsumerServiceUrlTemplate

        public RelyingPartyRegistration.Builder assertionConsumerServiceUrlTemplate​(java.lang.String assertionConsumerServiceUrlTemplate)
        Assertion Consumer Service URL template. It can contain variables baseUrl, registrationId, baseScheme, baseHost, and basePort.
        Parameters:
        assertionConsumerServiceUrlTemplate - the Assertion Consumer Service URL template (i.e. "{baseUrl}/login/saml2/sso/{registrationId}".
        Returns:
        this object

      • idpWebSsoUrl

        @Deprecated
public RelyingPartyRegistration.Builder idpWebSsoUrl​(java.lang.String url)
        Deprecated.
        use #providerDetails(Consumer< ProviderDetails.Builder >)
        Sets the SSO URL for the remote asserting party, the Identity Provider.
        Parameters:
        url - - a URL that accepts authentication requests via REDIRECT or POST bindings
        Returns:
        this object

      • credentials

        public RelyingPartyRegistration.Builder credentials​(java.util.function.Consumer<java.util.Collection<Saml2X509Credential>> credentials)
        Modifies the collection of Saml2X509Credential objects used in communication between IDP and SP For example: Saml2X509Credential credential = ...; return RelyingPartyRegistration.withRegistrationId("id") .credentials(c -> c.add(credential)) ... .build();
        Parameters:
        credentials - - a consumer that can modify the collection of credentials
        Returns:
        this object

      • localEntityIdTemplate

        public RelyingPartyRegistration.Builder localEntityIdTemplate​(java.lang.String template)
        Sets the local relying party, or Service Provider, entity Id template. can generate it's entity ID based on possible variables of baseUrl, registrationId, baseScheme, baseHost, and basePort, for example {baseUrl}/saml2/service-provider-metadata/{registrationId}
        Returns:
        a string containing the entity ID or entity ID template

      • build

        public RelyingPartyRegistration build()
        Constructs a RelyingPartyRegistration object based on the builder configurations
        Returns:
        a RelyingPartyRegistration instance