Package org.forgerock.opendj.server.config.client

Interface CoreSchemaCfgClient

    • Method Detail

      • isAllowAttributeTypesWithNoSupOrSyntax

        boolean isAllowAttributeTypesWithNoSupOrSyntax()
        Gets the "allow-attribute-types-with-no-sup-or-syntax" property.

        Indicates whether the schema should allow attribute type definitions that do not declare a superior attribute type or syntax

        When set to true, invalid attribute type definitions will use the default syntax.

        Returns:
        Returns the value of the "allow-attribute-types-with-no-sup-or-syntax" property.

      • setAllowAttributeTypesWithNoSupOrSyntax

        void setAllowAttributeTypesWithNoSupOrSyntax​(Boolean value)
                                      throws PropertyException
        Sets the "allow-attribute-types-with-no-sup-or-syntax" property.

        Indicates whether the schema should allow attribute type definitions that do not declare a superior attribute type or syntax

        When set to true, invalid attribute type definitions will use the default syntax.

        Parameters:
        value - The value of the "allow-attribute-types-with-no-sup-or-syntax" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isAllowZeroLengthValuesDirectoryString

        boolean isAllowZeroLengthValuesDirectoryString()
        Gets the "allow-zero-length-values-directory-string" property.

        Indicates whether zero-length (that is, an empty string) values are allowed for directory string.

        This is technically not allowed by the revised LDAPv3 specification, but some environments may require it for backward compatibility with servers that do allow it.

        Returns:
        Returns the value of the "allow-zero-length-values-directory-string" property.

      • setAllowZeroLengthValuesDirectoryString

        void setAllowZeroLengthValuesDirectoryString​(Boolean value)
                                      throws PropertyException
        Sets the "allow-zero-length-values-directory-string" property.

        Indicates whether zero-length (that is, an empty string) values are allowed for directory string.

        This is technically not allowed by the revised LDAPv3 specification, but some environments may require it for backward compatibility with servers that do allow it.

        Parameters:
        value - The value of the "allow-zero-length-values-directory-string" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getDisabledMatchingRule

        SortedSet<String> getDisabledMatchingRule()
        Gets the "disabled-matching-rule" property.

        The set of disabled matching rules.

        Matching rules must be specified using the syntax: OID, or use the default value 'NONE' to specify no value.

        Returns:
        Returns the values of the "disabled-matching-rule" property.

      • setDisabledMatchingRule

        void setDisabledMatchingRule​(Collection<String> values)
                      throws PropertyException
        Sets the "disabled-matching-rule" property.

        The set of disabled matching rules.

        Matching rules must be specified using the syntax: OID, or use the default value 'NONE' to specify no value.

        Parameters:
        values - The values of the "disabled-matching-rule" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getDisabledSyntax

        SortedSet<String> getDisabledSyntax()
        Gets the "disabled-syntax" property.

        The set of disabled syntaxes.

        Syntaxes must be specified using the syntax: OID, or use the default value 'NONE' to specify no value.

        Returns:
        Returns the values of the "disabled-syntax" property.

      • setDisabledSyntax

        void setDisabledSyntax​(Collection<String> values)
                throws PropertyException
        Sets the "disabled-syntax" property.

        The set of disabled syntaxes.

        Syntaxes must be specified using the syntax: OID, or use the default value 'NONE' to specify no value.

        Parameters:
        values - The values of the "disabled-syntax" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

        Specifies the fully-qualified name of the Java class that provides the Core Schema implementation.

        Specified by:
        getJavaClass in interface SchemaProviderCfgClient
        Returns:
        Returns the value of the "java-class" property.

      • setJavaClass

        void setJavaClass​(String value)
           throws PropertyException
        Sets the "java-class" property.

        Specifies the fully-qualified name of the Java class that provides the Core Schema implementation.

        Specified by:
        setJavaClass in interface SchemaProviderCfgClient
        Parameters:
        value - The value of the "java-class" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getJsonValidationPolicy

        CoreSchemaCfgDefn.JsonValidationPolicy getJsonValidationPolicy()
        Gets the "json-validation-policy" property.

        Specifies the policy that will be used when validating JSON syntax values.

        Returns:
        Returns the value of the "json-validation-policy" property.

      • setJsonValidationPolicy

        void setJsonValidationPolicy​(CoreSchemaCfgDefn.JsonValidationPolicy value)
                      throws PropertyException
        Sets the "json-validation-policy" property.

        Specifies the policy that will be used when validating JSON syntax values.

        Parameters:
        value - The value of the "json-validation-policy" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isStrictFormatCertificates

        boolean isStrictFormatCertificates()
        Gets the "strict-format-certificates" property.

        Indicates whether X.509 Certificate values are required to strictly comply with the standard definition for this syntax.

        When set to false, certificates will not be validated and, as a result any sequence of bytes will be acceptable.

        Returns:
        Returns the value of the "strict-format-certificates" property.

      • setStrictFormatCertificates

        void setStrictFormatCertificates​(Boolean value)
                          throws PropertyException
        Sets the "strict-format-certificates" property.

        Indicates whether X.509 Certificate values are required to strictly comply with the standard definition for this syntax.

        When set to false, certificates will not be validated and, as a result any sequence of bytes will be acceptable.

        Parameters:
        value - The value of the "strict-format-certificates" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isStrictFormatCountryString

        boolean isStrictFormatCountryString()
        Gets the "strict-format-country-string" property.

        Indicates whether country code values are required to strictly comply with the standard definition for this syntax.

        When set to false, country codes will not be validated and, as a result any string containing 2 characters will be acceptable.

        Returns:
        Returns the value of the "strict-format-country-string" property.

      • setStrictFormatCountryString

        void setStrictFormatCountryString​(Boolean value)
                           throws PropertyException
        Sets the "strict-format-country-string" property.

        Indicates whether country code values are required to strictly comply with the standard definition for this syntax.

        When set to false, country codes will not be validated and, as a result any string containing 2 characters will be acceptable.

        Parameters:
        value - The value of the "strict-format-country-string" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isStrictFormatJPEGPhotos

        boolean isStrictFormatJPEGPhotos()
        Gets the "strict-format-jpeg-photos" property.

        Indicates whether to require JPEG values to strictly comply with the standard definition for this syntax.

        Returns:
        Returns the value of the "strict-format-jpeg-photos" property.

      • setStrictFormatJPEGPhotos

        void setStrictFormatJPEGPhotos​(Boolean value)
                        throws PropertyException
        Sets the "strict-format-jpeg-photos" property.

        Indicates whether to require JPEG values to strictly comply with the standard definition for this syntax.

        Parameters:
        value - The value of the "strict-format-jpeg-photos" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isStrictFormatTelephoneNumbers

        boolean isStrictFormatTelephoneNumbers()
        Gets the "strict-format-telephone-numbers" property.

        Indicates whether to require telephone number values to strictly comply with the standard definition for this syntax.

        Returns:
        Returns the value of the "strict-format-telephone-numbers" property.

      • setStrictFormatTelephoneNumbers

        void setStrictFormatTelephoneNumbers​(Boolean value)
                              throws PropertyException
        Sets the "strict-format-telephone-numbers" property.

        Indicates whether to require telephone number values to strictly comply with the standard definition for this syntax.

        Parameters:
        value - The value of the "strict-format-telephone-numbers" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isStripSyntaxMinUpperBoundAttributeTypeDescription

        boolean isStripSyntaxMinUpperBoundAttributeTypeDescription()
        Gets the "strip-syntax-min-upper-bound-attribute-type-description" property.

        Indicates whether the suggested minimum upper bound appended to an attribute's syntax OID in it's schema definition Attribute Type Description is stripped off.

        When retrieving the server's schema, some APIs (JNDI) fail in their syntax lookup methods, because they do not parse this value correctly. This configuration option allows the server to be configured to provide schema definitions these APIs can parse correctly.

        Returns:
        Returns the value of the "strip-syntax-min-upper-bound-attribute-type-description" property.

      • setStripSyntaxMinUpperBoundAttributeTypeDescription

        void setStripSyntaxMinUpperBoundAttributeTypeDescription​(Boolean value)
                                                  throws PropertyException
        Sets the "strip-syntax-min-upper-bound-attribute-type-description" property.

        Indicates whether the suggested minimum upper bound appended to an attribute's syntax OID in it's schema definition Attribute Type Description is stripped off.

        When retrieving the server's schema, some APIs (JNDI) fail in their syntax lookup methods, because they do not parse this value correctly. This configuration option allows the server to be configured to provide schema definitions these APIs can parse correctly.

        Parameters:
        value - The value of the "strip-syntax-min-upper-bound-attribute-type-description" property.
        Throws:
        PropertyException - If the new value is invalid.