/*
|
* 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 2013 ForgeRock AS
|
*/
|
package org.opends.server.replication.server.changelog.api;
|
|
import org.opends.server.replication.common.CSN;
|
|
/**
|
* This class stores an index of all the changes seen by this server. The index
|
* is sorted by a global ordering as defined in the CSN class. The index links a
|
* <code>changeNumber</code> to the corresponding {@link CSN}. The {@link CSN}
|
* then links to a corresponding change in one of the {@link ReplicaDB}s.
|
*
|
* @see <a href=
|
* "https://wikis.forgerock.org/confluence/display/OPENDJ/OpenDJ+Domain+Names"
|
* >OpenDJ Domain Names</a> for more information about the changelog.
|
* @see <a href= "http://tools.ietf.org/html/draft-good-ldap-changelog-04"
|
* >OpenDJ Domain Names</a> for more information about the changeNumber.
|
*/
|
public interface ChangeNumberIndexDB extends Runnable
|
{
|
|
/**
|
* Get the CSN associated to a provided change number.
|
*
|
* @param changeNumber
|
* the provided change number.
|
* @return the associated CSN, null when none.
|
*/
|
public CSN getCSN(int changeNumber);
|
|
/**
|
* Get the baseDN associated to a provided change number.
|
*
|
* @param changeNumber
|
* the provided change number.
|
* @return the baseDN, null when none.
|
*/
|
public String getBaseDN(int changeNumber);
|
|
/**
|
* Get the previous cookie associated to a provided change number.
|
*
|
* @param changeNumber
|
* the provided change number.
|
* @return the previous cookie, null when none.
|
*/
|
String getPreviousCookie(int changeNumber);
|
|
/**
|
* Get the first change number stored in this DB.
|
*
|
* @return Returns the first change number in this DB.
|
*/
|
int getFirstChangeNumber();
|
|
/**
|
* Get the last change number stored in this DB.
|
*
|
* @return Returns the last change number in this DB
|
*/
|
int getLastChangeNumber();
|
|
/**
|
* Add an update to the list of messages that must be saved to this DB managed
|
* by this DB.
|
* <p>
|
* This method is blocking if the size of the list of message is larger than
|
* its maximum.
|
*
|
* @param changeNumber
|
* The change number for this record in this DB.
|
* @param previousCookie
|
* The value of the previous cookie.
|
* @param baseDN
|
* The associated baseDN.
|
* @param csn
|
* The associated replication CSN.
|
*/
|
void add(int changeNumber, String previousCookie, String baseDN, CSN csn);
|
|
/**
|
* Generate a new {@link ChangeNumberIndexDBCursor} that allows to browse the
|
* db managed by this DBHandler and starting at the position defined by a
|
* given changeNumber.
|
*
|
* @param startChangeNumber
|
* The position where the iterator must start.
|
* @return a new ReplicationIterator that allows to browse this DB managed by
|
* this DBHandler and starting at the position defined by a given
|
* changeNumber.
|
* @throws ChangelogException
|
* if a database problem happened.
|
*/
|
ChangeNumberIndexDBCursor getCursorFrom(int startChangeNumber)
|
throws ChangelogException;
|
|
/**
|
* Returns whether this database is empty.
|
*
|
* @return <code>true</code> if this database is empty, <code>false</code>
|
* otherwise
|
*/
|
boolean isEmpty();
|
|
/**
|
* Clear the changes from this DB (from both memory cache and DB storage).
|
*
|
* @throws ChangelogException
|
* When an exception occurs while removing the changes from this DB.
|
*/
|
void clear() throws ChangelogException;
|
|
/**
|
* Clear the changes from this DB (from both memory cache and DB storage) for
|
* the provided baseDN.
|
*
|
* @param baseDNToClear
|
* The baseDN for which we want to remove all records from this DB,
|
* null means all.
|
* @throws ChangelogException
|
* When an exception occurs while removing the changes from this DB.
|
*/
|
void clear(String baseDNToClear) throws ChangelogException;
|
|
/**
|
* Shutdown this DB.
|
*/
|
void shutdown();
|
|
}
|
