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
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.admin.std.server;
028    
029    
030    
031    import org.opends.server.admin.server.ConfigurationChangeListener;
032    import org.opends.server.admin.std.meta.VirtualAttributeCfgDefn.ConflictBehavior;
033    
034    
035    
036    /**
037     * A server-side interface for querying Member Virtual Attribute
038     * settings.
039     * <p>
040     * The Member Virtual Attribute generates a member or uniqueMember
041     * attribute whose values are the DNs of the members of a specified
042     * virtual static group.
043     */
044    public interface MemberVirtualAttributeCfg extends VirtualAttributeCfg {
045    
046      /**
047       * Gets the configuration class associated with this Member Virtual Attribute.
048       *
049       * @return Returns the configuration class associated with this Member Virtual Attribute.
050       */
051      Class<? extends MemberVirtualAttributeCfg> configurationClass();
052    
053    
054    
055      /**
056       * Register to be notified when this Member Virtual Attribute is changed.
057       *
058       * @param listener
059       *          The Member Virtual Attribute configuration change listener.
060       */
061      void addMemberChangeListener(ConfigurationChangeListener<MemberVirtualAttributeCfg> listener);
062    
063    
064    
065      /**
066       * Deregister an existing Member Virtual Attribute configuration change listener.
067       *
068       * @param listener
069       *          The Member Virtual Attribute configuration change listener.
070       */
071      void removeMemberChangeListener(ConfigurationChangeListener<MemberVirtualAttributeCfg> listener);
072    
073    
074    
075      /**
076       * Gets the "allow-retrieving-membership" property.
077       * <p>
078       * Indicates whether to handle requests that request all values for
079       * the virtual attribute.
080       * <p>
081       * This operation can be very expensive in some cases and is not
082       * consistent with the primary function of virtual static groups,
083       * which is to make it possible to use static group idioms to
084       * determine whether a given user is a member. If this attribute is
085       * set to false, attempts to retrieve the entire set of values
086       * receive an empty set, and only attempts to determine whether the
087       * attribute has a specific value or set of values (which is the
088       * primary anticipated use for virtual static groups) are handled
089       * properly.
090       *
091       * @return Returns the value of the "allow-retrieving-membership" property.
092       */
093      boolean isAllowRetrievingMembership();
094    
095    
096    
097      /**
098       * Gets the "conflict-behavior" property.
099       * <p>
100       * Specifies the behavior that the server is to exhibit for entries
101       * that already contain one or more real values for the associated
102       * attribute.
103       *
104       * @return Returns the value of the "conflict-behavior" property.
105       */
106      ConflictBehavior getConflictBehavior();
107    
108    
109    
110      /**
111       * Gets the "java-class" property.
112       * <p>
113       * Specifies the fully-qualified name of the virtual attribute
114       * provider class that generates the attribute values.
115       *
116       * @return Returns the value of the "java-class" property.
117       */
118      String getJavaClass();
119    
120    }