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.server;
027
028
029
030import org.opends.server.admin.server.ConfigurationChangeListener;
031import org.opends.server.admin.std.meta.VirtualAttributeCfgDefn.ConflictBehavior;
032import org.opends.server.types.AttributeType;
033
034
035
036/**
037 * A server-side interface for querying Governing Structure Rule
038 * Virtual Attribute settings.
039 * <p>
040 * The Governing Structure Rule Virtual Attribute generates a virtual
041 * attribute that specifies the DIT structure rule with the schema
042 * definitions in effect for the entry. This attribute is defined in
043 * RFC 4512.
044 */
045public interface GoverningStructureRuleVirtualAttributeCfg extends VirtualAttributeCfg {
046
047  /**
048   * Gets the configuration class associated with this Governing Structure Rule Virtual Attribute.
049   *
050   * @return Returns the configuration class associated with this Governing Structure Rule Virtual Attribute.
051   */
052  Class<? extends GoverningStructureRuleVirtualAttributeCfg> configurationClass();
053
054
055
056  /**
057   * Register to be notified when this Governing Structure Rule Virtual Attribute is changed.
058   *
059   * @param listener
060   *          The Governing Structure Rule Virtual Attribute configuration change listener.
061   */
062  void addGoverningStructureRuleChangeListener(ConfigurationChangeListener<GoverningStructureRuleVirtualAttributeCfg> listener);
063
064
065
066  /**
067   * Deregister an existing Governing Structure Rule Virtual Attribute configuration change listener.
068   *
069   * @param listener
070   *          The Governing Structure Rule Virtual Attribute configuration change listener.
071   */
072  void removeGoverningStructureRuleChangeListener(ConfigurationChangeListener<GoverningStructureRuleVirtualAttributeCfg> 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}