Interface CoreSchemaCfgClient

    • Method Detail

      • isAllowAttributeTypesWithNoSupOrSyntax

        ValueOrExpression<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.

        Default value: true

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

        void setAllowAttributeTypesWithNoSupOrSyntax​(ValueOrExpression<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

        ValueOrExpression<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.

        Default value: false

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

        void setAllowZeroLengthValuesDirectoryString​(ValueOrExpression<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<ValueOrExpression<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.

        Default value: NONE

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

        void setDisabledMatchingRule​(Collection<ValueOrExpression<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<ValueOrExpression<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.

        Default value: NONE

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

        void setDisabledSyntax​(Collection<ValueOrExpression<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

        @MandatoryProperty
        ValueOrExpression<String> getJavaClass()
        Gets the "java-class" property.

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

        Default value: org.opends.server.schema.CoreSchemaProvider

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

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

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

        Default value: strict

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

        ValueOrExpression<Boolean> isStrictFormatBoolean()
        Gets the "strict-format-boolean" property.

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

        When set to true, only "TRUE" and "FALSE" will be acceptable, per RFC 4517. When set to false, the server will accept true/false, yes/no, 1/0, on/off.

        Default value: false

        Returns:
        Returns the value of the "strict-format-boolean" property.
      • setStrictFormatBoolean

        void setStrictFormatBoolean​(ValueOrExpression<Boolean> value)
                             throws PropertyException
        Sets the "strict-format-boolean" property.

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

        When set to true, only "TRUE" and "FALSE" will be acceptable, per RFC 4517. When set to false, the server will accept true/false, yes/no, 1/0, on/off.

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

        ValueOrExpression<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.

        Default value: true

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

        void setStrictFormatCertificates​(ValueOrExpression<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

        ValueOrExpression<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.

        Default value: true

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

        void setStrictFormatCountryString​(ValueOrExpression<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

        ValueOrExpression<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.

        Default value: false

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

        void setStrictFormatJpegPhotos​(ValueOrExpression<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

        ValueOrExpression<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.

        Default value: false

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

        void setStrictFormatTelephoneNumbers​(ValueOrExpression<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

        ValueOrExpression<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.

        Default value: false

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

        void setStripSyntaxMinUpperBoundAttributeTypeDescription​(ValueOrExpression<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.