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 org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.meta.VirtualAttributeCfgDefn.ConflictBehavior;
033import org.opends.server.admin.std.server.MemberVirtualAttributeCfg;
034
035
036
037/**
038 * A client-side interface for reading and modifying Member Virtual
039 * Attribute settings.
040 * <p>
041 * The Member Virtual Attribute generates a member or uniqueMember
042 * attribute whose values are the DNs of the members of a specified
043 * virtual static group.
044 */
045public interface MemberVirtualAttributeCfgClient extends VirtualAttributeCfgClient {
046
047  /**
048   * Get the configuration definition associated with this Member Virtual Attribute.
049   *
050   * @return Returns the configuration definition associated with this Member Virtual Attribute.
051   */
052  ManagedObjectDefinition<? extends MemberVirtualAttributeCfgClient, ? extends MemberVirtualAttributeCfg> definition();
053
054
055
056  /**
057   * Gets the "allow-retrieving-membership" property.
058   * <p>
059   * Indicates whether to handle requests that request all values for
060   * the virtual attribute.
061   * <p>
062   * This operation can be very expensive in some cases and is not
063   * consistent with the primary function of virtual static groups,
064   * which is to make it possible to use static group idioms to
065   * determine whether a given user is a member. If this attribute is
066   * set to false, attempts to retrieve the entire set of values
067   * receive an empty set, and only attempts to determine whether the
068   * attribute has a specific value or set of values (which is the
069   * primary anticipated use for virtual static groups) are handled
070   * properly.
071   *
072   * @return Returns the value of the "allow-retrieving-membership" property.
073   */
074  boolean isAllowRetrievingMembership();
075
076
077
078  /**
079   * Sets the "allow-retrieving-membership" property.
080   * <p>
081   * Indicates whether to handle requests that request all values for
082   * the virtual attribute.
083   * <p>
084   * This operation can be very expensive in some cases and is not
085   * consistent with the primary function of virtual static groups,
086   * which is to make it possible to use static group idioms to
087   * determine whether a given user is a member. If this attribute is
088   * set to false, attempts to retrieve the entire set of values
089   * receive an empty set, and only attempts to determine whether the
090   * attribute has a specific value or set of values (which is the
091   * primary anticipated use for virtual static groups) are handled
092   * properly.
093   *
094   * @param value The value of the "allow-retrieving-membership" property.
095   * @throws PropertyException
096   *           If the new value is invalid.
097   */
098  void setAllowRetrievingMembership(boolean value) throws PropertyException;
099
100
101
102  /**
103   * Gets the "conflict-behavior" property.
104   * <p>
105   * Specifies the behavior that the server is to exhibit for entries
106   * that already contain one or more real values for the associated
107   * attribute.
108   *
109   * @return Returns the value of the "conflict-behavior" property.
110   */
111  ConflictBehavior getConflictBehavior();
112
113
114
115  /**
116   * Sets the "conflict-behavior" property.
117   * <p>
118   * Specifies the behavior that the server is to exhibit for entries
119   * that already contain one or more real values for the associated
120   * attribute.
121   *
122   * @param value The value of the "conflict-behavior" property.
123   * @throws PropertyException
124   *           If the new value is invalid.
125   */
126  void setConflictBehavior(ConflictBehavior value) throws PropertyException;
127
128
129
130  /**
131   * Gets the "java-class" property.
132   * <p>
133   * Specifies the fully-qualified name of the virtual attribute
134   * provider class that generates the attribute values.
135   *
136   * @return Returns the value of the "java-class" property.
137   */
138  String getJavaClass();
139
140
141
142  /**
143   * Sets the "java-class" property.
144   * <p>
145   * Specifies the fully-qualified name of the virtual attribute
146   * provider class that generates the attribute values.
147   *
148   * @param value The value of the "java-class" property.
149   * @throws PropertyException
150   *           If the new value is invalid.
151   */
152  void setJavaClass(String value) throws PropertyException;
153
154}