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