001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.server;
017
018
019
020import java.util.SortedSet;
021import org.forgerock.opendj.config.server.ConfigurationChangeListener;
022import org.forgerock.opendj.server.config.meta.PluginCfgDefn.PluginType;
023
024
025
026/**
027 * A server-side interface for querying Change Number Control Plugin
028 * settings.
029 * <p>
030 * The Change Number Control Plugin returns the change number
031 * generated by the replication subsystem.
032 */
033public interface ChangeNumberControlPluginCfg extends PluginCfg {
034
035  /**
036   * Gets the configuration class associated with this Change Number Control Plugin.
037   *
038   * @return Returns the configuration class associated with this Change Number Control Plugin.
039   */
040  Class<? extends ChangeNumberControlPluginCfg> configurationClass();
041
042
043
044  /**
045   * Register to be notified when this Change Number Control Plugin is changed.
046   *
047   * @param listener
048   *          The Change Number Control Plugin configuration change listener.
049   */
050  void addChangeNumberControlChangeListener(ConfigurationChangeListener<ChangeNumberControlPluginCfg> listener);
051
052
053
054  /**
055   * Deregister an existing Change Number Control Plugin configuration change listener.
056   *
057   * @param listener
058   *          The Change Number Control Plugin configuration change listener.
059   */
060  void removeChangeNumberControlChangeListener(ConfigurationChangeListener<ChangeNumberControlPluginCfg> listener);
061
062
063
064  /**
065   * Gets the "java-class" property.
066   * <p>
067   * Specifies the fully-qualified name of the Java class that
068   * provides the plug-in implementation.
069   *
070   * @return Returns the value of the "java-class" property.
071   */
072  String getJavaClass();
073
074
075
076  /**
077   * Gets the "plugin-type" property.
078   * <p>
079   * Specifies the set of plug-in types for the plug-in, which
080   * specifies the times at which the plug-in is invoked.
081   *
082   * @return Returns an unmodifiable set containing the values of the "plugin-type" property.
083   */
084  SortedSet<PluginType> getPluginType();
085
086}