|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BackendCfgClient
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 |
---|
ManagedObjectDefinition<? extends BackendCfgClient,? extends BackendCfg> definition()
definition
in interface ConfigurationClient
java.lang.String getBackendId()
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.
void setBackendId(java.lang.String value) throws IllegalPropertyValueException, PropertyIsReadOnlyException
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.
value
- The value of the "backend-id" property.
IllegalPropertyValueException
- If the new value is invalid.
PropertyIsReadOnlyException
- If this Backend is not being initialized.java.util.SortedSet<DN> getBaseDN()
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.
void setBaseDN(java.util.Collection<DN> values) throws IllegalPropertyValueException
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.
values
- The values of the "base-dn" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.java.lang.Boolean isEnabled()
Indicates whether the backend is enabled in the server.
If a backend is not enabled, then its contents are not accessible when processing operations.
void setEnabled(boolean value) throws IllegalPropertyValueException
Indicates whether the backend is enabled in the server.
If a backend is not enabled, then its contents are not accessible when processing operations.
value
- The value of the "enabled" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
void setJavaClass(java.lang.String value) throws IllegalPropertyValueException
Specifies the fully-qualified name of the Java class that provides the backend implementation.
value
- The value of the "java-class" property.
IllegalPropertyValueException
- If the new value is invalid.BackendCfgDefn.WritabilityMode getWritabilityMode()
Specifies the behavior that the backend should use when processing write operations.
void setWritabilityMode(BackendCfgDefn.WritabilityMode value) throws IllegalPropertyValueException
Specifies the behavior that the backend should use when processing write operations.
value
- The value of the "writability-mode" property.
IllegalPropertyValueException
- If the new value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |