Package org.forgerock.opendj.server.config.meta

Class ExternalChangelogDomainCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<ExternalChangelogDomainCfgClient,ExternalChangelogDomainCfg>

org.forgerock.opendj.server.config.meta.ExternalChangelogDomainCfgDefn

public final class ExternalChangelogDomainCfgDefn
extends ManagedObjectDefinition<ExternalChangelogDomainCfgClient,ExternalChangelogDomainCfg>

An interface for querying the External Changelog Domain managed object definition meta information.

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

Method Summary

Modifier and Type	Method	Description
ExternalChangelogDomainCfgClient	createClientConfiguration(ManagedObject<? extends ExternalChangelogDomainCfgClient> impl)	Creates a client configuration view of the provided managed object.
ExternalChangelogDomainCfg	createServerConfiguration(ServerManagedObject<? extends ExternalChangelogDomainCfg> impl)	Creates a server configuration view of the provided server managed object.
StringPropertyDefinition	getECLIncludeForDeletesPropertyDefinition()	Get the "ecl-include-for-deletes" property definition.
StringPropertyDefinition	getECLIncludePropertyDefinition()	Get the "ecl-include" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static ExternalChangelogDomainCfgDefn	getInstance()	Get the External Changelog Domain configuration definition singleton.
Class<ExternalChangelogDomainCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static ExternalChangelogDomainCfgDefn getInstance()

Get the External Changelog Domain configuration definition singleton.

Returns:

Returns the External Changelog Domain configuration definition singleton.

createClientConfiguration

public ExternalChangelogDomainCfgClient createClientConfiguration(ManagedObject<? extends ExternalChangelogDomainCfgClient> impl)

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<ExternalChangelogDomainCfgClient,ExternalChangelogDomainCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public ExternalChangelogDomainCfg createServerConfiguration(ServerManagedObject<? extends ExternalChangelogDomainCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<ExternalChangelogDomainCfgClient,ExternalChangelogDomainCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<ExternalChangelogDomainCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<ExternalChangelogDomainCfgClient,ExternalChangelogDomainCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getECLIncludePropertyDefinition

public StringPropertyDefinition getECLIncludePropertyDefinition()

Get the "ecl-include" property definition.

Specifies a list of attributes which should be published with every change log entry, regardless of whether 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 "ecl-include" property definition.

getECLIncludeForDeletesPropertyDefinition

public StringPropertyDefinition getECLIncludeForDeletesPropertyDefinition()

Get the "ecl-include-for-deletes" property definition.

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 "ecl-include-for-deletes" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

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 "enabled" property definition.