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