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.server.ConfigurationChangeListener;
032import org.opends.server.admin.std.meta.PluginCfgDefn.PluginType;
033
034
035
036/**
037 * A server-side interface for querying Last Mod Plugin settings.
038 * <p>
039 * The Last Mod Plugin is used to ensure that the creatorsName and
040 * createTimestamp attributes are included in an entry whenever it is
041 * added to the server and also to ensure that the modifiersName and
042 * modifyTimestamp attributes are updated whenever an entry is modified
043 * or renamed.
044 */
045public interface LastModPluginCfg extends PluginCfg {
046
047  /**
048   * Gets the configuration class associated with this Last Mod Plugin.
049   *
050   * @return Returns the configuration class associated with this Last Mod Plugin.
051   */
052  Class<? extends LastModPluginCfg> configurationClass();
053
054
055
056  /**
057   * Register to be notified when this Last Mod Plugin is changed.
058   *
059   * @param listener
060   *          The Last Mod Plugin configuration change listener.
061   */
062  void addLastModChangeListener(ConfigurationChangeListener<LastModPluginCfg> listener);
063
064
065
066  /**
067   * Deregister an existing Last Mod Plugin configuration change listener.
068   *
069   * @param listener
070   *          The Last Mod Plugin configuration change listener.
071   */
072  void removeLastModChangeListener(ConfigurationChangeListener<LastModPluginCfg> listener);
073
074
075
076  /**
077   * Gets the "java-class" property.
078   * <p>
079   * Specifies the fully-qualified name of the Java class that
080   * provides the plug-in implementation.
081   *
082   * @return Returns the value of the "java-class" property.
083   */
084  String getJavaClass();
085
086
087
088  /**
089   * Gets the "plugin-type" property.
090   * <p>
091   * Specifies the set of plug-in types for the plug-in, which
092   * specifies the times at which the plug-in is invoked.
093   *
094   * @return Returns an unmodifiable set containing the values of the "plugin-type" property.
095   */
096  SortedSet<PluginType> getPluginType();
097
098}