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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.client;
027
028
029
030import java.util.Collection;
031import java.util.SortedSet;
032import org.opends.server.admin.ManagedObjectDefinition;
033import org.opends.server.admin.PropertyException;
034import org.opends.server.admin.std.meta.PluginCfgDefn.PluginType;
035import org.opends.server.admin.std.server.AttributeCleanupPluginCfg;
036
037
038
039/**
040 * A client-side interface for reading and modifying Attribute Cleanup
041 * Plugin settings.
042 * <p>
043 * A pre-parse plugin which can be used to remove and rename
044 * attributes in ADD and MODIFY requests before being processed.
045 */
046public interface AttributeCleanupPluginCfgClient extends PluginCfgClient {
047
048  /**
049   * Get the configuration definition associated with this Attribute Cleanup Plugin.
050   *
051   * @return Returns the configuration definition associated with this Attribute Cleanup Plugin.
052   */
053  ManagedObjectDefinition<? extends AttributeCleanupPluginCfgClient, ? extends AttributeCleanupPluginCfg> definition();
054
055
056
057  /**
058   * Gets the "invoke-for-internal-operations" property.
059   * <p>
060   * Indicates whether the plug-in should be invoked for internal
061   * operations.
062   * <p>
063   * Any plug-in that can be invoked for internal operations must
064   * ensure that it does not create any new internal operatons that can
065   * cause the same plug-in to be re-invoked.
066   *
067   * @return Returns the value of the "invoke-for-internal-operations" property.
068   */
069  boolean isInvokeForInternalOperations();
070
071
072
073  /**
074   * Sets the "invoke-for-internal-operations" property.
075   * <p>
076   * Indicates whether the plug-in should be invoked for internal
077   * operations.
078   * <p>
079   * Any plug-in that can be invoked for internal operations must
080   * ensure that it does not create any new internal operatons that can
081   * cause the same plug-in to be re-invoked.
082   *
083   * @param value The value of the "invoke-for-internal-operations" property.
084   * @throws PropertyException
085   *           If the new value is invalid.
086   */
087  void setInvokeForInternalOperations(Boolean value) throws PropertyException;
088
089
090
091  /**
092   * Gets the "java-class" property.
093   * <p>
094   * Specifies the fully-qualified name of the Java class that
095   * provides the plug-in implementation.
096   *
097   * @return Returns the value of the "java-class" property.
098   */
099  String getJavaClass();
100
101
102
103  /**
104   * Sets the "java-class" property.
105   * <p>
106   * Specifies the fully-qualified name of the Java class that
107   * provides the plug-in implementation.
108   *
109   * @param value The value of the "java-class" property.
110   * @throws PropertyException
111   *           If the new value is invalid.
112   */
113  void setJavaClass(String value) throws PropertyException;
114
115
116
117  /**
118   * Gets the "plugin-type" property.
119   * <p>
120   * Specifies the set of plug-in types for the plug-in, which
121   * specifies the times at which the plug-in is invoked.
122   *
123   * @return Returns the values of the "plugin-type" property.
124   */
125  SortedSet<PluginType> getPluginType();
126
127
128
129  /**
130   * Sets the "plugin-type" property.
131   * <p>
132   * Specifies the set of plug-in types for the plug-in, which
133   * specifies the times at which the plug-in is invoked.
134   *
135   * @param values The values of the "plugin-type" property.
136   * @throws PropertyException
137   *           If one or more of the new values are invalid.
138   */
139  void setPluginType(Collection<PluginType> values) throws PropertyException;
140
141
142
143  /**
144   * Gets the "remove-inbound-attributes" property.
145   * <p>
146   * A list of attributes which should be removed from incoming add or
147   * modify requests.
148   *
149   * @return Returns the values of the "remove-inbound-attributes" property.
150   */
151  SortedSet<String> getRemoveInboundAttributes();
152
153
154
155  /**
156   * Sets the "remove-inbound-attributes" property.
157   * <p>
158   * A list of attributes which should be removed from incoming add or
159   * modify requests.
160   *
161   * @param values The values of the "remove-inbound-attributes" property.
162   * @throws PropertyException
163   *           If one or more of the new values are invalid.
164   */
165  void setRemoveInboundAttributes(Collection<String> values) throws PropertyException;
166
167
168
169  /**
170   * Gets the "rename-inbound-attributes" property.
171   * <p>
172   * A list of attributes which should be renamed in incoming add or
173   * modify requests.
174   *
175   * @return Returns the values of the "rename-inbound-attributes" property.
176   */
177  SortedSet<String> getRenameInboundAttributes();
178
179
180
181  /**
182   * Sets the "rename-inbound-attributes" property.
183   * <p>
184   * A list of attributes which should be renamed in incoming add or
185   * modify requests.
186   *
187   * @param values The values of the "rename-inbound-attributes" property.
188   * @throws PropertyException
189   *           If one or more of the new values are invalid.
190   */
191  void setRenameInboundAttributes(Collection<String> values) throws PropertyException;
192
193}