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

Interface SchemaBackendCfgClient

All Superinterfaces:
BackendCfgClient, ConfigurationClient, LocalBackendCfgClient
public interface SchemaBackendCfgClient extends LocalBackendCfgClient
A client-side interface for reading and modifying Schema Backend settings.

The Schema Backend provides access to the directory server schema information, including the attribute types, object classes, attribute syntaxes, matching rules, matching rule uses, DIT content rules, and DIT structure rules that it contains.

  • Method Details

    • definition

      ManagedObjectDefinition<? extends SchemaBackendCfgClient,? extends SchemaBackendCfg> definition()
      Get the configuration definition associated with this Schema Backend.
      Specified by:
      definition in interface BackendCfgClient
      Specified by:
      definition in interface ConfigurationClient
      Specified by:
      definition in interface LocalBackendCfgClient
      Returns:
      Returns the configuration definition associated with this Schema Backend.

    • getJavaClass

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

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

      Default value: org.opends.server.backends.SchemaBackend

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

    • setJavaClass

      @MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
      Sets the "java-class" property.

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

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

    • getSchemaEntryDn

      SortedSet<ValueOrExpression<Dn>> getSchemaEntryDn()
      Gets the "schema-entry-dn" property.

      Defines the base DNs of the subtrees in which the schema information is published in addition to the value included in the base-dn property.

      The value provided in the base-dn property is the only one that appears in the subschemaSubentry operational attribute of the server's root DSE (which is necessary because that is a single-valued attribute) and as a virtual attribute in other entries. The schema-entry-dn attribute may be used to make the schema information available in other locations to accommodate certain client applications that have been hard-coded to expect the schema to reside in a specific location.

      Default value: cn=schema

      Returns:
      Returns the values of the "schema-entry-dn" property.

    • setSchemaEntryDn

      void setSchemaEntryDn(Collection<ValueOrExpression<Dn>> values) throws PropertyException
      Sets the "schema-entry-dn" property.

      Defines the base DNs of the subtrees in which the schema information is published in addition to the value included in the base-dn property.

      The value provided in the base-dn property is the only one that appears in the subschemaSubentry operational attribute of the server's root DSE (which is necessary because that is a single-valued attribute) and as a virtual attribute in other entries. The schema-entry-dn attribute may be used to make the schema information available in other locations to accommodate certain client applications that have been hard-coded to expect the schema to reside in a specific location.

      Parameters:
      values - The values of the "schema-entry-dn" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • isShowAllAttributes

      @MandatoryProperty ValueOrExpression<Boolean> isShowAllAttributes()
      Gets the "show-all-attributes" property.

      Indicates whether to treat all attributes in the schema entry as if they were user attributes regardless of their configuration.

      This may provide compatibility with some applications that expect schema attributes like attributeTypes and objectClasses to be included by default even if they are not requested. Note that the ldapSyntaxes attribute is always treated as operational in order to avoid problems with attempts to modify the schema over protocol.

      Returns:
      Returns the value of the "show-all-attributes" property.

    • setShowAllAttributes

      @MandatoryProperty void setShowAllAttributes(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "show-all-attributes" property.

      Indicates whether to treat all attributes in the schema entry as if they were user attributes regardless of their configuration.

      This may provide compatibility with some applications that expect schema attributes like attributeTypes and objectClasses to be included by default even if they are not requested. Note that the ldapSyntaxes attribute is always treated as operational in order to avoid problems with attempts to modify the schema over protocol.

      Parameters:
      value - The value of the "show-all-attributes" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getWritabilityMode

      @MandatoryProperty ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> getWritabilityMode()
      Gets the "writability-mode" property.

      Specifies the behavior that the backend should use when processing write operations.

      Default value: enabled

      Specified by:
      getWritabilityMode in interface LocalBackendCfgClient
      Returns:
      Returns the value of the "writability-mode" property.

    • setWritabilityMode

      @MandatoryProperty void setWritabilityMode(ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> value) throws PropertyException
      Sets the "writability-mode" property.

      Specifies the behavior that the backend should use when processing write operations.

      Specified by:
      setWritabilityMode in interface LocalBackendCfgClient
      Parameters:
      value - The value of the "writability-mode" property.
      Throws:
      PropertyException - If the new value is invalid.