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.
SortedSet<ValueOrExpression<Dn>>	getBaseDn()	Gets the "base-dn" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<String>	getLdifFile()	Gets the "ldif-file" property.
ValueOrExpression<LocalBackendCfgDefn.WritabilityMode>	getWritabilityMode()	Gets the "writability-mode" property.
ValueOrExpression<Boolean>	isIsPrivateBackend()	Gets the "is-private-backend" property.
void	setBaseDn(Collection<ValueOrExpression<Dn>> values)	Sets the "base-dn" property.
void	setIsPrivateBackend(ValueOrExpression<Boolean> value)	Sets the "is-private-backend" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setLdifFile(ValueOrExpression<String> value)	Sets the "ldif-file" property.
void	setWritabilityMode(ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> value)	Sets the "writability-mode" property.

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

getBackendId, isEnabled, setBackendId, 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.

getBaseDn

@MandatoryProperty
SortedSet<ValueOrExpression<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

@MandatoryProperty
void setBaseDn(Collection<ValueOrExpression<Dn>> values)
        throws PropertyException

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:

PropertyException - If one or more of the new values are invalid.

isIsPrivateBackend

ValueOrExpression<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.

Default value: false

Returns:

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

setIsPrivateBackend

void setIsPrivateBackend(ValueOrExpression<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

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.backends.LDIFBackend

Specified by:

getJavaClass in interface BackendCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getLdifFile

@MandatoryProperty
ValueOrExpression<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

@MandatoryProperty
void setLdifFile(ValueOrExpression<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

@MandatoryProperty
ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> getWritabilityMode()

Gets the "writability-mode" property.

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

Default value: enabled

Specified by:

getWritabilityMode in interface LocalBackendCfgClient

Returns:

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

setWritabilityMode

@MandatoryProperty
void setWritabilityMode(ValueOrExpression<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.