Package org.forgerock.opendj.server.config.meta

Class SchemaBackendCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<SchemaBackendCfgClient,SchemaBackendCfg>
org.forgerock.opendj.server.config.meta.SchemaBackendCfgDefn
public final class SchemaBackendCfgDefn extends ManagedObjectDefinition<SchemaBackendCfgClient,SchemaBackendCfg>
An interface for querying the Schema Backend managed object definition meta information.

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

    • getInstance

      public static SchemaBackendCfgDefn getInstance()
      Get the Schema Backend configuration definition singleton.
      Returns:
      Returns the Schema Backend configuration definition singleton.

    • createClientConfiguration

      public SchemaBackendCfgClient createClientConfiguration(ManagedObject<? extends SchemaBackendCfgClient> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.
      Specified by:
      createClientConfiguration in class ManagedObjectDefinition<SchemaBackendCfgClient,SchemaBackendCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public SchemaBackendCfg createServerConfiguration(ServerManagedObject<? extends SchemaBackendCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<SchemaBackendCfgClient,SchemaBackendCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<SchemaBackendCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<SchemaBackendCfgClient,SchemaBackendCfg>
      Returns:
      Returns the server configuration class instance associated with this managed object definition.

    • getBackendIdPropertyDefinition

      public StringPropertyDefinition getBackendIdPropertyDefinition()
      Get the "backend-id" property definition.

      Specifies a name to identify the associated backend.

      The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server.

      Returns:
      Returns the "backend-id" property definition.

    • getEnabledPropertyDefinition

      public BooleanPropertyDefinition getEnabledPropertyDefinition()
      Get the "enabled" property definition.

      Indicates whether the backend is enabled in the server.

      If a backend is not enabled, then its contents are not accessible when processing operations.

      Returns:
      Returns the "enabled" property definition.

    • getJavaClassPropertyDefinition

      public ClassPropertyDefinition getJavaClassPropertyDefinition()
      Get the "java-class" property definition.

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

      Returns:
      Returns the "java-class" property definition.

    • getSchemaEntryDnPropertyDefinition

      public DnPropertyDefinition getSchemaEntryDnPropertyDefinition()
      Get the "schema-entry-dn" property definition.

      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.

      Returns:
      Returns the "schema-entry-dn" property definition.

    • getShowAllAttributesPropertyDefinition

      public BooleanPropertyDefinition getShowAllAttributesPropertyDefinition()
      Get the "show-all-attributes" property definition.

      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 "show-all-attributes" property definition.

    • getWritabilityModePropertyDefinition

      public EnumPropertyDefinition<LocalBackendCfgDefn.WritabilityMode> getWritabilityModePropertyDefinition()
      Get the "writability-mode" property definition.

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

      Returns:
      Returns the "writability-mode" property definition.