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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addEntityTagChangeListener(ConfigurationChangeListener<EntityTagVirtualAttributeCfg> listener)
Register to be notified when this Entity Tag Virtual Attribute is changed.Class<? extends EntityTagVirtualAttributeCfg>
configurationClass()
Gets the configuration class associated with this Entity Tag Virtual Attribute.AttributeType
getAttributeType()
Gets the "attribute-type" property.EntityTagVirtualAttributeCfgDefn.ChecksumAlgorithm
getChecksumAlgorithm()
Gets the "checksum-algorithm" property.VirtualAttributeCfgDefn.ConflictBehavior
getConflictBehavior()
Gets the "conflict-behavior" property.SortedSet<AttributeType>
getExcludedAttribute()
Gets the "excluded-attribute" property.String
getJavaClass()
Gets the "java-class" property.void
removeEntityTagChangeListener(ConfigurationChangeListener<EntityTagVirtualAttributeCfg> listener)
Deregister an existing Entity Tag Virtual Attribute configuration change listener.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
Methods inherited from interface org.forgerock.opendj.server.config.server.VirtualAttributeCfg
addChangeListener, getBaseDn, getFilter, getGroupDn, getScope, isEnabled, removeChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends EntityTagVirtualAttributeCfg> configurationClass()
Gets the configuration class associated with this Entity Tag Virtual Attribute.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfaceVirtualAttributeCfg
- Returns:
- Returns the configuration class associated with this Entity Tag Virtual Attribute.
-
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
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.
Default value:
etag
- Specified by:
getAttributeType
in interfaceVirtualAttributeCfg
- 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.
Default value:
adler-32
- 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.
Default value:
real-overrides-virtual
- Specified by:
getConflictBehavior
in interfaceVirtualAttributeCfg
- Returns:
- Returns the value of the "conflict-behavior" property.
-
getExcludedAttribute
SortedSet<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.
Default value:
ds-sync-hist
- 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.
Default value:
org.opends.server.extensions.EntityTagVirtualAttributeProvider
- Specified by:
getJavaClass
in interfaceVirtualAttributeCfg
- Returns:
- Returns the value of the "java-class" property.
-
-