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

Class PluggableBackendCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<PluggableBackendCfgClient,PluggableBackendCfg>
org.forgerock.opendj.server.config.meta.PluggableBackendCfgDefn
public final class PluggableBackendCfgDefn extends AbstractManagedObjectDefinition<PluggableBackendCfgClient,PluggableBackendCfg>
An interface for querying the Pluggable Backend managed object definition meta information.

A Pluggable Backend stores application data in a pluggable database.

  • Method Details

    • getInstance

      public static PluggableBackendCfgDefn getInstance()
      Get the Pluggable Backend configuration definition singleton.
      Returns:
      Returns the Pluggable Backend configuration definition singleton.

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

    • getBaseDnPropertyDefinition

      public DnPropertyDefinition getBaseDnPropertyDefinition()
      Get the "base-dn" property definition.

      Specifies the base DN(s) for the data that the backend handles.

      A single backend may be responsible for one or more base DNs. Note that no two backends may have the same base DN although one backend may have a base DN that is below a base DN provided by another backend (similar to the use of sub-suffixes in the Sun Java System Directory Server). If any of the base DNs is subordinate to a base DN for another backend, then all base DNs for that backend must be subordinate to that same base DN.

      Returns:
      Returns the "base-dn" property definition.

    • getCipherKeyLengthPropertyDefinition

      public IntegerPropertyDefinition getCipherKeyLengthPropertyDefinition()
      Get the "cipher-key-length" property definition.

      Specifies the key length in bits for the preferred cipher.

      Returns:
      Returns the "cipher-key-length" property definition.

    • getCipherTransformationPropertyDefinition

      public StringPropertyDefinition getCipherTransformationPropertyDefinition()
      Get the "cipher-transformation" property definition.

      Specifies the cipher for the directory server using the syntax algorithm/mode/padding.

      The full transformation is required: specifying only an algorithm and allowing the cipher provider to supply the default mode and padding is not supported, because there is no guarantee these default values are the same among different implementations. Some cipher algorithms do not have a mode or padding, hence the fields must be specified using NONE as mode and NoPadding as padding. For example, ChaCha20/NONE/NoPadding.

      Returns:
      Returns the "cipher-transformation" property definition.

    • getCompactEncodingPropertyDefinition

      public BooleanPropertyDefinition getCompactEncodingPropertyDefinition()
      Get the "compact-encoding" property definition.

      Indicates whether the backend should use a compact form when encoding entries by compressing the attribute descriptions and object class sets.

      Note that this property applies only to the entries themselves and does not impact the index data. It will also replace the attribute descriptions used in add and modify operations with normalized ones from the schema.

      Returns:
      Returns the "compact-encoding" property definition.

    • getConfidentialityEnabledPropertyDefinition

      public BooleanPropertyDefinition getConfidentialityEnabledPropertyDefinition()
      Get the "confidentiality-enabled" property definition.

      Indicates whether the backend should make entries in database files readable only by Directory Server.

      Confidentiality is achieved by encrypting entries before writing them to the underlying storage. Entry encryption will protect data on disk from unauthorised parties reading the files; for complete protection, also set confidentiality for sensitive attributes indexes. The property cannot be set to false if some of the indexes have confidentiality set to true.

      Returns:
      Returns the "confidentiality-enabled" 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.

    • getEntriesCompressedPropertyDefinition

      public BooleanPropertyDefinition getEntriesCompressedPropertyDefinition()
      Get the "entries-compressed" property definition.

      Indicates whether the backend should attempt to compress entries before storing them in the database.

      Note that this property applies only to the entries themselves and does not impact the index data. Further, the effectiveness of the compression is based on the type of data contained in the entry.

      Returns:
      Returns the "entries-compressed" property definition.

    • getImportOffheapMemorySizePropertyDefinition

      public SizePropertyDefinition getImportOffheapMemorySizePropertyDefinition()
      Get the "import-offheap-memory-size" property definition.

      Specifies the amount of off-heap memory dedicated to the online operation (import-ldif, rebuild-index).

      Returns:
      Returns the "import-offheap-memory-size" property definition.

    • getIndexEntryLimitPropertyDefinition

      public IntegerPropertyDefinition getIndexEntryLimitPropertyDefinition()
      Get the "index-entry-limit" property definition.

      Specifies the maximum number of entries that is allowed to match a given index key before that particular index key is no longer maintained.

      This property is analogous to the ALL IDs threshold in the Sun Java System Directory Server. Note that this is the default limit for the backend, and it may be overridden on a per-attribute basis. A value of 0 means there is no limit. Changing the index entry limit significantly can result in serious performance degradation. Please read the documentation before changing this setting.

      Returns:
      Returns the "index-entry-limit" property definition.

    • getIndexFilterAnalyzerEnabledPropertyDefinition

      public BooleanPropertyDefinition getIndexFilterAnalyzerEnabledPropertyDefinition()
      Get the "index-filter-analyzer-enabled" property definition.

      Indicates whether to gather statistical information about the search filters processed by the directory server while evaluating the usage of indexes.

      Analyzing indexes requires gathering search filter usage patterns from user requests, especially for values as specified in the filters and subsequently looking the status of those values into the index files. When a search requests is processed, internal or user generated, a first phase uses indexes to find potential entries to be returned. Depending on the search filter, if the index of one of the specified attributes matches too many entries (exceeds the index entry limit), the search becomes non-indexed. In any case, all entries thus gathered (or the entire DIT) are matched against the filter for actually returning the search result.

      Returns:
      Returns the "index-filter-analyzer-enabled" property definition.

    • getIndexFilterAnalyzerMaxFiltersPropertyDefinition

      public IntegerPropertyDefinition getIndexFilterAnalyzerMaxFiltersPropertyDefinition()
      Get the "index-filter-analyzer-max-filters" property definition.

      The maximum number of search filter statistics to keep.

      When the maximum number of search filter is reached, the least used one will be deleted.

      Returns:
      Returns the "index-filter-analyzer-max-filters" 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.

    • getPreloadTimeLimitPropertyDefinition

      public DurationPropertyDefinition getPreloadTimeLimitPropertyDefinition()
      Get the "preload-time-limit" property definition.

      Specifies the length of time that the backend is allowed to spend "pre-loading" data when it is initialized.

      The pre-load process is used to pre-populate the database cache, so that it can be more quickly available when the server is processing requests. A duration of zero means there is no pre-load.

      Returns:
      Returns the "preload-time-limit" 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.

    • getBackendIndexesRelationDefinition

      public InstantiableRelationDefinition<BackendIndexCfgClient,BackendIndexCfg> getBackendIndexesRelationDefinition()
      Get the "backend-indexes" relation definition.
      Returns:
      Returns the "backend-indexes" relation definition.

    • getBackendVlvIndexesRelationDefinition

      public InstantiableRelationDefinition<BackendVlvIndexCfgClient,BackendVlvIndexCfg> getBackendVlvIndexesRelationDefinition()
      Get the "backend-vlv-indexes" relation definition.
      Returns:
      Returns the "backend-vlv-indexes" relation definition.