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    import org.opends.server.types.AttributeType;
034    
035    
036    
037    /**
038     * A server-side interface for querying Subschema Subentry Virtual
039     * Attribute settings.
040     * <p>
041     * The Subschema Subentry Virtual Attribute generates a virtual
042     * attribute that specifies the location of the subschemaSubentry with
043     * the schema definitions in effect for the entry. This attribute is
044     * defined in RFC 4512.
045     */
046    public interface SubschemaSubentryVirtualAttributeCfg extends VirtualAttributeCfg {
047    
048      /**
049       * Gets the configuration class associated with this Subschema Subentry Virtual Attribute.
050       *
051       * @return Returns the configuration class associated with this Subschema Subentry Virtual Attribute.
052       */
053      Class<? extends SubschemaSubentryVirtualAttributeCfg> configurationClass();
054    
055    
056    
057      /**
058       * Register to be notified when this Subschema Subentry Virtual Attribute is changed.
059       *
060       * @param listener
061       *          The Subschema Subentry Virtual Attribute configuration change listener.
062       */
063      void addSubschemaSubentryChangeListener(ConfigurationChangeListener<SubschemaSubentryVirtualAttributeCfg> listener);
064    
065    
066    
067      /**
068       * Deregister an existing Subschema Subentry Virtual Attribute configuration change listener.
069       *
070       * @param listener
071       *          The Subschema Subentry Virtual Attribute configuration change listener.
072       */
073      void removeSubschemaSubentryChangeListener(ConfigurationChangeListener<SubschemaSubentryVirtualAttributeCfg> listener);
074    
075    
076    
077      /**
078       * Gets the "attribute-type" property.
079       * <p>
080       * Specifies the attribute type for the attribute whose values are
081       * to be dynamically assigned by the virtual attribute.
082       *
083       * @return Returns the value of the "attribute-type" property.
084       */
085      AttributeType getAttributeType();
086    
087    
088    
089      /**
090       * Gets the "conflict-behavior" property.
091       * <p>
092       * Specifies the behavior that the server is to exhibit for entries
093       * that already contain one or more real values for the associated
094       * attribute.
095       *
096       * @return Returns the value of the "conflict-behavior" property.
097       */
098      ConflictBehavior getConflictBehavior();
099    
100    
101    
102      /**
103       * Gets the "java-class" property.
104       * <p>
105       * Specifies the fully-qualified name of the virtual attribute
106       * provider class that generates the attribute values.
107       *
108       * @return Returns the value of the "java-class" property.
109       */
110      String getJavaClass();
111    
112    }