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