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;
032
033
034
035/**
036 * A server-side interface for querying User Defined Virtual Attribute
037 * settings.
038 * <p>
039 * The User Defined Virtual Attribute creates virtual attributes with
040 * user-defined values in entries that match the criteria defined in
041 * the plug-in's configuration.
042 */
043public interface UserDefinedVirtualAttributeCfg extends VirtualAttributeCfg {
044
045  /**
046   * Gets the configuration class associated with this User Defined Virtual Attribute.
047   *
048   * @return Returns the configuration class associated with this User Defined Virtual Attribute.
049   */
050  Class<? extends UserDefinedVirtualAttributeCfg> configurationClass();
051
052
053
054  /**
055   * Register to be notified when this User Defined Virtual Attribute is changed.
056   *
057   * @param listener
058   *          The User Defined Virtual Attribute configuration change listener.
059   */
060  void addUserDefinedChangeListener(ConfigurationChangeListener<UserDefinedVirtualAttributeCfg> listener);
061
062
063
064  /**
065   * Deregister an existing User Defined Virtual Attribute configuration change listener.
066   *
067   * @param listener
068   *          The User Defined Virtual Attribute configuration change listener.
069   */
070  void removeUserDefinedChangeListener(ConfigurationChangeListener<UserDefinedVirtualAttributeCfg> listener);
071
072
073
074  /**
075   * Gets the "java-class" property.
076   * <p>
077   * Specifies the fully-qualified name of the virtual attribute
078   * provider class that generates the attribute values.
079   *
080   * @return Returns the value of the "java-class" property.
081   */
082  String getJavaClass();
083
084
085
086  /**
087   * Gets the "value" property.
088   * <p>
089   * Specifies the values to be included in the virtual attribute.
090   *
091   * @return Returns an unmodifiable set containing the values of the "value" property.
092   */
093  SortedSet<String> getValue();
094
095}