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
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.admin.std.client;
028
029
030
031 import java.util.Collection;
032 import java.util.SortedSet;
033 import org.opends.server.admin.IllegalPropertyValueException;
034 import org.opends.server.admin.ManagedObjectDefinition;
035 import org.opends.server.admin.std.meta.PluginCfgDefn.PluginType;
036 import org.opends.server.admin.std.server.LastModPluginCfg;
037
038
039
040 /**
041 * A client-side interface for reading and modifying Last Mod Plugin
042 * settings.
043 * <p>
044 * The Last Mod Plugin is used to ensure that the creatorsName and
045 * createTimestamp attributes are included in an entry whenever it is
046 * added to the server and also to ensure that the modifiersName and
047 * modifyTimestamp attributes are updated whenever an entry is modified
048 * or renamed.
049 */
050 public interface LastModPluginCfgClient extends PluginCfgClient {
051
052 /**
053 * Get the configuration definition associated with this Last Mod Plugin.
054 *
055 * @return Returns the configuration definition associated with this Last Mod Plugin.
056 */
057 ManagedObjectDefinition<? extends LastModPluginCfgClient, ? extends LastModPluginCfg> definition();
058
059
060
061 /**
062 * Gets the "java-class" property.
063 * <p>
064 * Specifies the fully-qualified name of the Java class that
065 * provides the plug-in implementation.
066 *
067 * @return Returns the value of the "java-class" property.
068 */
069 String getJavaClass();
070
071
072
073 /**
074 * Sets the "java-class" property.
075 * <p>
076 * Specifies the fully-qualified name of the Java class that
077 * provides the plug-in implementation.
078 *
079 * @param value The value of the "java-class" property.
080 * @throws IllegalPropertyValueException
081 * If the new value is invalid.
082 */
083 void setJavaClass(String value) throws IllegalPropertyValueException;
084
085
086
087 /**
088 * Gets the "plugin-type" property.
089 * <p>
090 * Specifies the set of plug-in types for the plug-in, which
091 * specifies the times at which the plug-in is invoked.
092 *
093 * @return Returns the values of the "plugin-type" property.
094 */
095 SortedSet<PluginType> getPluginType();
096
097
098
099 /**
100 * Sets the "plugin-type" property.
101 * <p>
102 * Specifies the set of plug-in types for the plug-in, which
103 * specifies the times at which the plug-in is invoked.
104 *
105 * @param values The values of the "plugin-type" property.
106 * @throws IllegalPropertyValueException
107 * If one or more of the new values are invalid.
108 */
109 void setPluginType(Collection<PluginType> values) throws IllegalPropertyValueException;
110
111 }