Package org.forgerock.opendj.server.config.server

Interface EntityTagVirtualAttributeCfg

  • All Superinterfaces:
    Configuration, VirtualAttributeCfg
    public interface EntityTagVirtualAttributeCfg
extends VirtualAttributeCfg
    A server-side interface for querying Entity Tag Virtual Attribute settings.

    The Entity Tag Virtual Attribute ensures that all entries contain an "entity tag" or "Etag" as defined in section 3.11 of RFC 2616.

    • Method Detail

      • addEntityTagChangeListener

        void addEntityTagChangeListener​(ConfigurationChangeListener<EntityTagVirtualAttributeCfg> listener)
        Register to be notified when this Entity Tag Virtual Attribute is changed.
        Parameters:
        listener - The Entity Tag Virtual Attribute configuration change listener.

      • removeEntityTagChangeListener

        void removeEntityTagChangeListener​(ConfigurationChangeListener<EntityTagVirtualAttributeCfg> listener)
        Deregister an existing Entity Tag Virtual Attribute configuration change listener.
        Parameters:
        listener - The Entity Tag Virtual Attribute configuration change listener.

      • getAttributeType

        org.forgerock.opendj.ldap.schema.AttributeType getAttributeType()
        Gets the "attribute-type" property.

        Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute.

        Specified by:
        getAttributeType in interface VirtualAttributeCfg
        Returns:
        Returns the value of the "attribute-type" property.

      • getChecksumAlgorithm

        EntityTagVirtualAttributeCfgDefn.ChecksumAlgorithm getChecksumAlgorithm()
        Gets the "checksum-algorithm" property.

        The algorithm which should be used for calculating the entity tag checksum value.

        Returns:
        Returns the value of the "checksum-algorithm" property.

      • getConflictBehavior

        VirtualAttributeCfgDefn.ConflictBehavior getConflictBehavior()
        Gets the "conflict-behavior" property.

        Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute.

        Specified by:
        getConflictBehavior in interface VirtualAttributeCfg
        Returns:
        Returns the value of the "conflict-behavior" property.

      • getExcludedAttribute

        SortedSet<org.forgerock.opendj.ldap.schema.AttributeType> getExcludedAttribute()
        Gets the "excluded-attribute" property.

        The list of attributes which should be ignored when calculating the entity tag checksum value.

        Certain attributes like "ds-sync-hist" may vary between replicas due to different purging schedules and should not be included in the checksum.

        Returns:
        Returns an unmodifiable set containing the values of the "excluded-attribute" property.

      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

        Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values.

        Specified by:
        getJavaClass in interface VirtualAttributeCfg
        Returns:
        Returns the value of the "java-class" property.