org.opends.server.admin.std.client

Interface PluggableBackendCfgClient

All Superinterfaces:

BackendCfgClient, ConfigurationClient

All Known Subinterfaces:

JEBackendCfgClient, PDBBackendCfgClient

public interface PluggableBackendCfgClient
extends BackendCfgClient

A client-side interface for reading and modifying Pluggable Backend settings.

A Pluggable Backend stores application data in a pluggable database.

Method Summary

Methods

Modifier and Type	Method and Description
<C extends BackendIndexCfgClient> C	createBackendIndex(ManagedObjectDefinition<C,? extends BackendIndexCfg> d, String name, Collection<PropertyException> exceptions) Creates a new Backend Index.
<C extends BackendVLVIndexCfgClient> C	createBackendVLVIndex(ManagedObjectDefinition<C,? extends BackendVLVIndexCfg> d, String name, Collection<PropertyException> exceptions) Creates a new Backend VLV Index.
ManagedObjectDefinition<? extends PluggableBackendCfgClient,? extends PluggableBackendCfg>	definition() Get the configuration definition associated with this Pluggable Backend.
BackendIndexCfgClient	getBackendIndex(String name) Gets the named Backend Index.
BackendVLVIndexCfgClient	getBackendVLVIndex(String name) Gets the named Backend VLV Index.
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	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	removeBackendIndex(String name) Removes the named Backend Index.
void	removeBackendVLVIndex(String name) Removes the named Backend VLV Index.
void	setCompactEncoding(Boolean value) Sets the "compact-encoding" property.
void	setEntriesCompressed(Boolean value) Sets the "entries-compressed" property.
void	setIndexEntryLimit(Integer value) Sets the "index-entry-limit" property.
void	setIndexFilterAnalyzerEnabled(Boolean value) Sets the "index-filter-analyzer-enabled" property.
void	setIndexFilterAnalyzerMaxFilters(Integer value) Sets the "index-filter-analyzer-max-filters" property.
void	setPreloadTimeLimit(Long value) Sets the "preload-time-limit" property.
void	setWritabilityMode(BackendCfgDefn.WritabilityMode value) Sets the "writability-mode" property.

Methods inherited from interface org.opends.server.admin.std.client.BackendCfgClient

getBackendId, getBaseDN, getJavaClass, isEnabled, setBackendId, setBaseDN, setEnabled, setJavaClass

Methods inherited from interface org.opends.server.admin.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends PluggableBackendCfgClient,? extends PluggableBackendCfg> definition()

Get the configuration definition associated with this Pluggable Backend.

Specified by:

definition in interface BackendCfgClient

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Pluggable Backend.

isCompactEncoding

boolean isCompactEncoding()

Gets the "compact-encoding" property.

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.

Returns:

Returns the value of the "compact-encoding" property.

setCompactEncoding

void setCompactEncoding(Boolean value)
                        throws PropertyException

Sets the "compact-encoding" property.

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.

Parameters:

value - The value of the "compact-encoding" property.

Throws:

PropertyException - If the new value is invalid.

isEntriesCompressed

boolean isEntriesCompressed()

Gets the "entries-compressed" property.

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 value of the "entries-compressed" property.

setEntriesCompressed

void setEntriesCompressed(Boolean value)
                          throws PropertyException

Sets the "entries-compressed" property.

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.

Parameters:

value - The value of the "entries-compressed" property.

Throws:

PropertyException - If the new value is invalid.

getIndexEntryLimit

int getIndexEntryLimit()

Gets the "index-entry-limit" property.

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.

Returns:

Returns the value of the "index-entry-limit" property.

setIndexEntryLimit

void setIndexEntryLimit(Integer value)
                        throws PropertyException

Sets the "index-entry-limit" property.

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.

Parameters:

value - The value of the "index-entry-limit" property.

Throws:

PropertyException - If the new value is invalid.

isIndexFilterAnalyzerEnabled

boolean isIndexFilterAnalyzerEnabled()

Gets the "index-filter-analyzer-enabled" property.

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 value of the "index-filter-analyzer-enabled" property.

setIndexFilterAnalyzerEnabled

void setIndexFilterAnalyzerEnabled(Boolean value)
                                   throws PropertyException

Sets the "index-filter-analyzer-enabled" property.

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.

Parameters:

value - The value of the "index-filter-analyzer-enabled" property.

Throws:

PropertyException - If the new value is invalid.

getIndexFilterAnalyzerMaxFilters

int getIndexFilterAnalyzerMaxFilters()

Gets the "index-filter-analyzer-max-filters" property.

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 value of the "index-filter-analyzer-max-filters" property.

setIndexFilterAnalyzerMaxFilters

void setIndexFilterAnalyzerMaxFilters(Integer value)
                                      throws PropertyException

Sets the "index-filter-analyzer-max-filters" property.

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.

Parameters:

value - The value of the "index-filter-analyzer-max-filters" property.

Throws:

PropertyException - If the new value is invalid.

getPreloadTimeLimit

long getPreloadTimeLimit()

Gets the "preload-time-limit" property.

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 value of the "preload-time-limit" property.

setPreloadTimeLimit

void setPreloadTimeLimit(Long value)
                         throws PropertyException

Sets the "preload-time-limit" property.

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.

Parameters:

value - The value of the "preload-time-limit" property.

Throws:

PropertyException - If the new value is invalid.

getWritabilityMode

BackendCfgDefn.WritabilityMode getWritabilityMode()

Gets the "writability-mode" property.

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

Specified by:

getWritabilityMode in interface BackendCfgClient

Returns:

Returns the value of the "writability-mode" property.

setWritabilityMode

