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 Entry UUID Plugin settings.
039     * <p>
040     * The Entry UUID Plugin generates values for the entryUUID
041     * operational attribute whenever an entry is added via protocol or
042     * imported from LDIF.
043     */
044    public interface EntryUUIDPluginCfg extends PluginCfg {
045    
046      /**
047       * Gets the configuration class associated with this Entry UUID Plugin.
048       *
049       * @return Returns the configuration class associated with this Entry UUID Plugin.
050       */
051      Class<? extends EntryUUIDPluginCfg> configurationClass();
052    
053    
054    
055      /**
056       * Register to be notified when this Entry UUID Plugin is changed.
057       *
058       * @param listener
059       *          The Entry UUID Plugin configuration change listener.
060       */
061      void addEntryUUIDChangeListener(ConfigurationChangeListener<EntryUUIDPluginCfg> listener);
062    
063    
064    
065      /**
066       * Deregister an existing Entry UUID Plugin configuration change listener.
067       *
068       * @param listener
069       *          The Entry UUID Plugin configuration change listener.
070       */
071      void removeEntryUUIDChangeListener(ConfigurationChangeListener<EntryUUIDPluginCfg> listener);
072    
073    
074    
075      /**
076       * Gets the "java-class" property.
077       * <p>
078       * Specifies the fully-qualified name of the Java class that
079       * provides the plug-in implementation.
080       *
081       * @return Returns the value of the "java-class" property.
082       */
083      String getJavaClass();
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 an unmodifiable set containing the values of the "plugin-type" property.
094       */
095      SortedSet<PluginType> getPluginType();
096    
097    }