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 java.util.SortedSet;
031import org.opends.server.admin.server.ConfigurationChangeListener;
032import org.opends.server.admin.std.meta.EntityTagVirtualAttributeCfgDefn.ChecksumAlgorithm;
033import org.opends.server.admin.std.meta.VirtualAttributeCfgDefn.ConflictBehavior;
034import org.opends.server.types.AttributeType;
035
036
037
038/**
039 * A server-side interface for querying Entity Tag Virtual Attribute
040 * settings.
041 * <p>
042 * The Entity Tag Virtual Attribute ensures that all entries contain
043 * an "entity tag" or "Etag" as defined in section 3.11 of RFC 2616.
044 */
045public interface EntityTagVirtualAttributeCfg extends VirtualAttributeCfg {
046
047  /**
048   * Gets the configuration class associated with this Entity Tag Virtual Attribute.
049   *
050   * @return Returns the configuration class associated with this Entity Tag Virtual Attribute.
051   */
052  Class<? extends EntityTagVirtualAttributeCfg> configurationClass();
053
054
055
056  /**
057   * Register to be notified when this Entity Tag Virtual Attribute is changed.
058   *
059   * @param listener
060   *          The Entity Tag Virtual Attribute configuration change listener.
061   */
062  void addEntityTagChangeListener(ConfigurationChangeListener<EntityTagVirtualAttributeCfg> listener);
063
064
065
066  /**
067   * Deregister an existing Entity Tag Virtual Attribute configuration change listener.
068   *
069   * @param listener
070   *          The Entity Tag Virtual Attribute configuration change listener.
071   */
072  void removeEntityTagChangeListener(ConfigurationChangeListener<EntityTagVirtualAttributeCfg> 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 "checksum-algorithm" property.
090   * <p>
091   * The algorithm which should be used for calculating the entity tag
092   * checksum value.
093   *
094   * @return Returns the value of the "checksum-algorithm" property.
095   */
096  ChecksumAlgorithm getChecksumAlgorithm();
097
098
099
100  /**
101   * Gets the "conflict-behavior" property.
102   * <p>
103   * Specifies the behavior that the server is to exhibit for entries
104   * that already contain one or more real values for the associated
105   * attribute.
106   *
107   * @return Returns the value of the "conflict-behavior" property.
108   */
109  ConflictBehavior getConflictBehavior();
110
111
112
113  /**
114   * Gets the "excluded-attribute" property.
115   * <p>
116   * The list of attributes which should be ignored when calculating
117   * the entity tag checksum value.
118   * <p>
119   * Certain attributes like "ds-sync-hist" may vary between replicas
120   * due to different purging schedules and should not be included in
121   * the checksum.
122   *
123   * @return Returns an unmodifiable set containing the values of the "excluded-attribute" property.
124   */
125  SortedSet<AttributeType> getExcludedAttribute();
126
127
128
129  /**
130   * Gets the "java-class" property.
131   * <p>
132   * Specifies the fully-qualified name of the virtual attribute
133   * provider class that generates the attribute values.
134   *
135   * @return Returns the value of the "java-class" property.
136   */
137  String getJavaClass();
138
139}