org.opends.server.admin.std.server
Interface LDIFBackendCfg

All Superinterfaces:
BackendCfg, Configuration

public interface LDIFBackendCfg
extends BackendCfg

A server-side interface for querying LDIF Backend settings.

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


Method Summary
 void addLDIFChangeListener(ConfigurationChangeListener<LDIFBackendCfg> listener)
          Register to be notified when this LDIF Backend is changed.
 java.lang.Class<? extends LDIFBackendCfg> configurationClass()
          Gets the configuration class 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 removeLDIFChangeListener(ConfigurationChangeListener<LDIFBackendCfg> listener)
          Deregister an existing LDIF Backend configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.BackendCfg
addChangeListener, getBackendId, getBaseDN, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends LDIFBackendCfg> configurationClass()
Gets the configuration class associated with this LDIF Backend.

Specified by:
configurationClass in interface BackendCfg
Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this LDIF Backend.

addLDIFChangeListener

void addLDIFChangeListener(ConfigurationChangeListener<LDIFBackendCfg> listener)
Register to be notified when this LDIF Backend is changed.

Parameters:
listener - The LDIF Backend configuration change listener.

removeLDIFChangeListener

void removeLDIFChangeListener(ConfigurationChangeListener<LDIFBackendCfg> listener)
Deregister an existing LDIF Backend configuration change listener.

Parameters:
listener - The LDIF Backend configuration change listener.

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.

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 BackendCfg
Returns:
Returns the value of the "java-class" property.

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.

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 BackendCfg
Returns:
Returns the value of the "writability-mode" property.