public interface PluggableBackendCfg extends BackendCfg
A Pluggable Backend stores application data in a pluggable database.
Modifier and Type | Method and Description |
---|---|
void |
addBackendIndexAddListener(ConfigurationAddListener<BackendIndexCfg> listener)
Registers to be notified when new Backend Indexes are added.
|
void |
addBackendIndexDeleteListener(ConfigurationDeleteListener<BackendIndexCfg> listener)
Registers to be notified when existing Backend Indexes are deleted.
|
void |
addBackendVLVIndexAddListener(ConfigurationAddListener<BackendVLVIndexCfg> listener)
Registers to be notified when new Backend VLV Indexes are added.
|
void |
addBackendVLVIndexDeleteListener(ConfigurationDeleteListener<BackendVLVIndexCfg> listener)
Registers to be notified when existing Backend VLV Indexes are deleted.
|
void |
addPluggableChangeListener(ConfigurationChangeListener<PluggableBackendCfg> listener)
Register to be notified when this Pluggable Backend is changed.
|
Class<? extends PluggableBackendCfg> |
configurationClass()
Gets the configuration class associated with this Pluggable Backend.
|
BackendIndexCfg |
getBackendIndex(String name)
Gets the named Backend Index.
|
BackendVLVIndexCfg |
getBackendVLVIndex(String name)
Gets the named Backend VLV Index.
|
int |
getCipherKeyLength()
Gets the "cipher-key-length" property.
|
String |
getCipherTransformation()
Gets the "cipher-transformation" property.
|
Long |
getImportOffheapMemorySize()
Gets the "import-offheap-memory-size" property.
|
int |
getIndexEntryLimit()
Gets the "index-entry-limit" property.
|
int |
getIndexFilterAnalyzerMaxFilters()
Gets the "index-filter-analyzer-max-filters" property.
|
long |
getPreloadTimeLimit()
Gets the "preload-time-limit" property.
|
BackendCfgDefn.WritabilityMode |
getWritabilityMode()
Gets the "writability-mode" property.
|
boolean |
isCompactEncoding()
Gets the "compact-encoding" property.
|
boolean |
isConfidentialityEnabled()
Gets the "confidentiality-enabled" property.
|
boolean |
isEntriesCompressed()
Gets the "entries-compressed" property.
|
boolean |
isIndexFilterAnalyzerEnabled()
Gets the "index-filter-analyzer-enabled" property.
|
String[] |
listBackendIndexes()
Lists the Backend Indexes.
|
String[] |
listBackendVLVIndexes()
Lists the Backend VLV Indexes.
|
void |
removeBackendIndexAddListener(ConfigurationAddListener<BackendIndexCfg> listener)
Deregisters an existing Backend Index configuration add listener.
|
void |
removeBackendIndexDeleteListener(ConfigurationDeleteListener<BackendIndexCfg> listener)
Deregisters an existing Backend Index configuration delete listener.
|
void |
removeBackendVLVIndexAddListener(ConfigurationAddListener<BackendVLVIndexCfg> listener)
Deregisters an existing Backend VLV Index configuration add listener.
|
void |
removeBackendVLVIndexDeleteListener(ConfigurationDeleteListener<BackendVLVIndexCfg> listener)
Deregisters an existing Backend VLV Index configuration delete listener.
|
void |
removePluggableChangeListener(ConfigurationChangeListener<PluggableBackendCfg> listener)
Deregister an existing Pluggable Backend configuration change listener.
|
addChangeListener, getBackendId, getBaseDN, getJavaClass, isEnabled, removeChangeListener
dn
Class<? extends PluggableBackendCfg> configurationClass()
configurationClass
in interface BackendCfg
configurationClass
in interface Configuration
void addPluggableChangeListener(ConfigurationChangeListener<PluggableBackendCfg> listener)
listener
- The Pluggable Backend configuration change listener.void removePluggableChangeListener(ConfigurationChangeListener<PluggableBackendCfg> listener)
listener
- The Pluggable Backend configuration change listener.int getCipherKeyLength()
Specifies the key length in bits for the preferred cipher.
String getCipherTransformation()
Specifies the cipher for the directory server. The syntax is "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, including RC4 and ARCFOUR, do not have a mode or padding, and hence must be specified using NONE for the mode field and NoPadding for the padding field. For example, RC4/NONE/NoPadding.
boolean isCompactEncoding()
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.
boolean isConfidentialityEnabled()
Indicates whether the backend should make entries in database files readable only by Directory Server.
Confidentiality is achieved by enrypting 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.
boolean isEntriesCompressed()
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.
Long getImportOffheapMemorySize()
Specifies the amount of off-heap memory dedicated to the online operation (import-ldif, rebuild-index).
int getIndexEntryLimit()
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.
boolean isIndexFilterAnalyzerEnabled()
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.
int getIndexFilterAnalyzerMaxFilters()
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.
long getPreloadTimeLimit()
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.
BackendCfgDefn.WritabilityMode getWritabilityMode()
Specifies the behavior that the backend should use when processing write operations.
getWritabilityMode
in interface BackendCfg
String[] listBackendIndexes()
BackendIndexCfg getBackendIndex(String name) throws ConfigException
name
- The name of the Backend Index to retrieve.ConfigException
- If the Backend Index could not be found or it
could not be successfully decoded.void addBackendIndexAddListener(ConfigurationAddListener<BackendIndexCfg> listener) throws ConfigException
listener
- The Backend Index configuration add listener.ConfigException
- If the add listener could not be registered.void removeBackendIndexAddListener(ConfigurationAddListener<BackendIndexCfg> listener)
listener
- The Backend Index configuration add listener.void addBackendIndexDeleteListener(ConfigurationDeleteListener<BackendIndexCfg> listener) throws ConfigException
listener
- The Backend Index configuration delete listener.ConfigException
- If the delete listener could not be registered.void removeBackendIndexDeleteListener(ConfigurationDeleteListener<BackendIndexCfg> listener)
listener
- The Backend Index configuration delete listener.String[] listBackendVLVIndexes()
BackendVLVIndexCfg getBackendVLVIndex(String name) throws ConfigException
name
- The name of the Backend VLV Index to retrieve.ConfigException
- If the Backend VLV Index could not be found or it
could not be successfully decoded.void addBackendVLVIndexAddListener(ConfigurationAddListener<BackendVLVIndexCfg> listener) throws ConfigException
listener
- The Backend VLV Index configuration add listener.ConfigException
- If the add listener could not be registered.void removeBackendVLVIndexAddListener(ConfigurationAddListener<BackendVLVIndexCfg> listener)
listener
- The Backend VLV Index configuration add listener.void addBackendVLVIndexDeleteListener(ConfigurationDeleteListener<BackendVLVIndexCfg> listener) throws ConfigException
listener
- The Backend VLV Index configuration delete listener.ConfigException
- If the delete listener could not be registered.void removeBackendVLVIndexDeleteListener(ConfigurationDeleteListener<BackendVLVIndexCfg> listener)
listener
- The Backend VLV Index configuration delete listener.Copyright 2010-2017 ForgeRock AS.