org.opends.server.admin.std.client

Interface ExternalChangelogDomainCfgClient

All Superinterfaces:

ConfigurationClient

public interface ExternalChangelogDomainCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying External Changelog Domain settings.

The External Changelog Domain provides configuration of the external changelog for the replication domain.

Method Summary

Methods

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends ExternalChangelogDomainCfgClient,? extends ExternalChangelogDomainCfg>	definition() Get the configuration definition associated with this External Changelog Domain.
SortedSet<String>	getECLInclude() Gets the "ecl-include" property.
SortedSet<String>	getECLIncludeForDeletes() Gets the "ecl-include-for-deletes" property.
Boolean	isEnabled() Gets the "enabled" property.
void	setECLInclude(Collection<String> values) Sets the "ecl-include" property.
void	setECLIncludeForDeletes(Collection<String> values) Sets the "ecl-include-for-deletes" property.
void	setEnabled(boolean value) Sets the "enabled" property.

Methods inherited from interface org.opends.server.admin.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends ExternalChangelogDomainCfgClient,? extends ExternalChangelogDomainCfg> definition()

Get the configuration definition associated with this External Changelog Domain.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this External Changelog Domain.

getECLInclude

SortedSet<String> getECLInclude()

Gets the "ecl-include" property.

Specifies a list of attributes which should be published with every change log entry, regardless of whether or not the attribute itself has changed.

The list of attributes may include wild cards such as "*" and "+" as well as object class references prefixed with an ampersand, for example "@person". The included attributes will be published using the "includedAttributes" operational attribute as a single LDIF value rather like the "changes" attribute. For modify and modifyDN operations the included attributes will be taken from the entry before any changes were applied.

Returns:

Returns the values of the "ecl-include" property.

setECLInclude

void setECLInclude(Collection<String> values)
                   throws PropertyException

Sets the "ecl-include" property.

Specifies a list of attributes which should be published with every change log entry, regardless of whether or not the attribute itself has changed.

The list of attributes may include wild cards such as "*" and "+" as well as object class references prefixed with an ampersand, for example "@person". The included attributes will be published using the "includedAttributes" operational attribute as a single LDIF value rather like the "changes" attribute. For modify and modifyDN operations the included attributes will be taken from the entry before any changes were applied.

Parameters:

values - The values of the "ecl-include" property.

Throws:

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

getECLIncludeForDeletes

SortedSet<String> getECLIncludeForDeletes()

Gets the "ecl-include-for-deletes" property.

Specifies a list of attributes which should be published with every delete operation change log entry, in addition to those specified by the "ecl-include" property.

This property provides a means for applications to archive entries after they have been deleted. See the description of the "ecl-include" property for further information about how the included attributes are published.

Returns:

Returns the values of the "ecl-include-for-deletes" property.

setECLIncludeForDeletes

void setECLIncludeForDeletes(Collection<String> values)
                             throws PropertyException

Sets the "ecl-include-for-deletes" property.

Specifies a list of attributes which should be published with every delete operation change log entry, in addition to those specified by the "ecl-include" property.

This property provides a means for applications to archive entries after they have been deleted. See the description of the "ecl-include" property for further information about how the included attributes are published.

Parameters:

values - The values of the "ecl-include-for-deletes" property.

Throws:

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

isEnabled

Boolean isEnabled()

Gets the "enabled" property.

Indicates whether the External Changelog Domain is enabled. To enable computing the change numbers, set the Replication Server's "ds-cfg-compute-change-number" property to true.

Returns:

Returns the value of the "enabled" property.

setEnabled

void setEnabled(boolean value)
                throws PropertyException

Sets the "enabled" property.

Indicates whether the External Changelog Domain is enabled. To enable computing the change numbers, set the Replication Server's "ds-cfg-compute-change-number" property to true.

Parameters:

value - The value of the "enabled" property.

Throws:

PropertyException - If the new value is invalid.