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.server.UserDefinedVirtualAttributeCfg;
035
036
037
038/**
039 * A client-side interface for reading and modifying User Defined
040 * Virtual Attribute settings.
041 * <p>
042 * The User Defined Virtual Attribute creates virtual attributes with
043 * user-defined values in entries that match the criteria defined in
044 * the plug-in's configuration.
045 */
046public interface UserDefinedVirtualAttributeCfgClient extends VirtualAttributeCfgClient {
047
048  /**
049   * Get the configuration definition associated with this User Defined Virtual Attribute.
050   *
051   * @return Returns the configuration definition associated with this User Defined Virtual Attribute.
052   */
053  ManagedObjectDefinition<? extends UserDefinedVirtualAttributeCfgClient, ? extends UserDefinedVirtualAttributeCfg> definition();
054
055
056
057  /**
058   * Gets the "java-class" property.
059   * <p>
060   * Specifies the fully-qualified name of the virtual attribute
061   * provider class that generates the attribute values.
062   *
063   * @return Returns the value of the "java-class" property.
064   */
065  String getJavaClass();
066
067
068
069  /**
070   * Sets the "java-class" property.
071   * <p>
072   * Specifies the fully-qualified name of the virtual attribute
073   * provider class that generates the attribute values.
074   *
075   * @param value The value of the "java-class" property.
076   * @throws PropertyException
077   *           If the new value is invalid.
078   */
079  void setJavaClass(String value) throws PropertyException;
080
081
082
083  /**
084   * Gets the "value" property.
085   * <p>
086   * Specifies the values to be included in the virtual attribute.
087   *
088   * @return Returns the values of the "value" property.
089   */
090  SortedSet<String> getValue();
091
092
093
094  /**
095   * Sets the "value" property.
096   * <p>
097   * Specifies the values to be included in the virtual attribute.
098   *
099   * @param values The values of the "value" property.
100   * @throws PropertyException
101   *           If one or more of the new values are invalid.
102   */
103  void setValue(Collection<String> values) throws PropertyException;
104
105}