org.opends.server.replication.plugin

Class EntryHistorical

java.lang.Object

org.opends.server.replication.plugin.EntryHistorical

public final class EntryHistorical
extends Object

This class is used to store historical information that is used to resolve modify conflicts

It is assumed that the common case is not to have conflict and therefore is optimized (in order of importance) for:

1. detecting potential conflict
2. fast update of historical information for non-conflicting change
3. fast and efficient purge
4. compact
5. solve conflict. This should also be as fast as possible but not at the cost of any of the other previous objectives

One Historical object is created for each entry in the entry cache each Historical Object contains a list of attribute historical information

Field Summary

Fields

Modifier and Type	Field and Description
static String	HISTORICAL_ATTRIBUTE_NAME Name of the attribute used to store historical information.

Constructor Summary

Constructors

Constructor and Description
EntryHistorical() Default constructor used before decoding.

Method Summary

Modifier and Type	Method and Description
void	addAttrHistoricalAddValue(AttributeDescription attributeDescription, CSN csn, ByteString value) Updates this entry historical information with the provided add modification.
void	addAttrHistoricalDeleteAttr(AttributeDescription attributeDescription, CSN csn) Updates this entry historical information with the provided delete attribute modification.
void	addAttrHistoricalDeleteValue(AttributeDescription attributeDescription, CSN csn, ByteString value) Updates this entry historical information with the provided delete modification.
void	addAttrHistoricalReplaceValue(AttributeDescription attributeDescription, CSN csn, ByteString value) Updates this entry historical information with the provided replace modification.
Map<AttributeDescription,AttrHistorical>	getAllAttrHistorical() Returns the historical information for all attributes.
AttrHistorical	getAttrHistorical(AttributeDescription attributeDescription) Returns the historical information for the named attribute.
static CSN	getCSN(Entry entry) Returns the first CSN in the ds-sync-hist attribute of the provided entry.
CSN	getEntryADDDate() Returns the CSN of the operation that added this entry.
CSN	getEntryMODDNDate() Returns the CSN of the operation that renamed this entry.
static String	getEntryUUID(Entry entry) Get the entry unique Id in String form.
static String	getEntryUUID(PreOperationAddOperation op) Get the Entry Unique Id from an add operation.
static String	getEntryUUID(SearchResultEntry entry) Get the entry unique Id in String form.
static boolean	isHistoricalAttribute(Attribute attr) Check if a given attribute is an attribute used to store historical information.
static EntryHistorical	newInstanceFromEntry(Entry entry) Construct an Historical object from the provided entry by reading the historical attribute.
void	setEntryADDDate(CSN csn) Sets the CSN of the operation that added this entry.
void	setEntryMODDNDate(CSN csn) Sets the CSN of the operation that renamed this entry.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

HISTORICAL_ATTRIBUTE_NAME

public static final String HISTORICAL_ATTRIBUTE_NAME

Name of the attribute used to store historical information.

See Also:

Constant Field Values

Constructor Detail

EntryHistorical

public EntryHistorical()

Default constructor used before decoding.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

newInstanceFromEntry

public static EntryHistorical newInstanceFromEntry(Entry entry)

Construct an Historical object from the provided entry by reading the historical attribute. Return an empty object when the entry does not contain any historical attribute.

Parameters:

entry - The entry which historical information must be loaded

Returns:

The constructed Historical information object

getEntryUUID

public static String getEntryUUID(Entry entry)

Get the entry unique Id in String form.

Parameters:

entry - The entry for which the unique id should be returned.

Returns:

The Unique Id of the entry, or a fake one if none is found.

getEntryUUID

public static String getEntryUUID(PreOperationAddOperation op)

Get the Entry Unique Id from an add operation. This must be called after the entry uuid pre-op plugin (i.e no sooner than the replication provider pre-op)

Parameters:

op - The operation

Returns:

The Entry Unique Id String form.

getEntryUUID

public static String getEntryUUID(SearchResultEntry entry)

Get the entry unique Id in String form.

Parameters:

entry - The entry for which the unique id should be returned.

Returns:

The Unique Id of the entry, or a fake one if none is found.

isHistoricalAttribute

public static boolean isHistoricalAttribute(Attribute attr)

Check if a given attribute is an attribute used to store historical information.

Parameters:

attr - The attribute that needs to be checked.

Returns:

a boolean indicating if the given attribute is used to store historical information.

getCSN

public static CSN getCSN(Entry entry)

Returns the first CSN in the ds-sync-hist attribute of the provided entry.

Parameters:

entry - the non-null entry

Returns:

the first CSN in the ds-sync-hist attribute

getEntryADDDate

public CSN getEntryADDDate()

Returns the CSN of the operation that added this entry.

Returns:

The CSN of the operation that added this entry.

setEntryADDDate

public void setEntryADDDate(CSN csn)

Sets the CSN of the operation that added this entry.

Parameters:

csn - The CSN of the operation that added this entry.

getEntryMODDNDate

public CSN getEntryMODDNDate()

Returns the CSN of the operation that renamed this entry.

Returns:

The CSN of the operation that renamed this entry.

setEntryMODDNDate

public void setEntryMODDNDate(CSN csn)

Sets the CSN of the operation that renamed this entry.

Parameters:

csn - The CSN of the operation that renamed this entry.

getAllAttrHistorical

public Map<AttributeDescription,AttrHistorical> getAllAttrHistorical()

Returns the historical information for all attributes.

Returns:

The historical information for all attributes.

getAttrHistorical

public AttrHistorical getAttrHistorical(AttributeDescription attributeDescription)

Returns the historical information for the named attribute.

Parameters:

attributeDescription - The attribute name.

Returns:

The historical information for the named attribute, or null if there isn't any.

addAttrHistoricalAddValue

public void addAttrHistoricalAddValue(AttributeDescription attributeDescription,
                                      CSN csn,
                                      ByteString value)

Updates this entry historical information with the provided add modification.

Parameters:

attributeDescription - The attribute description.

csn - The CSN of the modification.

value - The value that was added.

addAttrHistoricalDeleteValue

public void addAttrHistoricalDeleteValue(AttributeDescription attributeDescription,
                                         CSN csn,
                                         ByteString value)

Updates this entry historical information with the provided delete modification.

Parameters:

attributeDescription - The attribute description.

csn - The CSN of the modification.

value - The value that was deleted.

addAttrHistoricalReplaceValue

public void addAttrHistoricalReplaceValue(AttributeDescription attributeDescription,
                                          CSN csn,
                                          ByteString value)

Updates this entry historical information with the provided replace modification.

Parameters:

attributeDescription - The attribute description.

csn - The CSN of the modification.

value - The value that was replaced.

addAttrHistoricalDeleteAttr

public void addAttrHistoricalDeleteAttr(AttributeDescription attributeDescription,
                                        CSN csn)

Updates this entry historical information with the provided delete attribute modification.

Parameters:

attributeDescription - The attribute description.

csn - The CSN of the modification.