/*
|
* 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.je;
|
|
import java.io.File;
|
import java.util.*;
|
import java.util.concurrent.ConcurrentHashMap;
|
import java.util.concurrent.ConcurrentMap;
|
import java.util.concurrent.atomic.AtomicBoolean;
|
|
import org.opends.messages.Message;
|
import org.opends.messages.MessageBuilder;
|
import org.opends.server.config.ConfigException;
|
import org.opends.server.replication.common.CSN;
|
import org.opends.server.replication.common.ServerState;
|
import org.opends.server.replication.protocol.UpdateMsg;
|
import org.opends.server.replication.server.ChangelogState;
|
import org.opends.server.replication.server.ReplicationServer;
|
import org.opends.server.replication.server.changelog.api.*;
|
import org.opends.server.types.DN;
|
import org.opends.server.util.Pair;
|
import org.opends.server.util.StaticUtils;
|
|
import static org.opends.messages.ReplicationMessages.*;
|
import static org.opends.server.loggers.ErrorLogger.*;
|
import static org.opends.server.util.StaticUtils.*;
|
|
/**
|
* JE implementation of the ChangelogDB interface.
|
*/
|
public class JEChangelogDB implements ChangelogDB, ReplicationDomainDB
|
{
|
|
/**
|
* {@link DBCursor} implementation that iterates across all the ReplicaDBs of
|
* a replication domain, advancing from the oldest to the newest change cross
|
* all replicaDBs.
|
*/
|
private final class CrossReplicaDBCursor implements DBCursor<UpdateMsg>
|
{
|
|
private final DN baseDN;
|
private UpdateMsg currentChange;
|
/**
|
* The cursors are sorted based on the current change of each cursor to
|
* consider the next change across all replicaDBs.
|
*/
|
private final NavigableSet<DBCursor<UpdateMsg>> cursors =
|
new TreeSet<DBCursor<UpdateMsg>>(new Comparator<DBCursor<UpdateMsg>>()
|
{
|
|
@Override
|
public int compare(DBCursor<UpdateMsg> o1, DBCursor<UpdateMsg> o2)
|
{
|
final CSN csn1 = o1.getRecord().getCSN();
|
final CSN csn2 = o2.getRecord().getCSN();
|
return CSN.compare(csn1, csn2);
|
}
|
});
|
|
public CrossReplicaDBCursor(DN baseDN, ServerState startAfterServerState)
|
{
|
this.baseDN = baseDN;
|
for (int serverId : getDomainMap(baseDN).keySet())
|
{
|
// get the last already sent CSN from that server to get a cursor
|
final CSN lastCSN = startAfterServerState.getCSN(serverId);
|
addCursorIfNotEmpty(getCursorFrom(baseDN, serverId, lastCSN));
|
}
|
}
|
|
private DBCursor<UpdateMsg> getCursorFrom(DN baseDN, int serverId,
|
CSN startAfterCSN)
|
{
|
JEReplicaDB replicaDB = getReplicaDB(baseDN, serverId);
|
if (replicaDB != null)
|
{
|
try
|
{
|
DBCursor<UpdateMsg> cursor =
|
replicaDB.generateCursorFrom(startAfterCSN);
|
cursor.next();
|
return cursor;
|
}
|
catch (ChangelogException e)
|
{
|
// ignored
|
}
|
}
|
return EMPTY_CURSOR;
|
}
|
|
@Override
|
public boolean next() throws ChangelogException
|
{
|
if (cursors.isEmpty())
|
{
|
currentChange = null;
|
return false;
|
}
|
|
// To keep consistent the cursors' order in the SortedSet, it is necessary
|
// to remove and eventually add again a cursor (after moving it forward).
|
final DBCursor<UpdateMsg> cursor = cursors.pollFirst();
|
currentChange = cursor.getRecord();
|
cursor.next();
|
addCursorIfNotEmpty(cursor);
|
return true;
|
}
|
|
void addCursorIfNotEmpty(DBCursor<UpdateMsg> cursor)
|
{
|
if (cursor.getRecord() != null)
|
{
|
cursors.add(cursor);
|
}
|
else
|
{
|
StaticUtils.close(cursor);
|
}
|
}
|
|
@Override
|
public UpdateMsg getRecord()
|
{
|
return currentChange;
|
}
|
|
@Override
|
public void close()
|
{
|
StaticUtils.close(cursors);
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public String toString()
|
{
|
return getClass().getSimpleName() + " baseDN=" + baseDN
|
+ " currentChange=" + currentChange + " open cursors=" + cursors;
|
}
|
}
|
|
/**
|
* This map contains the List of updates received from each LDAP server.
|
* <p>
|
* When removing a domainMap, code:
|
* <ol>
|
* <li>first get the domainMap</li>
|
* <li>synchronized on the domainMap</li>
|
* <li>remove the domainMap</li>
|
* <li>then check it's not null</li>
|
* <li>then close all inside</li>
|
* </ol>
|
* When creating a JEReplicaDB, synchronize on the domainMap to avoid
|
* concurrent shutdown.
|
*/
|
private final ConcurrentMap<DN, ConcurrentMap<Integer, JEReplicaDB>>
|
domainToReplicaDBs =
|
new ConcurrentHashMap<DN, ConcurrentMap<Integer, JEReplicaDB>>();
|
private ReplicationDbEnv dbEnv;
|
private final String dbDirectoryName;
|
private final File dbDirectory;
|
|
/**
|
* The handler of the changelog database, the database stores the relation
|
* between a change number and the associated cookie.
|
* <p>
|
* Guarded by cnIndexDBLock
|
*/
|
private JEChangeNumberIndexDB cnIndexDB;
|
|
/** Used for protecting {@link ChangeNumberIndexDB} related state. */
|
private final Object cnIndexDBLock = new Object();
|
|
/** The local replication server. */
|
private final ReplicationServer replicationServer;
|
private AtomicBoolean shutdown = new AtomicBoolean();
|
|
private static final DBCursor<UpdateMsg> EMPTY_CURSOR =
|
new DBCursor<UpdateMsg>()
|
{
|
|
@Override
|
public boolean next()
|
{
|
return false;
|
}
|
|
@Override
|
public UpdateMsg getRecord()
|
{
|
return null;
|
}
|
|
@Override
|
public void close()
|
{
|
// empty
|
}
|
|
@Override
|
public String toString()
|
{
|
return "EmptyDBCursor<UpdateMsg>";
|
}
|
};
|
|
/**
|
* Builds an instance of this class.
|
*
|
* @param replicationServer
|
* the local replication server.
|
* @param dbDirName
|
* the directory for use by the replication database
|
* @throws ConfigException
|
* if a problem occurs opening the supplied directory
|
*/
|
public JEChangelogDB(ReplicationServer replicationServer, String dbDirName)
|
throws ConfigException
|
{
|
this.replicationServer = replicationServer;
|
this.dbDirectoryName = dbDirName != null ? dbDirName : "changelogDb";
|
this.dbDirectory = makeDir(this.dbDirectoryName);
|
}
|
|
private File makeDir(String dbDirName) throws ConfigException
|
{
|
// Check that this path exists or create it.
|
File dbDirectory = getFileForPath(dbDirName);
|
try
|
{
|
if (!dbDirectory.exists())
|
{
|
dbDirectory.mkdir();
|
}
|
return dbDirectory;
|
}
|
catch (Exception e)
|
{
|
MessageBuilder mb = new MessageBuilder();
|
mb.append(e.getLocalizedMessage());
|
mb.append(" ");
|
mb.append(String.valueOf(dbDirectory));
|
Message msg = ERR_FILE_CHECK_CREATE_FAILED.get(mb.toString());
|
throw new ConfigException(msg, e);
|
}
|
}
|
|
private Map<Integer, JEReplicaDB> getDomainMap(DN baseDN)
|
{
|
final Map<Integer, JEReplicaDB> domainMap = domainToReplicaDBs.get(baseDN);
|
if (domainMap != null)
|
{
|
return domainMap;
|
}
|
return Collections.emptyMap();
|
}
|
|
private JEReplicaDB getReplicaDB(DN baseDN, int serverId)
|
{
|
return getDomainMap(baseDN).get(serverId);
|
}
|
|
/**
|
* Provision resources for the specified serverId in the specified replication
|
* domain.
|
*
|
* @param baseDN
|
* the replication domain where to add the serverId
|
* @param serverId
|
* the server Id to add to the replication domain
|
* @throws ChangelogException
|
* If a database error happened.
|
*/
|
private void commission(DN baseDN, int serverId, ReplicationServer rs)
|
throws ChangelogException
|
{
|
getOrCreateReplicaDB(baseDN, serverId, rs);
|
}
|
|
/**
|
* Returns a {@link JEReplicaDB}, possibly creating it.
|
*
|
* @param baseDN
|
* the baseDN for which to create a ReplicaDB
|
* @param serverId
|
* the serverId for which to create a ReplicaDB
|
* @param rs
|
* the ReplicationServer
|
* @return a Pair with the JEReplicaDB and a boolean indicating whether it had
|
* to be created
|
* @throws ChangelogException
|
* if a problem occurred with the database
|
*/
|
Pair<JEReplicaDB, Boolean> getOrCreateReplicaDB(DN baseDN,
|
int serverId, ReplicationServer rs) throws ChangelogException
|
{
|
while (!shutdown.get())
|
{
|
final ConcurrentMap<Integer, JEReplicaDB> domainMap =
|
getExistingOrNewDomainMap(baseDN);
|
final Pair<JEReplicaDB, Boolean> result =
|
getExistingOrNewReplicaDB(domainMap, serverId, baseDN, rs);
|
if (result != null)
|
{
|
return result;
|
}
|
}
|
throw new ChangelogException(
|
ERR_CANNOT_CREATE_REPLICA_DB_BECAUSE_CHANGELOG_DB_SHUTDOWN.get());
|
}
|
|
private ConcurrentMap<Integer, JEReplicaDB> getExistingOrNewDomainMap(
|
DN baseDN)
|
{
|
// happy path: the domainMap already exists
|
final ConcurrentMap<Integer, JEReplicaDB> currentValue =
|
domainToReplicaDBs.get(baseDN);
|
if (currentValue != null)
|
{
|
return currentValue;
|
}
|
|
// unlucky, the domainMap does not exist: take the hit and create the
|
// newValue, even though the same could be done concurrently by another
|
// thread
|
final ConcurrentMap<Integer, JEReplicaDB> newValue =
|
new ConcurrentHashMap<Integer, JEReplicaDB>();
|
final ConcurrentMap<Integer, JEReplicaDB> previousValue =
|
domainToReplicaDBs.putIfAbsent(baseDN, newValue);
|
if (previousValue != null)
|
{
|
// there was already a value associated to the key, let's use it
|
return previousValue;
|
}
|
return newValue;
|
}
|
|
private Pair<JEReplicaDB, Boolean> getExistingOrNewReplicaDB(
|
final ConcurrentMap<Integer, JEReplicaDB> domainMap, int serverId,
|
DN baseDN, ReplicationServer rs) throws ChangelogException
|
{
|
// happy path: the JEReplicaDB already exists
|
JEReplicaDB currentValue = domainMap.get(serverId);
|
if (currentValue != null)
|
{
|
return Pair.of(currentValue, false);
|
}
|
|
// unlucky, the JEReplicaDB does not exist: take the hit and synchronize
|
// on the domainMap to create a new ReplicaDB
|
synchronized (domainMap)
|
{
|
// double-check
|
currentValue = domainMap.get(serverId);
|
if (currentValue != null)
|
{
|
return Pair.of(currentValue, false);
|
}
|
|
if (domainToReplicaDBs.get(baseDN) != domainMap)
|
{
|
// the domainMap could have been concurrently removed because
|
// 1) a shutdown was initiated or 2) an initialize was called.
|
// Return will allow the code to:
|
// 1) shutdown properly or 2) lazily recreate the JEReplicaDB
|
return null;
|
}
|
|
final JEReplicaDB newValue = new JEReplicaDB(serverId, baseDN, rs, dbEnv);
|
domainMap.put(serverId, newValue);
|
return Pair.of(newValue, true);
|
}
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public void initializeDB()
|
{
|
try
|
{
|
dbEnv = new ReplicationDbEnv(
|
getFileForPath(dbDirectoryName).getAbsolutePath(), replicationServer);
|
initializeChangelogState(dbEnv.readChangelogState());
|
}
|
catch (ChangelogException e)
|
{
|
logError(ERR_COULD_NOT_READ_DB.get(this.dbDirectory.getAbsolutePath(),
|
e.getLocalizedMessage()));
|
}
|
}
|
|
private void initializeChangelogState(final ChangelogState changelogState)
|
throws ChangelogException
|
{
|
for (Map.Entry<DN, Long> entry :
|
changelogState.getDomainToGenerationId().entrySet())
|
{
|
replicationServer.getReplicationServerDomain(entry.getKey(), true)
|
.initGenerationID(entry.getValue());
|
}
|
for (Map.Entry<DN, List<Integer>> entry :
|
changelogState.getDomainToServerIds().entrySet())
|
{
|
for (int serverId : entry.getValue())
|
{
|
commission(entry.getKey(), serverId, replicationServer);
|
}
|
}
|
}
|
|
private void shutdownCNIndexDB() throws ChangelogException
|
{
|
synchronized (cnIndexDBLock)
|
{
|
if (cnIndexDB != null)
|
{
|
cnIndexDB.shutdown();
|
}
|
}
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public void shutdownDB() throws ChangelogException
|
{
|
if (!this.shutdown.compareAndSet(false, true))
|
{ // shutdown has already been initiated
|
return;
|
}
|
|
// Remember the first exception because :
|
// - we want to try to remove everything we want to remove
|
// - then throw the first encountered exception
|
ChangelogException firstException = null;
|
|
try
|
{
|
shutdownCNIndexDB();
|
}
|
catch (ChangelogException e)
|
{
|
firstException = e;
|
}
|
|
for (Iterator<ConcurrentMap<Integer, JEReplicaDB>> it =
|
this.domainToReplicaDBs.values().iterator(); it.hasNext();)
|
{
|
final ConcurrentMap<Integer, JEReplicaDB> domainMap = it.next();
|
synchronized (domainMap)
|
{
|
it.remove();
|
innerShutdownDomain(domainMap);
|
}
|
}
|
|
if (dbEnv != null)
|
{
|
dbEnv.shutdown();
|
}
|
|
if (firstException != null)
|
{
|
throw firstException;
|
}
|
}
|
|
/**
|
* Clears all content from the changelog database, but leaves its directory on
|
* the filesystem.
|
*
|
* @throws ChangelogException
|
* If a database problem happened
|
*/
|
public void clearDB() throws ChangelogException
|
{
|
if (!dbDirectory.exists())
|
{
|
return;
|
}
|
|
// Remember the first exception because :
|
// - we want to try to remove everything we want to remove
|
// - then throw the first encountered exception
|
ChangelogException firstException = null;
|
|
for (DN baseDN : this.domainToReplicaDBs.keySet())
|
{
|
removeDomain(baseDN);
|
}
|
|
synchronized (cnIndexDBLock)
|
{
|
if (cnIndexDB != null)
|
{
|
try
|
{
|
cnIndexDB.clear();
|
}
|
catch (ChangelogException e)
|
{
|
firstException = e;
|
}
|
|
try
|
{
|
shutdownCNIndexDB();
|
}
|
catch (ChangelogException e)
|
{
|
if (firstException == null)
|
{
|
firstException = e;
|
}
|
}
|
|
cnIndexDB = null;
|
}
|
}
|
|
if (firstException != null)
|
{
|
throw firstException;
|
}
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public void removeDB() throws ChangelogException
|
{
|
shutdownDB();
|
StaticUtils.recursiveDelete(dbDirectory);
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public long getCount(DN baseDN, int serverId, CSN from, CSN to)
|
{
|
JEReplicaDB replicaDB = getReplicaDB(baseDN, serverId);
|
if (replicaDB != null)
|
{
|
return replicaDB.getCount(from, to);
|
}
|
return 0;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public long getDomainChangesCount(DN baseDN)
|
{
|
long entryCount = 0;
|
for (JEReplicaDB replicaDB : getDomainMap(baseDN).values())
|
{
|
entryCount += replicaDB.getChangesCount();
|
}
|
return entryCount;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public void shutdownDomain(DN baseDN)
|
{
|
if (this.shutdown.get())
|
{ // shutdown has already been initiated
|
return;
|
}
|
|
final Map<Integer, JEReplicaDB> domainMap = domainToReplicaDBs.get(baseDN);
|
if (domainMap != null)
|
{
|
synchronized (domainMap)
|
{
|
innerShutdownDomain(domainToReplicaDBs.remove(baseDN));
|
}
|
}
|
}
|
|
/**
|
* This method assumes the domainMap is synchronized by calling code and that
|
* the domainMap is not null.
|
*/
|
private void innerShutdownDomain(final Map<Integer, JEReplicaDB> domainMap)
|
{
|
for (JEReplicaDB replicaDB : domainMap.values())
|
{
|
replicaDB.shutdown();
|
}
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public ServerState getDomainOldestCSNs(DN baseDN)
|
{
|
final ServerState result = new ServerState();
|
for (JEReplicaDB replicaDB : getDomainMap(baseDN).values())
|
{
|
result.update(replicaDB.getOldestCSN());
|
}
|
return result;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public ServerState getDomainNewestCSNs(DN baseDN)
|
{
|
final ServerState result = new ServerState();
|
for (JEReplicaDB replicaDB : getDomainMap(baseDN).values())
|
{
|
result.update(replicaDB.getNewestCSN());
|
}
|
return result;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public void removeDomain(DN baseDN) throws ChangelogException
|
{
|
// Remember the first exception because :
|
// - we want to try to remove everything we want to remove
|
// - then throw the first encountered exception
|
ChangelogException firstException = null;
|
|
// 1- clear the replica DBs
|
Map<Integer, JEReplicaDB> domainMap = domainToReplicaDBs.get(baseDN);
|
if (domainMap != null)
|
{
|
synchronized (domainMap)
|
{
|
domainMap = domainToReplicaDBs.remove(baseDN);
|
for (JEReplicaDB replicaDB : domainMap.values())
|
{
|
try
|
{
|
replicaDB.clear();
|
}
|
catch (ChangelogException e)
|
{
|
firstException = e;
|
}
|
replicaDB.shutdown();
|
}
|
}
|
}
|
|
// 2- clear the ChangeNumber index DB
|
synchronized (cnIndexDBLock)
|
{
|
if (cnIndexDB != null)
|
{
|
try
|
{
|
cnIndexDB.clear(baseDN);
|
}
|
catch (ChangelogException e)
|
{
|
if (firstException == null)
|
{
|
firstException = e;
|
}
|
}
|
}
|
}
|
|
// 3- clear the changelogstate DB
|
try
|
{
|
dbEnv.clearGenerationId(baseDN);
|
}
|
catch (ChangelogException e)
|
{
|
if (firstException == null)
|
{
|
firstException = e;
|
}
|
}
|
|
if (firstException != null)
|
{
|
throw firstException;
|
}
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public void setPurgeDelay(long delay)
|
{
|
for (Map<Integer, JEReplicaDB> domainMap : domainToReplicaDBs.values())
|
{
|
for (JEReplicaDB replicaDB : domainMap.values())
|
{
|
replicaDB.setPurgeDelay(delay);
|
}
|
}
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public long getDomainLatestTrimDate(DN baseDN)
|
{
|
long latest = 0;
|
for (JEReplicaDB replicaDB : getDomainMap(baseDN).values())
|
{
|
if (latest == 0 || latest < replicaDB.getLatestTrimDate())
|
{
|
latest = replicaDB.getLatestTrimDate();
|
}
|
}
|
return latest;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public ChangeNumberIndexDB getChangeNumberIndexDB()
|
{
|
synchronized (cnIndexDBLock)
|
{
|
if (cnIndexDB == null)
|
{
|
try
|
{
|
cnIndexDB = new JEChangeNumberIndexDB(replicationServer, this.dbEnv);
|
cnIndexDB.startTrimmingThread();
|
}
|
catch (Exception e)
|
{
|
logError(ERR_CHANGENUMBER_DATABASE.get(e.getLocalizedMessage()));
|
}
|
}
|
return cnIndexDB;
|
}
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public ReplicationDomainDB getReplicationDomainDB()
|
{
|
return this;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public DBCursor<UpdateMsg> getCursorFrom(DN baseDN, CSN startAfterCSN)
|
{
|
// Builds a new serverState for all the serverIds in the replication domain
|
// to ensure we get cursors starting after the provided CSN.
|
return getCursorFrom(baseDN, buildServerState(baseDN, startAfterCSN));
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public DBCursor<UpdateMsg> getCursorFrom(DN baseDN,
|
ServerState startAfterServerState)
|
{
|
return new CrossReplicaDBCursor(baseDN, startAfterServerState);
|
}
|
|
private ServerState buildServerState(DN baseDN, CSN startAfterCSN)
|
{
|
final ServerState result = new ServerState();
|
if (startAfterCSN == null)
|
{
|
return result;
|
}
|
|
for (int serverId : getDomainMap(baseDN).keySet())
|
{
|
if (serverId == startAfterCSN.getServerId())
|
{
|
// reuse the provided CSN one as it is the most accurate
|
result.update(startAfterCSN);
|
}
|
else
|
{
|
// build a new CSN, ignoring the seqNum since it is irrelevant for
|
// a different serverId
|
final CSN csn = startAfterCSN; // only used for increased readability
|
result.update(new CSN(csn.getTime(), 0, serverId));
|
}
|
}
|
return result;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public boolean publishUpdateMsg(DN baseDN, UpdateMsg updateMsg)
|
throws ChangelogException
|
{
|
final Pair<JEReplicaDB, Boolean> pair = getOrCreateReplicaDB(baseDN,
|
updateMsg.getCSN().getServerId(), replicationServer);
|
final JEReplicaDB replicaDB = pair.getFirst();
|
final boolean wasCreated = pair.getSecond();
|
|
replicaDB.add(updateMsg);
|
return wasCreated;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public void replicaHeartbeat(DN baseDN, CSN csn)
|
{
|
// TODO implement this when the changelogDB will be responsible for
|
// maintaining the medium consistency point
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public void replicaOffline(DN baseDN, int serverId)
|
{
|
// TODO implement this when the changelogDB will be responsible for
|
// maintaining the medium consistency point
|
}
|
}
|
