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

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

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends EntityTagVirtualAttributeCfgClient,? extends EntityTagVirtualAttributeCfg>	definition()	Get the configuration definition associated with this Entity Tag Virtual Attribute.
org.forgerock.opendj.ldap.schema.AttributeType	getAttributeType()	Gets the "attribute-type" property.
EntityTagVirtualAttributeCfgDefn.ChecksumAlgorithm	getChecksumAlgorithm()	Gets the "checksum-algorithm" property.
VirtualAttributeCfgDefn.ConflictBehavior	getConflictBehavior()	Gets the "conflict-behavior" property.
SortedSet<org.forgerock.opendj.ldap.schema.AttributeType>	getExcludedAttribute()	Gets the "excluded-attribute" property.
String	getJavaClass()	Gets the "java-class" property.
void	setAttributeType(org.forgerock.opendj.ldap.schema.AttributeType value)	Sets the "attribute-type" property.
void	setChecksumAlgorithm(EntityTagVirtualAttributeCfgDefn.ChecksumAlgorithm value)	Sets the "checksum-algorithm" property.
void	setConflictBehavior(VirtualAttributeCfgDefn.ConflictBehavior value)	Sets the "conflict-behavior" property.
void	setExcludedAttribute(Collection<org.forgerock.opendj.ldap.schema.AttributeType> values)	Sets the "excluded-attribute" property.
void	setJavaClass(String value)	Sets the "java-class" property.

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 interface ConfigurationClient

Specified by:

definition in interface VirtualAttributeCfgClient

Returns:

Returns the configuration definition associated with this Entity Tag Virtual Attribute.

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 VirtualAttributeCfgClient

Returns:

Returns the value of the "attribute-type" property.

setAttributeType

void setAttributeType(org.forgerock.opendj.ldap.schema.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 interface VirtualAttributeCfgClient

Parameters:

value - The value of the "attribute-type" property.

Throws:

PropertyException - If the new value is invalid.

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.

setChecksumAlgorithm

void setChecksumAlgorithm(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

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 VirtualAttributeCfgClient

Returns:

Returns the value of the "conflict-behavior" property.

setConflictBehavior

void setConflictBehavior(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 interface VirtualAttributeCfgClient

Parameters:

value - The value of the "conflict-behavior" property.

Throws:

PropertyException - If the new value is invalid.

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 the values of the "excluded-attribute" property.

setExcludedAttribute

void setExcludedAttribute(Collection<org.forgerock.opendj.ldap.schema.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

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 VirtualAttributeCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(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 interface VirtualAttributeCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.