Interface EntityTagVirtualAttributeCfgClient
-
- All Superinterfaces:
ConfigurationClient
,VirtualAttributeCfgClient
public interface EntityTagVirtualAttributeCfgClient extends VirtualAttributeCfgClient
A client-side interface for reading and modifying 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
-
Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient
commit, properties
-
Methods inherited from interface org.forgerock.opendj.server.config.client.VirtualAttributeCfgClient
getBaseDn, getFilter, getGroupDn, getScope, isEnabled, setBaseDn, setEnabled, setFilter, setGroupDn, setScope
-
-
-
-
Method Detail
-
definition
ManagedObjectDefinition<? extends EntityTagVirtualAttributeCfgClient,? extends EntityTagVirtualAttributeCfg> definition()
Get the configuration definition associated with this Entity Tag Virtual Attribute.- Specified by:
definition
in interfaceConfigurationClient
- Specified by:
definition
in interfaceVirtualAttributeCfgClient
- Returns:
- Returns the configuration definition associated with this Entity Tag Virtual Attribute.
-
getAttributeType
@MandatoryProperty ValueOrExpression<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 interfaceVirtualAttributeCfgClient
- Returns:
- Returns the value of the "attribute-type" property.
-
setAttributeType
@MandatoryProperty void setAttributeType(ValueOrExpression<AttributeType> value) throws PropertyException
Sets the "attribute-type" property.Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute.
- Specified by:
setAttributeType
in interfaceVirtualAttributeCfgClient
- Parameters:
value
- The value of the "attribute-type" property.- Throws:
PropertyException
- If the new value is invalid.
-
getChecksumAlgorithm
ValueOrExpression<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.
-
setChecksumAlgorithm
void setChecksumAlgorithm(ValueOrExpression<EntityTagVirtualAttributeCfgDefn.ChecksumAlgorithm> value) throws PropertyException
Sets the "checksum-algorithm" property.The algorithm which should be used for calculating the entity tag checksum value.
- Parameters:
value
- The value of the "checksum-algorithm" property.- Throws:
PropertyException
- If the new value is invalid.
-
getConflictBehavior
ValueOrExpression<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 interfaceVirtualAttributeCfgClient
- Returns:
- Returns the value of the "conflict-behavior" property.
-
setConflictBehavior
void setConflictBehavior(ValueOrExpression<VirtualAttributeCfgDefn.ConflictBehavior> value) throws PropertyException
Sets 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:
setConflictBehavior
in interfaceVirtualAttributeCfgClient
- Parameters:
value
- The value of the "conflict-behavior" property.- Throws:
PropertyException
- If the new value is invalid.
-
getExcludedAttribute
SortedSet<ValueOrExpression<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 the values of the "excluded-attribute" property.
-
setExcludedAttribute
void setExcludedAttribute(Collection<ValueOrExpression<AttributeType>> values) throws PropertyException
Sets 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.
- Parameters:
values
- The values of the "excluded-attribute" property.- Throws:
PropertyException
- If one or more of the new values are invalid.
-
getJavaClass
@MandatoryProperty ValueOrExpression<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 interfaceVirtualAttributeCfgClient
- Returns:
- Returns the value of the "java-class" property.
-
setJavaClass
@MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Sets the "java-class" property.Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values.
- Specified by:
setJavaClass
in interfaceVirtualAttributeCfgClient
- Parameters:
value
- The value of the "java-class" property.- Throws:
PropertyException
- If the new value is invalid.
-
-