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

All Superinterfaces:
BackendCfgClient, ConfigurationClient

public interface LDIFBackendCfgClient
extends BackendCfgClient

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

The LDIF Backend provides a mechanism for interacting with data stored in an LDIF file.


Method Summary
 ManagedObjectDefinition<? extends LDIFBackendCfgClient,? extends LDIFBackendCfg> definition()
          Get the configuration definition associated with this LDIF Backend.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.String getLDIFFile()
          Gets the "ldif-file" property.
 BackendCfgDefn.WritabilityMode getWritabilityMode()
          Gets the "writability-mode" property.
 boolean isIsPrivateBackend()
          Gets the "is-private-backend" property.
 void setIsPrivateBackend(java.lang.Boolean value)
          Sets the "is-private-backend" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setLDIFFile(java.lang.String value)
          Sets the "ldif-file" property.
 void setWritabilityMode(BackendCfgDefn.WritabilityMode value)
          Sets the "writability-mode" property.
 
Methods inherited from interface org.opends.server.admin.std.client.BackendCfgClient
getBackendId, getBaseDN, isEnabled, setBackendId, setBaseDN, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends LDIFBackendCfgClient,? extends LDIFBackendCfg> definition()
Get the configuration definition associated with this LDIF Backend.

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

isIsPrivateBackend

boolean isIsPrivateBackend()
Gets the "is-private-backend" property.

Indicates whether the backend should be considered a private backend, which indicates that it is used for storing operational data rather than user-defined information.

Returns:
Returns the value of the "is-private-backend" property.

setIsPrivateBackend

void setIsPrivateBackend(java.lang.Boolean value)
                         throws IllegalPropertyValueException
Sets the "is-private-backend" property.

Indicates whether the backend should be considered a private backend, which indicates that it is used for storing operational data rather than user-defined information.

Parameters:
value - The value of the "is-private-backend" 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.

Specified by:
getJavaClass in interface BackendCfgClient
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.

Specified by:
setJavaClass in interface BackendCfgClient
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getLDIFFile

java.lang.String getLDIFFile()
Gets the "ldif-file" property.

Specifies the path to the LDIF file containing the data for this backend.

Returns:
Returns the value of the "ldif-file" property.

setLDIFFile

void setLDIFFile(java.lang.String value)
                 throws IllegalPropertyValueException
Sets the "ldif-file" property.

Specifies the path to the LDIF file containing the data for this backend.

Parameters:
value - The value of the "ldif-file" 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.

Specified by:
getWritabilityMode in interface BackendCfgClient
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.

Specified by:
setWritabilityMode in interface BackendCfgClient
Parameters:
value - The value of the "writability-mode" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.