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