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