001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.server;
027
028
029
030import java.util.SortedSet;
031import org.opends.server.admin.Configuration;
032import org.opends.server.admin.server.ConfigurationChangeListener;
033
034
035
036/**
037 * A server-side interface for querying External Changelog Domain
038 * settings.
039 * <p>
040 * The External Changelog Domain provides configuration of the
041 * external changelog for the replication domain.
042 */
043public interface ExternalChangelogDomainCfg extends Configuration {
044
045  /**
046   * Gets the configuration class associated with this External Changelog Domain.
047   *
048   * @return Returns the configuration class associated with this External Changelog Domain.
049   */
050  Class<? extends ExternalChangelogDomainCfg> configurationClass();
051
052
053
054  /**
055   * Register to be notified when this External Changelog Domain is changed.
056   *
057   * @param listener
058   *          The External Changelog Domain configuration change listener.
059   */
060  void addChangeListener(ConfigurationChangeListener<ExternalChangelogDomainCfg> listener);
061
062
063
064  /**
065   * Deregister an existing External Changelog Domain configuration change listener.
066   *
067   * @param listener
068   *          The External Changelog Domain configuration change listener.
069   */
070  void removeChangeListener(ConfigurationChangeListener<ExternalChangelogDomainCfg> listener);
071
072
073
074  /**
075   * Gets the "ecl-include" property.
076   * <p>
077   * Specifies a list of attributes which should be published with
078   * every change log entry, regardless of whether or not the attribute
079   * itself has changed.
080   * <p>
081   * The list of attributes may include wild cards such as "*" and "+"
082   * as well as object class references prefixed with an ampersand, for
083   * example "@person". The included attributes will be published using
084   * the "includedAttributes" operational attribute as a single LDIF
085   * value rather like the "changes" attribute. For modify and modifyDN
086   * operations the included attributes will be taken from the entry
087   * before any changes were applied.
088   *
089   * @return Returns an unmodifiable set containing the values of the "ecl-include" property.
090   */
091  SortedSet<String> getECLInclude();
092
093
094
095  /**
096   * Gets the "ecl-include-for-deletes" property.
097   * <p>
098   * Specifies a list of attributes which should be published with
099   * every delete operation change log entry, in addition to those
100   * specified by the "ecl-include" property.
101   * <p>
102   * This property provides a means for applications to archive
103   * entries after they have been deleted. See the description of the
104   * "ecl-include" property for further information about how the
105   * included attributes are published.
106   *
107   * @return Returns an unmodifiable set containing the values of the "ecl-include-for-deletes" property.
108   */
109  SortedSet<String> getECLIncludeForDeletes();
110
111
112
113  /**
114   * Gets the "enabled" property.
115   * <p>
116   * Indicates whether the External Changelog Domain is enabled. To
117   * enable computing the change numbers, set the Replication Server's
118   * "ds-cfg-compute-change-number" property to true.
119   *
120   * @return Returns the value of the "enabled" property.
121   */
122  boolean isEnabled();
123
124}