Package org.forgerock.opendj.server.config.client

Interface LDIFBackendCfgClient

All Superinterfaces:

BackendCfgClient, ConfigurationClient, LocalBackendCfgClient

public interface LDIFBackendCfgClient
extends LocalBackendCfgClient

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

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends LDIFBackendCfgClient,? extends LDIFBackendCfg>	definition()	Get the configuration definition associated with this LDIF Backend.
String	getJavaClass()	Gets the "java-class" property.
String	getLDIFFile()	Gets the "ldif-file" property.
LocalBackendCfgDefn.WritabilityMode	getWritabilityMode()	Gets the "writability-mode" property.
boolean	isIsPrivateBackend()	Gets the "is-private-backend" property.
void	setIsPrivateBackend(Boolean value)	Sets the "is-private-backend" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setLDIFFile(String value)	Sets the "ldif-file" property.
void	setWritabilityMode(LocalBackendCfgDefn.WritabilityMode value)	Sets the "writability-mode" property.

Methods inherited from interface org.forgerock.opendj.server.config.client.BackendCfgClient

getBackendId, getBaseDN, isEnabled, setBackendId, setBaseDN, setEnabled

Methods inherited from interface org.forgerock.opendj.config.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

Specified by:

definition in interface LocalBackendCfgClient

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(Boolean value)
                  throws PropertyException

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:

PropertyException - If the new value is invalid.

getJavaClass

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

Specified by:

getJavaClass in interface LocalBackendCfgClient

Returns:

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

setJavaClass

void setJavaClass(String value)
           throws PropertyException

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

Specified by:

setJavaClass in interface LocalBackendCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

getLDIFFile

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(String value)
          throws PropertyException

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:

PropertyException - If the new value is invalid.

getWritabilityMode

LocalBackendCfgDefn.WritabilityMode getWritabilityMode()

Gets the "writability-mode" property.

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

Specified by:

getWritabilityMode in interface LocalBackendCfgClient

Returns:

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

setWritabilityMode

void setWritabilityMode(LocalBackendCfgDefn.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 LocalBackendCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.