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    import org.opends.server.types.AttributeType;
035    import org.opends.server.types.DN;
036    
037    
038    
039    /**
040     * A server-side interface for querying Unique Attribute Plugin
041     * settings.
042     * <p>
043     * The Unique Attribute Plugin enforces constraints on the value of an
044     * attribute within a portion of the directory.
045     */
046    public interface UniqueAttributePluginCfg extends PluginCfg {
047    
048      /**
049       * Gets the configuration class associated with this Unique Attribute Plugin.
050       *
051       * @return Returns the configuration class associated with this Unique Attribute Plugin.
052       */
053      Class<? extends UniqueAttributePluginCfg> configurationClass();
054    
055    
056    
057      /**
058       * Register to be notified when this Unique Attribute Plugin is changed.
059       *
060       * @param listener
061       *          The Unique Attribute Plugin configuration change listener.
062       */
063      void addUniqueAttributeChangeListener(ConfigurationChangeListener<UniqueAttributePluginCfg> listener);
064    
065    
066    
067      /**
068       * Deregister an existing Unique Attribute Plugin configuration change listener.
069       *
070       * @param listener
071       *          The Unique Attribute Plugin configuration change listener.
072       */
073      void removeUniqueAttributeChangeListener(ConfigurationChangeListener<UniqueAttributePluginCfg> listener);
074    
075    
076    
077      /**
078       * Gets the "base-dn" property.
079       * <p>
080       * Specifies a base DN within which the attribute must be unique.
081       *
082       * @return Returns an unmodifiable set containing the values of the "base-dn" property.
083       */
084      SortedSet<DN> getBaseDN();
085    
086    
087    
088      /**
089       * Gets the "java-class" property.
090       * <p>
091       * Specifies the fully-qualified name of the Java class that
092       * provides the plug-in implementation.
093       *
094       * @return Returns the value of the "java-class" property.
095       */
096      String getJavaClass();
097    
098    
099    
100      /**
101       * Gets the "plugin-type" property.
102       * <p>
103       * Specifies the set of plug-in types for the plug-in, which
104       * specifies the times at which the plug-in is invoked.
105       *
106       * @return Returns an unmodifiable set containing the values of the "plugin-type" property.
107       */
108      SortedSet<PluginType> getPluginType();
109    
110    
111    
112      /**
113       * Gets the "type" property.
114       * <p>
115       * Specifies the type of attributes to check for value uniqueness.
116       *
117       * @return Returns an unmodifiable set containing the values of the "type" property.
118       */
119      SortedSet<AttributeType> getType();
120    
121    }