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.Configuration;
033    import org.opends.server.admin.server.ConfigurationChangeListener;
034    import org.opends.server.admin.std.meta.PluginCfgDefn.PluginType;
035    
036    
037    
038    /**
039     * A server-side interface for querying Plugin settings.
040     * <p>
041     * Plugins provide a mechanism for executing custom code at specified
042     * points in operation processing and in the course of other events
043     * like connection establishment and termination, server startup and
044     * shutdown, and LDIF import and export.
045     */
046    public interface PluginCfg extends Configuration {
047    
048      /**
049       * Gets the configuration class associated with this Plugin.
050       *
051       * @return Returns the configuration class associated with this Plugin.
052       */
053      Class<? extends PluginCfg> configurationClass();
054    
055    
056    
057      /**
058       * Register to be notified when this Plugin is changed.
059       *
060       * @param listener
061       *          The Plugin configuration change listener.
062       */
063      void addChangeListener(ConfigurationChangeListener<PluginCfg> listener);
064    
065    
066    
067      /**
068       * Deregister an existing Plugin configuration change listener.
069       *
070       * @param listener
071       *          The Plugin configuration change listener.
072       */
073      void removeChangeListener(ConfigurationChangeListener<PluginCfg> listener);
074    
075    
076    
077      /**
078       * Gets the "enabled" property.
079       * <p>
080       * Indicates whether the plug-in is enabled for use.
081       *
082       * @return Returns the value of the "enabled" property.
083       */
084      boolean isEnabled();
085    
086    
087    
088      /**
089       * Gets the "invoke-for-internal-operations" property.
090       * <p>
091       * Indicates whether the plug-in should be invoked for internal
092       * operations.
093       * <p>
094       * Any plug-in that can be invoked for internal operations must
095       * ensure that it does not create any new internal operatons that can
096       * cause the same plug-in to be re-invoked.
097       *
098       * @return Returns the value of the "invoke-for-internal-operations" property.
099       */
100      boolean isInvokeForInternalOperations();
101    
102    
103    
104      /**
105       * Gets the "java-class" property.
106       * <p>
107       * Specifies the fully-qualified name of the Java class that
108       * provides the plug-in implementation.
109       *
110       * @return Returns the value of the "java-class" property.
111       */
112      String getJavaClass();
113    
114    
115    
116      /**
117       * Gets the "plugin-type" property.
118       * <p>
119       * Specifies the set of plug-in types for the plug-in, which
120       * specifies the times at which the plug-in is invoked.
121       *
122       * @return Returns an unmodifiable set containing the values of the "plugin-type" property.
123       */
124      SortedSet<PluginType> getPluginType();
125    
126    }