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.SevenBitCleanPluginCfg;
037    import org.opends.server.types.AttributeType;
038    import org.opends.server.types.DN;
039    
040    
041    
042    /**
043     * A client-side interface for reading and modifying Seven Bit Clean
044     * Plugin settings.
045     * <p>
046     * The Seven Bit Clean Plugin ensures that values for a specified set
047     * of attributes are 7-bit clean.
048     */
049    public interface SevenBitCleanPluginCfgClient extends PluginCfgClient {
050    
051      /**
052       * Get the configuration definition associated with this Seven Bit Clean Plugin.
053       *
054       * @return Returns the configuration definition associated with this Seven Bit Clean Plugin.
055       */
056      ManagedObjectDefinition<? extends SevenBitCleanPluginCfgClient, ? extends SevenBitCleanPluginCfg> definition();
057    
058    
059    
060      /**
061       * Gets the "attribute-type" property.
062       * <p>
063       * Specifies the name or OID of an attribute type for which values
064       * should be checked to ensure that they are 7-bit clean.
065       *
066       * @return Returns the values of the "attribute-type" property.
067       */
068      SortedSet<AttributeType> getAttributeType();
069    
070    
071    
072      /**
073       * Sets the "attribute-type" property.
074       * <p>
075       * Specifies the name or OID of an attribute type for which values
076       * should be checked to ensure that they are 7-bit clean.
077       *
078       * @param values The values of the "attribute-type" property.
079       * @throws IllegalPropertyValueException
080       *           If one or more of the new values are invalid.
081       */
082      void setAttributeType(Collection<AttributeType> values) throws IllegalPropertyValueException;
083    
084    
085    
086      /**
087       * Gets the "base-dn" property.
088       * <p>
089       * Specifies the base DN below which the checking is performed.
090       * <p>
091       * Any attempt to update a value for one of the configured
092       * attributes below this base DN must be 7-bit clean for the
093       * operation to be allowed.
094       *
095       * @return Returns the values of the "base-dn" property.
096       */
097      SortedSet<DN> getBaseDN();
098    
099    
100    
101      /**
102       * Sets the "base-dn" property.
103       * <p>
104       * Specifies the base DN below which the checking is performed.
105       * <p>
106       * Any attempt to update a value for one of the configured
107       * attributes below this base DN must be 7-bit clean for the
108       * operation to be allowed.
109       *
110       * @param values The values of the "base-dn" property.
111       * @throws IllegalPropertyValueException
112       *           If one or more of the new values are invalid.
113       */
114      void setBaseDN(Collection<DN> values) throws IllegalPropertyValueException;
115    
116    
117    
118      /**
119       * Gets the "java-class" property.
120       * <p>
121       * Specifies the fully-qualified name of the Java class that
122       * provides the plug-in implementation.
123       *
124       * @return Returns the value of the "java-class" property.
125       */
126      String getJavaClass();
127    
128    
129    
130      /**
131       * Sets the "java-class" property.
132       * <p>
133       * Specifies the fully-qualified name of the Java class that
134       * provides the plug-in implementation.
135       *
136       * @param value The value of the "java-class" property.
137       * @throws IllegalPropertyValueException
138       *           If the new value is invalid.
139       */
140      void setJavaClass(String value) throws IllegalPropertyValueException;
141    
142    
143    
144      /**
145       * Gets the "plugin-type" property.
146       * <p>
147       * Specifies the set of plug-in types for the plug-in, which
148       * specifies the times at which the plug-in is invoked.
149       *
150       * @return Returns the values of the "plugin-type" property.
151       */
152      SortedSet<PluginType> getPluginType();
153    
154    
155    
156      /**
157       * Sets the "plugin-type" property.
158       * <p>
159       * Specifies the set of plug-in types for the plug-in, which
160       * specifies the times at which the plug-in is invoked.
161       *
162       * @param values The values of the "plugin-type" property.
163       * @throws IllegalPropertyValueException
164       *           If one or more of the new values are invalid.
165       */
166      void setPluginType(Collection<PluginType> values) throws IllegalPropertyValueException;
167    
168    }