PendingChanges.java revision a395dd575518d9e5280fc5d5d5ef47c61b174647
/*
* 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
* 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 2008 Sun Microsystems, Inc.
*/
/**
* This class is use 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 instanciated for each ReplicationDomain.
*/
public class PendingChanges
{
/**
* A map used to store the pending changes.
*/
/**
* The ChangeNumberGenerator to use to create new unique ChangeNumbers
* for each operation done on the replication domain.
*/
/**
* The Replicationbroker that will be used to send UpdateMessage.
*/
private ReplicationBroker broker;
/**
* The ServerState that will be updated when UpdateMessage are committed.
*/
private ServerState state;
/**
* Creates a new PendingChanges using the provided ChangeNumberGenerator.
*
* @param changeNumberGenerator The ChangeNumberGenerator to use to create
* new unique ChangeNumbers.
* @param broker The Replicationbroker that will be used to send
* UpdateMessage.
* @param state The ServerState that will be updated when UpdateMessage
* are committed.
*/
public PendingChanges(
{
}
/**
* Remove and return an update form the pending changes list.
*
* @param changeNumber The ChangeNumber of the update to remove.
*
* @return The UpdateMessage that was just removed.
*/
{
}
/**
* 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.
*/
{
{
throw new NoSuchElementException();
}
curChange.setCommitted(true);
}
/**
* Mark an update message as committed.
*
* @param changeNumber The ChangeNumber of the update message that must be
* set as committed.
*/
{
{
throw new NoSuchElementException();
}
curChange.setCommitted(true);
}
/**
* Add a new UpdateMessage to the pending list from the provided local
* operation.
*
* @param operation The local operation for which an UpdateMessage mus
* be added in the pending list.
* @return The ChangeNumber now associated to the operation.
*/
{
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;
{
{
}
if (pendingChanges.isEmpty())
{
firstChange = null;
}
else
{
}
}
return numSentUpdates;
}
}