void setWritabilityMode(BackendCfgDefn.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 BackendCfgClient

Parameters:

value - The value of the "writability-mode" property.

Throws:

PropertyException - If the new value is invalid.

listBackendIndexes

String[] listBackendIndexes()
                            throws ConcurrentModificationException,
                                   AuthorizationException,
                                   CommunicationException

Lists the Backend Indexes.

Returns:

Returns an array containing the names of the Backend Indexes.

Throws:

ConcurrentModificationException - If this Pluggable Backend has been removed from the server by another client.

AuthorizationException - If the server refuses to list the Backend Indexes because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

getBackendIndex

BackendIndexCfgClient getBackendIndex(String name)
                                      throws DefinitionDecodingException,
                                             ManagedObjectDecodingException,
                                             ManagedObjectNotFoundException,
                                             ConcurrentModificationException,
                                             AuthorizationException,
                                             CommunicationException

Gets the named Backend Index.

Parameters:

name - The name of the Backend Index to retrieve.

Returns:

Returns the named Backend Index.

Throws:

DefinitionDecodingException - If the named Backend Index was found but its type could not be determined.

ManagedObjectDecodingException - If the named Backend Index was found but one or more of its properties could not be decoded.

ManagedObjectNotFoundException - If the named Backend Index was not found on the server.

ConcurrentModificationException - If this Pluggable Backend has been removed from the server by another client.

AuthorizationException - If the server refuses to retrieve the named Backend Index because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

createBackendIndex

<C extends BackendIndexCfgClient> C createBackendIndex(ManagedObjectDefinition<C,? extends BackendIndexCfg> d,
                                                     String name,
                                                     Collection<PropertyException> exceptions)
                                                   throws IllegalManagedObjectNameException

Creates a new Backend Index. The new Backend Index will initially not contain any property values (including mandatory properties). Once the Backend Index has been configured it can be added to the server using the ConfigurationClient.commit() method.

Type Parameters:

C - The type of the Backend Index being created.

Parameters:

d - The definition of the Backend Index to be created.

name - The name of the new Backend Index.

exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Backend Index. This argument can be null.

Returns:

Returns a new Backend Index configuration instance.

Throws:

IllegalManagedObjectNameException - If the name of the new Backend Index is invalid.

removeBackendIndex

void removeBackendIndex(String name)
                        throws ManagedObjectNotFoundException,
                               OperationRejectedException,
                               ConcurrentModificationException,
                               AuthorizationException,
                               CommunicationException

Removes the named Backend Index.

Parameters:

name - The name of the Backend Index to remove.

Throws:

ManagedObjectNotFoundException - If the Backend Index does not exist.

OperationRejectedException - If the server refuses to remove the Backend Index due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).

ConcurrentModificationException - If this Pluggable Backend has been removed from the server by another client.

AuthorizationException - If the server refuses to remove the Backend Index because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

listBackendVLVIndexes

String[] listBackendVLVIndexes()
                               throws ConcurrentModificationException,
                                      AuthorizationException,
                                      CommunicationException

Lists the Backend VLV Indexes.

Returns:

Returns an array containing the names of the Backend VLV Indexes.

Throws:

ConcurrentModificationException - If this Pluggable Backend has been removed from the server by another client.

AuthorizationException - If the server refuses to list the Backend VLV Indexes because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

getBackendVLVIndex

BackendVLVIndexCfgClient getBackendVLVIndex(String name)
                                            throws DefinitionDecodingException,
                                                   ManagedObjectDecodingException,
                                                   ManagedObjectNotFoundException,
                                                   ConcurrentModificationException,
                                                   AuthorizationException,
                                                   CommunicationException

Gets the named Backend VLV Index.

Parameters:

name - The name of the Backend VLV Index to retrieve.

Returns:

Returns the named Backend VLV Index.

Throws:

DefinitionDecodingException - If the named Backend VLV Index was found but its type could not be determined.

ManagedObjectDecodingException - If the named Backend VLV Index was found but one or more of its properties could not be decoded.

ManagedObjectNotFoundException - If the named Backend VLV Index was not found on the server.

ConcurrentModificationException - If this Pluggable Backend has been removed from the server by another client.

AuthorizationException - If the server refuses to retrieve the named Backend VLV Index because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

createBackendVLVIndex

<C extends BackendVLVIndexCfgClient> C createBackendVLVIndex(ManagedObjectDefinition<C,? extends BackendVLVIndexCfg> d,
                                                           String name,
                                                           Collection<PropertyException> exceptions)
                                                         throws IllegalManagedObjectNameException

Creates a new Backend VLV Index. The new Backend VLV Index will initially not contain any property values (including mandatory properties). Once the Backend VLV Index has been configured it can be added to the server using the ConfigurationClient.commit() method.

Type Parameters:

C - The type of the Backend VLV Index being created.

Parameters:

d - The definition of the Backend VLV Index to be created.

name - The name of the new Backend VLV Index.

exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Backend VLV Index. This argument can be null.

Returns:

Returns a new Backend VLV Index configuration instance.

Throws:

IllegalManagedObjectNameException - If the name of the new Backend VLV Index is invalid.

removeBackendVLVIndex

void removeBackendVLVIndex(String name)
                           throws ManagedObjectNotFoundException,
                                  OperationRejectedException,
                                  ConcurrentModificationException,
                                  AuthorizationException,
                                  CommunicationException

Removes the named Backend VLV Index.

Parameters:

name - The name of the Backend VLV Index to remove.

Throws:

ManagedObjectNotFoundException - If the Backend VLV Index does not exist.

OperationRejectedException - If the server refuses to remove the Backend VLV Index due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).

ConcurrentModificationException - If this Pluggable Backend has been removed from the server by another client.

AuthorizationException - If the server refuses to remove the Backend VLV Index because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.