public final class PDBBackendCfgDefn extends ManagedObjectDefinition<PDBBackendCfgClient,PDBBackendCfg>
A PDB Backend stores application data in a Persistit database.
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
public static PDBBackendCfgDefn getInstance()
public PDBBackendCfgClient createClientConfiguration(ManagedObject<? extends PDBBackendCfgClient> impl)
createClientConfiguration
in class ManagedObjectDefinition<PDBBackendCfgClient,PDBBackendCfg>
impl
- The managed object.public PDBBackendCfg createServerConfiguration(ServerManagedObject<? extends PDBBackendCfg> impl)
createServerConfiguration
in class ManagedObjectDefinition<PDBBackendCfgClient,PDBBackendCfg>
impl
- The server managed object.public Class<PDBBackendCfg> getServerConfigurationClass()
getServerConfigurationClass
in class ManagedObjectDefinition<PDBBackendCfgClient,PDBBackendCfg>
public StringPropertyDefinition getBackendIdPropertyDefinition()
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.
public DNPropertyDefinition getBaseDNPropertyDefinition()
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.
public BooleanPropertyDefinition getCompactEncodingPropertyDefinition()
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.
public IntegerPropertyDefinition getDBCachePercentPropertyDefinition()
Specifies the percentage of JVM memory to allocate to the database cache.
Specifies the percentage of memory available to the JVM that should be used for caching database contents. Note that this is only used if the value of the db-cache-size property is set to "0 MB". Otherwise, the value of that property is used instead to control the cache size configuration.
public SizePropertyDefinition getDBCacheSizePropertyDefinition()
The amount of JVM memory to allocate to the database cache.
Specifies the amount of memory that should be used for caching database contents. A value of "0 MB" indicates that the db-cache-percent property should be used instead to specify the cache size.
public DurationPropertyDefinition getDBCheckpointerWakeupIntervalPropertyDefinition()
Specifies the maximum length of time that may pass between checkpoints.
This setting controls the elapsed time between attempts to write a checkpoint to the journal. A longer interval allows more updates to accumulate in buffers before they are required to be written to disk, but also potentially causes recovery from an abrupt termination (crash) to take more time.
public StringPropertyDefinition getDBDirectoryPropertyDefinition()
Specifies the path to the filesystem directory that is used to hold the Persistit database files containing the data for this backend.
The path may be either an absolute path or a path relative to the directory containing the base of the OpenDJ directory server installation. The path may be any valid directory path in which the server has appropriate permissions to read and write files and has sufficient space to hold the database contents.
public StringPropertyDefinition getDBDirectoryPermissionsPropertyDefinition()
Specifies the permissions that should be applied to the directory containing the server database files.
They should be expressed as three-digit octal values, which is the traditional representation for UNIX file permissions. The three digits represent the permissions that are available for the directory's owner, group members, and other users (in that order), and each digit is the octal representation of the read, write, and execute bits. Note that this only impacts permissions on the database directory and not on the files written into that directory. On UNIX systems, the user's umask controls permissions given to the database files.
public BooleanPropertyDefinition getDBTxnNoSyncPropertyDefinition()
Indicates whether database writes should be primarily written to an internal buffer but not immediately written to disk.
Setting the value of this configuration attribute to "true" may improve write performance but could cause the most recent changes to be lost if the OpenDJ directory server or the underlying JVM exits abnormally, or if an OS or hardware failure occurs (a behavior similar to running with transaction durability disabled in the Sun Java System Directory Server).
public SizePropertyDefinition getDiskFullThresholdPropertyDefinition()
Full disk threshold to limit database updates
When the available free space on the disk used by this database instance falls below the value specified, no updates are permitted and the server returns an UNWILLING_TO_PERFORM error. Updates are allowed again as soon as free space rises above the threshold.
public SizePropertyDefinition getDiskLowThresholdPropertyDefinition()
Low disk threshold to limit database updates
Specifies the "low" free space on the disk. When the available free space on the disk used by this database instance falls below the value specified, protocol updates on this database are permitted only by a user with the BYPASS_LOCKDOWN privilege.
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Indicates whether the backend is enabled in the server.
If a backend is not enabled, then its contents are not accessible when processing operations.
public BooleanPropertyDefinition getEntriesCompressedPropertyDefinition()
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.
public IntegerPropertyDefinition getIndexEntryLimitPropertyDefinition()
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.
public BooleanPropertyDefinition getIndexFilterAnalyzerEnabledPropertyDefinition()
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.
public IntegerPropertyDefinition getIndexFilterAnalyzerMaxFiltersPropertyDefinition()
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.
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
public DurationPropertyDefinition getPreloadTimeLimitPropertyDefinition()
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.
public EnumPropertyDefinition<BackendCfgDefn.WritabilityMode> getWritabilityModePropertyDefinition()
Specifies the behavior that the backend should use when processing write operations.
public InstantiableRelationDefinition<BackendIndexCfgClient,BackendIndexCfg> getBackendIndexesRelationDefinition()
public InstantiableRelationDefinition<BackendVLVIndexCfgClient,BackendVLVIndexCfg> getBackendVLVIndexesRelationDefinition()
Copyright © 2010-2016 ForgeRock AS. All Rights Reserved.