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.LastModPluginCfg;
026
027
028
029/**
030 * A client-side interface for reading and modifying Last Mod Plugin
031 * settings.
032 * <p>
033 * The Last Mod Plugin is used to ensure that the creatorsName and
034 * createTimestamp attributes are included in an entry whenever it is
035 * added to the server and also to ensure that the modifiersName and
036 * modifyTimestamp attributes are updated whenever an entry is modified
037 * or renamed.
038 */
039public interface LastModPluginCfgClient extends PluginCfgClient {
040
041  /**
042   * Get the configuration definition associated with this Last Mod Plugin.
043   *
044   * @return Returns the configuration definition associated with this Last Mod Plugin.
045   */
046  ManagedObjectDefinition<? extends LastModPluginCfgClient, ? extends LastModPluginCfg> definition();
047
048
049
050  /**
051   * Gets the "java-class" property.
052   * <p>
053   * Specifies the fully-qualified name of the Java class that
054   * provides the plug-in implementation.
055   *
056   * @return Returns the value of the "java-class" property.
057   */
058  String getJavaClass();
059
060
061
062  /**
063   * Sets the "java-class" property.
064   * <p>
065   * Specifies the fully-qualified name of the Java class that
066   * provides the plug-in implementation.
067   *
068   * @param value The value of the "java-class" property.
069   * @throws PropertyException
070   *           If the new value is invalid.
071   */
072  void setJavaClass(String value) throws PropertyException;
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 the values of the "plugin-type" property.
083   */
084  SortedSet<PluginType> getPluginType();
085
086
087
088  /**
089   * Sets 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   * @param values The values of the "plugin-type" property.
095   * @throws PropertyException
096   *           If one or more of the new values are invalid.
097   */
098  void setPluginType(Collection<PluginType> values) throws PropertyException;
099
100}