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.client;
017
018
019
020import java.util.Collection;
021import java.util.SortedSet;
022import org.forgerock.opendj.config.ManagedObjectDefinition;
023import org.forgerock.opendj.config.PropertyException;
024import org.forgerock.opendj.server.config.meta.PluginCfgDefn.PluginType;
025import org.forgerock.opendj.server.config.server.ChangeNumberControlPluginCfg;
026
027
028
029/**
030 * A client-side interface for reading and modifying Change Number
031 * Control Plugin settings.
032 * <p>
033 * The Change Number Control Plugin returns the change number
034 * generated by the replication subsystem.
035 */
036public interface ChangeNumberControlPluginCfgClient extends PluginCfgClient {
037
038  /**
039   * Get the configuration definition associated with this Change Number Control Plugin.
040   *
041   * @return Returns the configuration definition associated with this Change Number Control Plugin.
042   */
043  ManagedObjectDefinition<? extends ChangeNumberControlPluginCfgClient, ? extends ChangeNumberControlPluginCfg> definition();
044
045
046
047  /**
048   * Gets the "java-class" property.
049   * <p>
050   * Specifies the fully-qualified name of the Java class that
051   * provides the plug-in implementation.
052   *
053   * @return Returns the value of the "java-class" property.
054   */
055  String getJavaClass();
056
057
058
059  /**
060   * Sets the "java-class" property.
061   * <p>
062   * Specifies the fully-qualified name of the Java class that
063   * provides the plug-in implementation.
064   *
065   * @param value The value of the "java-class" property.
066   * @throws PropertyException
067   *           If the new value is invalid.
068   */
069  void setJavaClass(String value) throws PropertyException;
070
071
072
073  /**
074   * Gets the "plugin-type" property.
075   * <p>
076   * Specifies the set of plug-in types for the plug-in, which
077   * specifies the times at which the plug-in is invoked.
078   *
079   * @return Returns the values of the "plugin-type" property.
080   */
081  SortedSet<PluginType> getPluginType();
082
083
084
085  /**
086   * Sets the "plugin-type" property.
087   * <p>
088   * Specifies the set of plug-in types for the plug-in, which
089   * specifies the times at which the plug-in is invoked.
090   *
091   * @param values The values of the "plugin-type" property.
092   * @throws PropertyException
093   *           If one or more of the new values are invalid.
094   */
095  void setPluginType(Collection<PluginType> values) throws PropertyException;
096
097}