Package org.forgerock.openam.sts.config.user

Class SAML2Config.SAML2ConfigBuilder

    • Method Detail

      • nameIdFormat

        public SAML2Config.SAML2ConfigBuilder nameIdFormat​(String nameIdFormat)
        Sets the name-id format on the SAML2ConfigBuilder.
        Parameters:
        nameIdFormat - the name-id format.
        Returns:
        the SAML2ConfigBuilder with the specified name-id format.

      • idpId

        public SAML2Config.SAML2ConfigBuilder idpId​(String idpId)
        Sets the Idenity Provider id on the SAML2ConfigBuilder.
        Parameters:
        idpId - the Identity Provider id.
        Returns:
        the SAML2ConfigBuilder with the specified Identity Provider id.

      • attributeMap

        public SAML2Config.SAML2ConfigBuilder attributeMap​(Map<String,​String> attributeMap)
        Sets the attribute map on the SAML2ConfigBuilder.
        Parameters:
        attributeMap - the attribute map.
        Returns:
        the SAML2ConfigBuilder with the specified attribute map.

      • tokenLifetimeInSeconds

        public SAML2Config.SAML2ConfigBuilder tokenLifetimeInSeconds​(long lifetimeInSeconds)
        Sets the token lifetime (in seconds) on the SAML2ConfigBuilder.
        Parameters:
        lifetimeInSeconds - the token lifetime.
        Returns:
        the SAML2ConfigBuilder with the specified token lifetime.

      • customConditionsProviderClassName

        public SAML2Config.SAML2ConfigBuilder customConditionsProviderClassName​(String customConditionsProviderClassName)
        Sets the CustomConditionsProvider classname on the SAML2ConfigBuilder.
        Parameters:
        customConditionsProviderClassName - the CustomConditionsProvider classname.
        Returns:
        the SAML2ConfigBuilder with the specified CustomConditionsProvider classname.

      • customSubjectProviderClassName

        public SAML2Config.SAML2ConfigBuilder customSubjectProviderClassName​(String customSubjectProviderClassName)
        Sets the CustomSubjectProvider classname on the SAML2ConfigBuilder.
        Parameters:
        customSubjectProviderClassName - the CustomSubjectProvider classname.
        Returns:
        the SAML2ConfigBuilder with the specified CustomSubjectProvider classname.

      • customAuthenticationStatementsProviderClassName

        public SAML2Config.SAML2ConfigBuilder customAuthenticationStatementsProviderClassName​(String customAuthenticationStatementsProviderClassName)
        Sets the CustomAuthenticationStatementsProvider classname on the SAML2ConfigBuilder.
        Parameters:
        customAuthenticationStatementsProviderClassName - the CustomAuthenticationStatementsProvider classname.
        Returns:
        the SAML2ConfigBuilder with the specified CustomAuthenticationStatementsProvider classname.

      • customAttributeStatementsProviderClassName

        public SAML2Config.SAML2ConfigBuilder customAttributeStatementsProviderClassName​(String customAttributeStatementsProviderClassName)
        Sets the CustomAttributeStatementsProvider classname on the SAML2ConfigBuilder.
        Parameters:
        customAttributeStatementsProviderClassName - the CustomAuthenticationStatementsProvider classname.
        Returns:
        the SAML2ConfigBuilder with the specified CustomAuthenticationStatementsProvider classname.

      • customAuthzDecisionStatementsProviderClassName

        public SAML2Config.SAML2ConfigBuilder customAuthzDecisionStatementsProviderClassName​(String customAuthzDecisionStatementsProviderClassName)
        Sets the CustomAuthzDecisionStatementsProvider classname on the SAML2ConfigBuilder.
        Parameters:
        customAuthzDecisionStatementsProviderClassName - the CustomAuthzDecisionStatementsProvider classname.
        Returns:
        the SAML2ConfigBuilder with the specified CustomAuthzDecisionStatementsProvider classname.

      • customAttributeMapperClassName

        public SAML2Config.SAML2ConfigBuilder customAttributeMapperClassName​(String customAttributeMapperClassName)
        Sets the CustomAttributeMapper classname on the SAML2ConfigBuilder.
        Parameters:
        customAttributeMapperClassName - the CustomAttributeMapper classname.
        Returns:
        the SAML2ConfigBuilder with the specified CustomAttributeMapper classname.

      • customAuthNContextMapperClassName

        public SAML2Config.SAML2ConfigBuilder customAuthNContextMapperClassName​(String customAuthNContextMapperClassName)
        Sets the CustomAuthNContextMapper classname on the SAML2ConfigBuilder.
        Parameters:
        customAuthNContextMapperClassName - the CustomAuthNContextMapper classname.
        Returns:
        the SAML2ConfigBuilder with the specified CustomAuthNContextMapper classname.

      • spEntityId

        public SAML2Config.SAML2ConfigBuilder spEntityId​(String spEntityId)
        Sets the SP entity id on the SAML2ConfigBuilder.
        Parameters:
        spEntityId - the SP entity id.
        Returns:
        the SAML2Config builder with the specified SP entity id.

      • spAcsUrl

        public SAML2Config.SAML2ConfigBuilder spAcsUrl​(String spAcsUrl)
        Sets the SP ACS url on the SAML2ConfigBuilder.
        Parameters:
        spAcsUrl - the SP ACS url.
        Returns:
        the SAML2Config builder with the specified SP ACS url.

      • signatureKeyAlias

        public SAML2Config.SAML2ConfigBuilder signatureKeyAlias​(String signatureKeyAlias)
        Sets the signature key alias on the SAML2ConfigBuilder.
        Parameters:
        signatureKeyAlias - the signature key alias.
        Returns:
        the SAML2Config builder with the specified signature key alias.

      • signatureKeyPassword

        public SAML2Config.SAML2ConfigBuilder signatureKeyPassword​(byte[] signatureKeyPassword)
        Sets the signature key password on the SAML2ConfigBuilder.
        Parameters:
        signatureKeyPassword - the signature key password.
        Returns:
        the SAML2Config builder with the specified signature key password.

      • encryptionKeyAlias

        public SAML2Config.SAML2ConfigBuilder encryptionKeyAlias​(String encryptionKeyAlias)
        Sets the encryption key alias on the SAML2ConfigBuilder.
        Parameters:
        encryptionKeyAlias - the encryption key alias.
        Returns:
        the SAML2Config builder with the specified encryption key alias.

      • signAssertion

        public SAML2Config.SAML2ConfigBuilder signAssertion​(boolean signAssertion)
        Sets whether the SAML2Config assertion should be signed.
        Parameters:
        signAssertion - whether the assertion should be signed.
        Returns:
        the SAML2ConfigBuilder with the assertion signed flag set.

      • encryptNameID

        public SAML2Config.SAML2ConfigBuilder encryptNameID​(boolean encryptNameID)
        Sets whether the SAML2Config name-id should be encrypted.
        Parameters:
        encryptNameID - whether the name-id should be encrypted.
        Returns:
        the SAML2ConfigBuilder with the name-id encryption flag set.

      • encryptAttributes

        public SAML2Config.SAML2ConfigBuilder encryptAttributes​(boolean encryptAttributes)
        Sets whether SAML2Config attributes should be encrypted.
        Parameters:
        encryptAttributes - whether the attributes should be encrypted.
        Returns:
        the SAML2ConfigBuilder with the attribute encryption flag set.

      • encryptAssertion

        public SAML2Config.SAML2ConfigBuilder encryptAssertion​(boolean encryptAssertion)
        Sets whether SAML2Config assertion should be encrypted.
        Parameters:
        encryptAssertion - whether the assertion should be encrypted.
        Returns:
        the SAML2ConfigBuilder with the assertion encryption flag set.

      • encryptionAlgorithm

        public SAML2Config.SAML2ConfigBuilder encryptionAlgorithm​(String encryptionAlgorithm)
        Sets the SAML2Config encryption algorithm.
        Parameters:
        encryptionAlgorithm - the encryption algorithm.
        Returns:
        the SAML2ConfigBuilder with the specified encryption algorithm.

      • encryptionAlgorithmStrength

        public SAML2Config.SAML2ConfigBuilder encryptionAlgorithmStrength​(int encryptionAlgorithmStrength)
        Sets the SAML2Config encryption strength.
        Parameters:
        encryptionAlgorithmStrength - the encryption strength.
        Returns:
        the SAML2ConfigBuilder with the specified encryption strength.

      • keyTransportAlgorithm

        public SAML2Config.SAML2ConfigBuilder keyTransportAlgorithm​(String keyTransportAlgorithm)
        Sets the SAML2Config key transport algorithm.
        Parameters:
        keyTransportAlgorithm - The key transport algorithm.
        Returns:
        This builder.

      • keystoreFile

        public SAML2Config.SAML2ConfigBuilder keystoreFile​(String keystoreFileName)
        Sets the keystore filename on the SAML2ConfigBuilder.
        Parameters:
        keystoreFileName - the keystore filename.
        Returns:
        the SAML2Config builder with the specified keystore filename.

      • keystorePassword

        public SAML2Config.SAML2ConfigBuilder keystorePassword​(byte[] keystorePassword)
        Sets the keystore password on the SAML2ConfigBuilder.
        Parameters:
        keystorePassword - the keystore password.
        Returns:
        the SAML2Config builder with the specified keystore password.

      • build

        public SAML2Config build()
        Builds a SAML2Config object.
        Returns:
        a SAML2Config object.