org.opends.server.admin.std.client
Interface BackendCfgClient

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
BackupBackendCfgClient, ConfigFileHandlerBackendCfgClient, LDIFBackendCfgClient, LocalDBBackendCfgClient, MemoryBackendCfgClient, MonitorBackendCfgClient, SchemaBackendCfgClient, TaskBackendCfgClient, TrustStoreBackendCfgClient

public interface BackendCfgClient
extends ConfigurationClient

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

Backends are responsible for providing access to the underlying data presented by the server.


Method Summary
 ManagedObjectDefinition<? extends BackendCfgClient,? extends BackendCfg> definition()
          Get the configuration definition associated with this Backend.
 java.lang.String getBackendId()
          Gets the "backend-id" property.
 java.util.SortedSet<DN> getBaseDN()
          Gets the "base-dn" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 BackendCfgDefn.WritabilityMode getWritabilityMode()
          Gets the "writability-mode" property.
 java.lang.Boolean isEnabled()
          Gets the "enabled" property.
 void setBackendId(java.lang.String value)
          Sets the "backend-id" property.
 void setBaseDN(java.util.Collection<DN> values)
          Sets the "base-dn" property.
 void setEnabled(boolean value)
          Sets the "enabled" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setWritabilityMode(BackendCfgDefn.WritabilityMode value)
          Sets the "writability-mode" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends BackendCfgClient,? extends BackendCfg> definition()
Get the configuration definition associated with this Backend.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Backend.

getBackendId

java.lang.String getBackendId()
Gets the "backend-id" property.

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 value of the "backend-id" property.

setBackendId

void setBackendId(java.lang.String value)
                  throws IllegalPropertyValueException,
                         PropertyIsReadOnlyException
Sets the "backend-id" property.

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.

This property is read-only and can only be modified during creation of a Backend.

Parameters:
value - The value of the "backend-id" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.
PropertyIsReadOnlyException - If this Backend is not being initialized.

getBaseDN

java.util.SortedSet<DN> getBaseDN()
Gets the "base-dn" property.

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 values of the "base-dn" property.

setBaseDN

void setBaseDN(java.util.Collection<DN> values)
               throws IllegalPropertyValueException
Sets the "base-dn" property.

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.

Parameters:
values - The values of the "base-dn" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

isEnabled

java.lang.Boolean isEnabled()
Gets the "enabled" property.

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

setEnabled

void setEnabled(boolean value)
                throws IllegalPropertyValueException
Sets the "enabled" property.

Indicates whether the backend is enabled in the server.

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

Parameters:
value - The value of the "enabled" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

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

Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

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

Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - 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.

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

setWritabilityMode

void setWritabilityMode(BackendCfgDefn.WritabilityMode value)
                        throws IllegalPropertyValueException
Sets the "writability-mode" property.

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

Parameters:
value - The value of the "writability-mode" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.