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.server;
027
028
029
030import java.util.SortedSet;
031import org.opends.server.admin.server.ConfigurationChangeListener;
032import org.opends.server.admin.std.meta.PluginCfgDefn.PluginType;
033
034
035
036/**
037 * A server-side interface for querying Attribute Cleanup Plugin
038 * settings.
039 * <p>
040 * A pre-parse plugin which can be used to remove and rename
041 * attributes in ADD and MODIFY requests before being processed.
042 */
043public interface AttributeCleanupPluginCfg extends PluginCfg {
044
045  /**
046   * Gets the configuration class associated with this Attribute Cleanup Plugin.
047   *
048   * @return Returns the configuration class associated with this Attribute Cleanup Plugin.
049   */
050  Class<? extends AttributeCleanupPluginCfg> configurationClass();
051
052
053
054  /**
055   * Register to be notified when this Attribute Cleanup Plugin is changed.
056   *
057   * @param listener
058   *          The Attribute Cleanup Plugin configuration change listener.
059   */
060  void addAttributeCleanupChangeListener(ConfigurationChangeListener<AttributeCleanupPluginCfg> listener);
061
062
063
064  /**
065   * Deregister an existing Attribute Cleanup Plugin configuration change listener.
066   *
067   * @param listener
068   *          The Attribute Cleanup Plugin configuration change listener.
069   */
070  void removeAttributeCleanupChangeListener(ConfigurationChangeListener<AttributeCleanupPluginCfg> listener);
071
072
073
074  /**
075   * Gets the "invoke-for-internal-operations" property.
076   * <p>
077   * Indicates whether the plug-in should be invoked for internal
078   * operations.
079   * <p>
080   * Any plug-in that can be invoked for internal operations must
081   * ensure that it does not create any new internal operatons that can
082   * cause the same plug-in to be re-invoked.
083   *
084   * @return Returns the value of the "invoke-for-internal-operations" property.
085   */
086  boolean isInvokeForInternalOperations();
087
088
089
090  /**
091   * Gets the "java-class" property.
092   * <p>
093   * Specifies the fully-qualified name of the Java class that
094   * provides the plug-in implementation.
095   *
096   * @return Returns the value of the "java-class" property.
097   */
098  String getJavaClass();
099
100
101
102  /**
103   * Gets the "plugin-type" property.
104   * <p>
105   * Specifies the set of plug-in types for the plug-in, which
106   * specifies the times at which the plug-in is invoked.
107   *
108   * @return Returns an unmodifiable set containing the values of the "plugin-type" property.
109   */
110  SortedSet<PluginType> getPluginType();
111
112
113
114  /**
115   * Gets the "remove-inbound-attributes" property.
116   * <p>
117   * A list of attributes which should be removed from incoming add or
118   * modify requests.
119   *
120   * @return Returns an unmodifiable set containing the values of the "remove-inbound-attributes" property.
121   */
122  SortedSet<String> getRemoveInboundAttributes();
123
124
125
126  /**
127   * Gets the "rename-inbound-attributes" property.
128   * <p>
129   * A list of attributes which should be renamed in incoming add or
130   * modify requests.
131   *
132   * @return Returns an unmodifiable set containing the values of the "rename-inbound-attributes" property.
133   */
134  SortedSet<String> getRenameInboundAttributes();
135
136}