/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
|
* add the following below this CDDL HEADER, with the fields enclosed
|
* by brackets "[]" replaced with your own identifying information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Copyright 2009 Sun Microsystems, Inc.
|
* Portions Copyright 2011-2013 ForgeRock AS
|
*/
|
package org.opends.server.replication.plugin;
|
|
import java.util.NoSuchElementException;
|
import java.util.SortedMap;
|
import java.util.TreeMap;
|
|
import org.opends.server.replication.common.ChangeNumber;
|
import org.opends.server.replication.common.ChangeNumberGenerator;
|
import org.opends.server.replication.protocol.LDAPUpdateMsg;
|
import org.opends.server.replication.service.ReplicationDomain;
|
import org.opends.server.types.operation.PluginOperation;
|
|
/**
|
* This class is used to store the list of local operations currently
|
* in progress and not yet committed in the database.
|
*
|
* It is used to make sure that operations are sent to the Replication
|
* Server in the order defined by their ChangeNumber.
|
* It is also used to update the ServerState at the appropriate time.
|
*
|
* On object of this class is instantiated for each ReplicationDomain.
|
*/
|
public class PendingChanges
|
{
|
/**
|
* A map used to store the pending changes.
|
*/
|
private SortedMap<ChangeNumber, PendingChange> pendingChanges =
|
new TreeMap<ChangeNumber, PendingChange>();
|
|
/**
|
* The ChangeNumberGenerator to use to create new unique ChangeNumbers
|
* for each operation done on the replication domain.
|
*/
|
private ChangeNumberGenerator changeNumberGenerator;
|
|
/**
|
* The ReplicationDomain that will be used to send UpdateMsg.
|
*/
|
private ReplicationDomain domain;
|
|
private boolean recoveringOldChanges = false;
|
|
/**
|
* Creates a new PendingChanges using the provided ChangeNumberGenerator.
|
*
|
* @param changeNumberGenerator The ChangeNumberGenerator to use to create
|
* new unique ChangeNumbers.
|
* @param domain The ReplicationDomain that will be used to send
|
* UpdateMsg.
|
*/
|
public PendingChanges(
|
ChangeNumberGenerator changeNumberGenerator, ReplicationDomain domain)
|
{
|
this.changeNumberGenerator = changeNumberGenerator;
|
this.domain = domain;
|
}
|
|
/**
|
* Remove and return an update form the pending changes list.
|
*
|
* @param changeNumber The ChangeNumber of the update to remove.
|
*
|
* @return The UpdateMsg that was just removed.
|
*/
|
public synchronized LDAPUpdateMsg remove(ChangeNumber changeNumber)
|
{
|
return pendingChanges.remove(changeNumber).getMsg();
|
}
|
|
/**
|
* Returns the number of update currently in the list.
|
*
|
* @return The number of update currently in the list.
|
*/
|
public int size()
|
{
|
return pendingChanges.size();
|
}
|
|
/**
|
* Mark an update message as committed.
|
*
|
* @param changeNumber The ChangeNumber of the update message that must be
|
* set as committed.
|
* @param msg The message associated to the update.
|
*/
|
public synchronized void commit(ChangeNumber changeNumber,
|
LDAPUpdateMsg msg)
|
{
|
PendingChange curChange = pendingChanges.get(changeNumber);
|
if (curChange == null)
|
{
|
throw new NoSuchElementException();
|
}
|
curChange.setCommitted(true);
|
curChange.setMsg(msg);
|
}
|
|
/**
|
* Mark an update message as committed.
|
*
|
* @param changeNumber The ChangeNumber of the update message that must be
|
* set as committed.
|
*/
|
public synchronized void commit(ChangeNumber changeNumber)
|
{
|
PendingChange curChange = pendingChanges.get(changeNumber);
|
if (curChange == null)
|
{
|
throw new NoSuchElementException();
|
}
|
curChange.setCommitted(true);
|
}
|
|
/**
|
* Add a new UpdateMsg to the pending list from the provided local
|
* operation.
|
*
|
* @param operation The local operation for which an UpdateMsg must
|
* be added in the pending list.
|
* @return The ChangeNumber now associated to the operation.
|
*/
|
public synchronized ChangeNumber putLocalOperation(PluginOperation operation)
|
{
|
ChangeNumber changeNumber = changeNumberGenerator.newChangeNumber();
|
PendingChange change = new PendingChange(changeNumber, operation, null);
|
pendingChanges.put(changeNumber, change);
|
return changeNumber;
|
}
|
|
/**
|
* Push all committed local changes to the replicationServer service.
|
*
|
* @return The number of pushed updates.
|
*/
|
public synchronized int pushCommittedChanges()
|
{
|
int numSentUpdates = 0;
|
if (pendingChanges.isEmpty())
|
{
|
return numSentUpdates;
|
}
|
|
// peek the oldest changeNumber
|
ChangeNumber firstChangeNumber = pendingChanges.firstKey();
|
PendingChange firstChange = pendingChanges.get(firstChangeNumber);
|
|
while (firstChange != null && firstChange.isCommitted())
|
{
|
if (firstChange.getOp() != null
|
&& !firstChange.getOp().isSynchronizationOperation())
|
{
|
numSentUpdates++;
|
LDAPUpdateMsg updateMsg = firstChange.getMsg();
|
if (!recoveringOldChanges)
|
{
|
domain.publish(updateMsg);
|
}
|
else
|
{
|
// do not push updates until the RS catches up.
|
// @see #setRecovering(boolean)
|
domain.getServerState().update(updateMsg.getChangeNumber());
|
}
|
}
|
pendingChanges.remove(firstChangeNumber);
|
|
if (pendingChanges.isEmpty())
|
{
|
firstChange = null;
|
}
|
else
|
{
|
// peek the oldest changeNumber
|
firstChangeNumber = pendingChanges.firstKey();
|
firstChange = pendingChanges.get(firstChangeNumber);
|
}
|
}
|
return numSentUpdates;
|
}
|
|
/**
|
* Mark an update message as committed, then
|
* push all committed local changes to the replicationServer service
|
* in a single atomic operation.
|
*
|
*
|
* @param changeNumber The ChangeNumber of the update message that must be
|
* set as committed.
|
* @param msg The message associated to the update.
|
*
|
* @return The number of pushed updates.
|
*/
|
public synchronized int commitAndPushCommittedChanges(
|
ChangeNumber changeNumber, LDAPUpdateMsg msg)
|
{
|
commit(changeNumber, msg);
|
return pushCommittedChanges();
|
}
|
|
/**
|
* Set the PendingChangesList structure in a mode where it is
|
* waiting for the RS to receive all the previous changes to
|
* be sent before starting to process the changes normally.
|
* In this mode, The Domain does not publish the changes from
|
* the pendingChanges because there are older changes that
|
* need to be published before.
|
*
|
* @param b The recovering status that must be set.
|
*/
|
public void setRecovering(boolean b)
|
{
|
recoveringOldChanges = b;
|
}
|
|
/**
|
* Allows to update the recovery situation by comparing the ChangeNumber of
|
* the last change that was sent to the ReplicationServer with the
|
* ChangeNumber of the last operation that was taken out of the
|
* PendingChanges list.
|
* If he two match then the recovery is completed and normal procedure can
|
* restart. Otherwise the RSUpdate thread must continue to look for
|
* older changes and no changes can be committed from the pendingChanges list.
|
*
|
* @param recovered The ChangeNumber of the last change that was published
|
* to the ReplicationServer.
|
*
|
* @return A boolean indicating if the recovery is completed (false)
|
* or must continue (true).
|
*/
|
public synchronized boolean recoveryUntil(ChangeNumber recovered)
|
{
|
ChangeNumber lastLocalChange = domain.getLastLocalChange();
|
if (recovered != null && recovered.newerOrEquals(lastLocalChange))
|
{
|
recoveringOldChanges = false;
|
}
|
return recoveringOldChanges;
|
}
|
}
|
