valuesHist)
{
this.deleteTime = deleteTime;
this.lastUpdateTime = updateTime;
if (valuesHist != null)
{
this.valuesHist.putAll(valuesHist);
}
}
/**
* Create a new object.
*/
public AttrHistoricalMultiple()
{
this.deleteTime = null;
this.lastUpdateTime = null;
}
/**
* Returns the last time when the attribute was updated.
* @return the last time when the attribute was updated
*/
private CSN getLastUpdateTime()
{
return lastUpdateTime;
}
/**
* Returns the last time when the attribute was deleted.
* @return the last time when the attribute was deleted
*/
@Override
public CSN getDeleteTime()
{
return deleteTime;
}
/**
* Duplicate an object. CSNs are duplicated by references.
*
* Method only called in tests
*
* @return the duplicated object.
*/
AttrHistoricalMultiple duplicate()
{
return new AttrHistoricalMultiple(this.deleteTime, this.lastUpdateTime,
this.valuesHist);
}
/**
* Delete all historical information that is older than the provided CSN for
* this attribute type.
* Add the delete attribute state information
* @param csn time when the delete was done
*/
protected void delete(CSN csn)
{
// iterate through the values in the valuesInfo and suppress all the values
// that have not been added after the date of this delete.
Iterator it = valuesHist.keySet().iterator();
while (it.hasNext())
{
AttrValueHistorical info = it.next();
if (csn.isNewerThanOrEqualTo(info.getValueUpdateTime()) &&
csn.isNewerThanOrEqualTo(info.getValueDeleteTime()))
it.remove();
}
if (csn.isNewerThan(deleteTime))
{
deleteTime = csn;
}
if (csn.isNewerThan(lastUpdateTime))
{
lastUpdateTime = csn;
}
}
/**
* Update the historical of this attribute after a delete value.
*
* @param val value that was deleted
* @param csn time when the delete was done
*/
protected void delete(ByteString val, CSN csn)
{
AttrValueHistorical info = new AttrValueHistorical(val, null, csn);
valuesHist.remove(info);
valuesHist.put(info, info);
if (csn.isNewerThan(lastUpdateTime))
{
lastUpdateTime = csn;
}
}
/**
* Update the historical of this attribute after deleting a set of values.
*
* @param attr
* the attribute containing the set of values that were
* deleted
* @param csn
* time when the delete was done
*/
protected void delete(Attribute attr, CSN csn)
{
for (ByteString val : attr)
{
AttrValueHistorical info = new AttrValueHistorical(val, null, csn);
valuesHist.remove(info);
valuesHist.put(info, info);
if (csn.isNewerThan(lastUpdateTime))
{
lastUpdateTime = csn;
}
}
}
/**
* Update the historical information when a value is added.
*
* @param addedValue
* values that was added
* @param csn
* time when the value was added
*/
protected void add(ByteString addedValue, CSN csn)
{
AttrValueHistorical info = new AttrValueHistorical(addedValue, csn, null);
valuesHist.remove(info);
valuesHist.put(info, info);
if (csn.isNewerThan(lastUpdateTime))
{
lastUpdateTime = csn;
}
}
/**
* Update the historical information when values are added.
*
* @param attr
* the attribute containing the set of added values
* @param csn
* time when the add is done
*/
private void add(Attribute attr, CSN csn)
{
for (ByteString val : attr)
{
AttrValueHistorical info = new AttrValueHistorical(val, csn, null);
valuesHist.remove(info);
valuesHist.put(info, info);
if (csn.isNewerThan(lastUpdateTime))
{
lastUpdateTime = csn;
}
}
}
/**
* Get the list of historical information for the values.
*
* @return the list of historical information for the values.
*/
@Override
public Map getValuesHistorical()
{
return valuesHist;
}
/** {@inheritDoc} */
@Override
public boolean replayOperation(Iterator modsIterator, CSN csn,
Entry modifiedEntry, Modification m)
{
// We are replaying an operation that was already done
// on another master server and this operation has a potential
// conflict with some more recent operations on this same entry
// we need to take the more complex path to solve them
if ((CSN.compare(csn, getLastUpdateTime()) < 0) ||
(m.getModificationType() != ModificationType.REPLACE))
{
// the attribute was modified after this change -> conflict
switch (m.getModificationType().asEnum())
{
case DELETE:
if (csn.isOlderThan(getDeleteTime()))
{
/* this delete is already obsoleted by a more recent delete
* skip this mod
*/
modsIterator.remove();
break;
}
if (!conflictDelete(csn, m, modifiedEntry))
{
modsIterator.remove();
}
break;
case ADD:
conflictAdd(csn, m, modsIterator);
break;
case REPLACE:
if (csn.isOlderThan(getDeleteTime()))
{
/* this replace is already obsoleted by a more recent delete
* skip this mod
*/
modsIterator.remove();
break;
}
/* save the values that are added by the replace operation
* into addedValues
* first process the replace as a delete operation -> this generate
* a list of values that should be kept
* then process the addedValues as if they were coming from a add
* -> this generate the list of values that needs to be added
* concatenate the 2 generated lists into a replace
*/
Attribute addedValues = m.getAttribute();
m.setAttribute(new AttributeBuilder(addedValues, true).toAttribute());
conflictDelete(csn, m, modifiedEntry);
Attribute keptValues = m.getAttribute();
m.setAttribute(addedValues);
conflictAdd(csn, m, modsIterator);
AttributeBuilder builder = new AttributeBuilder(keptValues);
builder.addAll(m.getAttribute());
m.setAttribute(builder.toAttribute());
break;
case INCREMENT:
// TODO : FILL ME
break;
}
return true;
}
else
{
processLocalOrNonConflictModification(csn, m);
return false;// the attribute was not modified more recently
}
}
/**
* This method calculates the historical information and update the hist
* attribute to store the historical information for a modify operation that
* does not conflict with previous operation.
* This is the usual path and should therefore be optimized.
*
* It does not check if the operation to process is conflicting or not with
* previous operations. The caller is responsible for this.
*
* @param csn The CSN of the operation to process
* @param mod The modify operation to process.
*/
@Override
public void processLocalOrNonConflictModification(CSN csn, Modification mod)
{
/*
* The operation is either a non-conflicting operation or a local
* operation so there is no need to check the historical information
* for conflicts.
* If this is a local operation, then this code is run after
* the pre-operation phase.
* If this is a non-conflicting replicated operation, this code is run
* during the handleConflictResolution().
*/
Attribute modAttr = mod.getAttribute();
AttributeType type = modAttr.getAttributeType();
switch (mod.getModificationType().asEnum())
{
case DELETE:
if (modAttr.isEmpty())
{
delete(csn);
}
else
{
delete(modAttr, csn);
}
break;
case ADD:
if (type.isSingleValue())
{
delete(csn);
}
add(modAttr, csn);
break;
case REPLACE:
/* TODO : can we replace specific attribute values ????? */
delete(csn);
add(modAttr, csn);
break;
case INCREMENT:
/* FIXME : we should update CSN */
break;
}
}
/**
* Process a delete attribute values that is conflicting with a previous
* modification.
*
* @param csn The CSN of the currently processed change
* @param m the modification that is being processed
* @param modifiedEntry the entry that is modified (before current mod)
* @return false if there is nothing to do
*/
private boolean conflictDelete(CSN csn, Modification m, Entry modifiedEntry)
{
/*
* We are processing a conflicting DELETE modification
*
* This code is written on the assumption that conflict are
* rare. We therefore don't care much about the performance
* However since it is rarely executed this code needs to be
* as simple as possible to make sure that all paths are tested.
* In this case the most simple seem to change the DELETE
* in a REPLACE modification that keeps all values
* more recent that the DELETE.
* we are therefore going to change m into a REPLACE that will keep
* all the values that have been updated after the DELETE time
* If a value is present in the entry without any state information
* it must be removed so we simply ignore them
*/
Attribute modAttr = m.getAttribute();
if (modAttr.isEmpty())
{
/*
* We are processing a DELETE attribute modification
*/
m.setModificationType(ModificationType.REPLACE);
AttributeBuilder builder = new AttributeBuilder(modAttr, true);
Iterator it = valuesHist.keySet().iterator();
while (it.hasNext())
{
AttrValueHistorical valInfo = it.next();
if (csn.isOlderThan(valInfo.getValueUpdateTime()))
{
/*
* this value has been updated after this delete, therefore
* this value must be kept
*/
builder.add(valInfo.getAttributeValue());
}
else
{
/*
* this value is going to be deleted, remove it from historical
* information unless it is a Deleted attribute value that is
* more recent than this DELETE
*/
if (csn.isNewerThanOrEqualTo(valInfo.getValueDeleteTime()))
{
it.remove();
}
}
}
m.setAttribute(builder.toAttribute());
if (csn.isNewerThan(getDeleteTime()))
{
deleteTime = csn;
}
if (csn.isNewerThan(getLastUpdateTime()))
{
lastUpdateTime = csn;
}
}
else
{
// we are processing DELETE of some attribute values
AttributeBuilder builder = new AttributeBuilder(modAttr);
for (ByteString val : modAttr)
{
boolean deleteIt = true; // true if the delete must be done
boolean addedInCurrentOp = false;
/* update historical information */
AttrValueHistorical valInfo =
new AttrValueHistorical(val, null, csn);
AttrValueHistorical oldValInfo = valuesHist.get(valInfo);
if (oldValInfo != null)
{
/* this value already exist in the historical information */
if (csn.equals(oldValInfo.getValueUpdateTime()))
{
// This value was added earlier in the same operation
// we need to keep the delete.
addedInCurrentOp = true;
}
if (csn.isNewerThanOrEqualTo(oldValInfo.getValueDeleteTime()) &&
csn.isNewerThanOrEqualTo(oldValInfo.getValueUpdateTime()))
{
valuesHist.remove(oldValInfo);
valuesHist.put(valInfo, valInfo);
}
else if (oldValInfo.isUpdate())
{
deleteIt = false;
}
}
else
{
valuesHist.remove(oldValInfo);
valuesHist.put(valInfo, valInfo);
}
/* if the attribute value is not to be deleted
* or if attribute value is not present suppress it from the
* MOD to make sure the delete is going to succeed
*/
if (!deleteIt
|| (!modifiedEntry.hasValue(modAttr.getAttributeType(), modAttr
.getOptions(), val) && ! addedInCurrentOp))
{
// this value was already deleted before and therefore
// this should not be replayed.
builder.remove(val);
if (builder.isEmpty())
{
// This was the last values in the set of values to be deleted.
// this MOD must therefore be skipped.
return false;
}
}
}
m.setAttribute(builder.toAttribute());
if (csn.isNewerThan(getLastUpdateTime()))
{
lastUpdateTime = csn;
}
}
return true;
}
/**
* Process a add attribute values that is conflicting with a previous
* modification.
*
* @param csn the historical info associated to the entry
* @param m the modification that is being processed
* @param modsIterator iterator on the list of modification
* @return false if operation becomes empty and must not be processed
*/
private boolean conflictAdd(CSN csn, Modification m,
Iterator modsIterator)
{
/*
* if historicalattributedelete is newer forget this mod else find
* attr value if does not exist add historicalvalueadded timestamp
* add real value in entry else if timestamp older and already was
* historicalvalueadded update historicalvalueadded else if
* timestamp older and was historicalvaluedeleted change
* historicalvaluedeleted into historicalvalueadded add value in
* real entry
*/
if (csn.isOlderThan(getDeleteTime()))
{
/* A delete has been done more recently than this add
* forget this MOD ADD
*/
modsIterator.remove();
return false;
}
AttributeBuilder builder = new AttributeBuilder(m.getAttribute());
for (ByteString addVal : m.getAttribute())
{
AttrValueHistorical valInfo =
new AttrValueHistorical(addVal, csn, null);
AttrValueHistorical oldValInfo = valuesHist.get(valInfo);
if (oldValInfo == null)
{
/* this value does not exist yet
* add it in the historical information
* let the operation process normally
*/
valuesHist.put(valInfo, valInfo);
}
else
{
if (oldValInfo.isUpdate())
{
/* if the value is already present
* check if the updateTime must be updated
* in all cases suppress this value from the value list
* as it is already present in the entry
*/
if (csn.isNewerThan(oldValInfo.getValueUpdateTime()))
{
valuesHist.remove(oldValInfo);
valuesHist.put(valInfo, valInfo);
}
builder.remove(addVal);
}
else
{ // it is a delete
/* this value is marked as a deleted value
* check if this mod is more recent the this delete
*/
if (csn.isNewerThanOrEqualTo(oldValInfo.getValueDeleteTime()))
{
/* this add is more recent,
* remove the old delete historical information
* and add our more recent one
* let the operation process
*/
valuesHist.remove(oldValInfo);
valuesHist.put(valInfo, valInfo);
}
else
{
/* the delete that is present in the historical information
* is more recent so it must win,
* remove this value from the list of values to add
* don't update the historical information
*/
builder.remove(addVal);
}
}
}
}
Attribute attr = builder.toAttribute();
m.setAttribute(attr);
if (attr.isEmpty())
{
modsIterator.remove();
}
if (csn.isNewerThan(getLastUpdateTime()))
{
lastUpdateTime = csn;
}
return true;
}
/** {@inheritDoc} */
@Override
public void assign(HistAttrModificationKey histKey, ByteString value, CSN csn)
{
switch (histKey)
{
case ADD:
if (value != null)
{
add(value, csn);
}
break;
case DEL:
if (value != null)
{
delete(value, csn);
}
break;
case REPL:
delete(csn);
if (value != null)
{
add(value, csn);
}
break;
case DELATTR:
delete(csn);
break;
}
}
}