/*
|
* 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 org.opends.messages.Message;
|
import org.opends.messages.MessageBuilder;
|
import org.opends.server.config.ConfigException;
|
import org.opends.server.loggers.debug.DebugTracer;
|
import org.opends.server.replication.common.CSN;
|
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.ChangeNumberIndexDB;
|
import org.opends.server.replication.server.changelog.api.ChangelogDB;
|
import org.opends.server.replication.server.changelog.api.ChangelogException;
|
import org.opends.server.replication.server.changelog.api.ReplicaDBCursor;
|
import org.opends.server.types.DN;
|
import org.opends.server.types.DebugLogLevel;
|
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.loggers.debug.DebugLogger.*;
|
import static org.opends.server.util.StaticUtils.*;
|
|
/**
|
* JE implementation of the ChangelogDB.
|
*/
|
public class JEChangelogDB implements ChangelogDB
|
{
|
|
/** The tracer object for the debug logger. */
|
private static final DebugTracer TRACER = getTracer();
|
|
/**
|
* This map contains the List of updates received from each LDAP server.
|
*/
|
private final Map<DN, Map<Integer, DbHandler>> sourceDbHandlers =
|
new ConcurrentHashMap<DN, Map<Integer, DbHandler>>();
|
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 ChangeNumberIndexDB cnIndexDB;
|
|
/** Used for protecting {@link ChangeNumberIndexDB} related state. */
|
private final Object cnIndexDBLock = new Object();
|
|
/** The local replication server. */
|
private final ReplicationServer replicationServer;
|
|
private static final ReplicaDBCursor EMPTY_CURSOR = new ReplicaDBCursor()
|
{
|
|
@Override
|
public int compareTo(ReplicaDBCursor o)
|
{
|
if (o == null)
|
{
|
throw new NullPointerException(); // as per javadoc
|
}
|
return o == this ? 0 : -1; // equal to self, but less than all the rest
|
}
|
|
@Override
|
public boolean next()
|
{
|
return false;
|
}
|
|
@Override
|
public UpdateMsg getChange()
|
{
|
return null;
|
}
|
|
@Override
|
public void close()
|
{
|
// empty
|
}
|
};
|
|
/**
|
* 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, DbHandler> getDomainMap(DN baseDN)
|
{
|
final Map<Integer, DbHandler> domainMap = sourceDbHandlers.get(baseDN);
|
if (domainMap != null)
|
{
|
return domainMap;
|
}
|
return Collections.emptyMap();
|
}
|
|
private DbHandler getDbHandler(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
|
{
|
getOrCreateDbHandler(baseDN, serverId, rs);
|
}
|
|
/**
|
* Returns a DbHandler, possibly creating it.
|
*
|
* @param baseDN
|
* the baseDN for which to create a DbHandler
|
* @param serverId
|
* the baseserverId for which to create a DbHandler
|
* @param rs
|
* the ReplicationServer
|
* @return a Pair with the DbHandler and a a boolean indicating if it has been
|
* created
|
* @throws ChangelogException
|
* if a problem occurred with the database
|
*/
|
Pair<DbHandler, Boolean> getOrCreateDbHandler(DN baseDN,
|
int serverId, ReplicationServer rs) throws ChangelogException
|
{
|
synchronized (sourceDbHandlers)
|
{
|
Map<Integer, DbHandler> domainMap = sourceDbHandlers.get(baseDN);
|
if (domainMap == null)
|
{
|
domainMap = new ConcurrentHashMap<Integer, DbHandler>();
|
sourceDbHandlers.put(baseDN, domainMap);
|
}
|
|
DbHandler dbHandler = domainMap.get(serverId);
|
if (dbHandler == null)
|
{
|
dbHandler =
|
new DbHandler(serverId, baseDN, rs, dbEnv, rs.getQueueSize());
|
domainMap.put(serverId, dbHandler);
|
return Pair.of(dbHandler, true);
|
}
|
return Pair.of(dbHandler, false);
|
}
|
}
|
|
|
/** {@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
|
{
|
// 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;
|
}
|
|
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
|
{
|
// 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.sourceDbHandlers.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
|
{
|
StaticUtils.recursiveDelete(dbDirectory);
|
// there is no point in keeping the DB open after it has been removed
|
shutdownDB();
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public Set<Integer> getDomainServerIds(DN baseDN)
|
{
|
return getDomainMap(baseDN).keySet();
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public long getCount(DN baseDN, int serverId, CSN from, CSN to)
|
{
|
DbHandler dbHandler = getDbHandler(baseDN, serverId);
|
if (dbHandler != null)
|
{
|
return dbHandler.getCount(from, to);
|
}
|
return 0;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public long getDomainChangesCount(DN baseDN)
|
{
|
long entryCount = 0;
|
for (DbHandler dbHandler : getDomainMap(baseDN).values())
|
{
|
entryCount += dbHandler.getChangesCount();
|
}
|
return entryCount;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public void shutdownDomain(DN baseDN)
|
{
|
shutdownDbHandlers(getDomainMap(baseDN));
|
}
|
|
private void shutdownDbHandlers(Map<Integer, DbHandler> domainMap)
|
{
|
synchronized (domainMap)
|
{
|
for (DbHandler dbHandler : domainMap.values())
|
{
|
dbHandler.shutdown();
|
}
|
domainMap.clear();
|
}
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public Map<Integer, CSN> getDomainOldestCSNs(DN baseDN)
|
{
|
final Map<Integer, DbHandler> domainMap = getDomainMap(baseDN);
|
final Map<Integer, CSN> results =
|
new HashMap<Integer, CSN>(domainMap.size());
|
for (DbHandler dbHandler : domainMap.values())
|
{
|
results.put(dbHandler.getServerId(), dbHandler.getOldestCSN());
|
}
|
return results;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public Map<Integer, CSN> getDomainNewestCSNs(DN baseDN)
|
{
|
final Map<Integer, DbHandler> domainMap = getDomainMap(baseDN);
|
final Map<Integer, CSN> results =
|
new HashMap<Integer, CSN>(domainMap.size());
|
for (DbHandler dbHandler : domainMap.values())
|
{
|
results.put(dbHandler.getServerId(), dbHandler.getNewestCSN());
|
}
|
return results;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public void removeDomain(DN baseDN)
|
{
|
// 1- clear the replica DBs
|
final Map<Integer, DbHandler> domainMap = getDomainMap(baseDN);
|
synchronized (domainMap)
|
{
|
for (DbHandler dbHandler : domainMap.values())
|
{
|
try
|
{
|
dbHandler.clear();
|
}
|
catch (Exception e)
|
{
|
// TODO: i18n
|
MessageBuilder mb = new MessageBuilder();
|
mb.append(ERR_ERROR_CLEARING_DB.get(dbHandler.toString(), e
|
.getMessage()
|
+ " " + stackTraceToSingleLineString(e)));
|
logError(mb.toMessage());
|
}
|
}
|
shutdownDbHandlers(domainMap);
|
}
|
|
// 2- clear the ChangeNumber index DB
|
synchronized (cnIndexDBLock)
|
{
|
if (cnIndexDB != null)
|
{
|
try
|
{
|
cnIndexDB.clear(baseDN);
|
}
|
catch (Exception ignored)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.WARNING, ignored);
|
}
|
}
|
}
|
}
|
|
// 3- clear the changelogstate DB
|
try
|
{
|
dbEnv.clearGenerationId(baseDN);
|
}
|
catch (Exception ignored)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.WARNING, ignored);
|
}
|
}
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public void setPurgeDelay(long delay)
|
{
|
for (Map<Integer, DbHandler> domainMap : sourceDbHandlers.values())
|
{
|
for (DbHandler dbHandler : domainMap.values())
|
{
|
dbHandler.setPurgeDelay(delay);
|
}
|
}
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public long getDomainLatestTrimDate(DN baseDN)
|
{
|
long latest = 0;
|
for (DbHandler dbHandler : getDomainMap(baseDN).values())
|
{
|
if (latest == 0 || latest < dbHandler.getLatestTrimDate())
|
{
|
latest = dbHandler.getLatestTrimDate();
|
}
|
}
|
return latest;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public CSN getCSNAfter(DN baseDN, int serverId, CSN startAfterCSN)
|
{
|
final DbHandler dbHandler = getDbHandler(baseDN, serverId);
|
|
ReplicaDBCursor cursor = null;
|
try
|
{
|
cursor = dbHandler.generateCursorFrom(startAfterCSN);
|
if (cursor != null && cursor.getChange() != null)
|
{
|
return cursor.getChange().getCSN();
|
}
|
return null;
|
}
|
catch (ChangelogException e)
|
{
|
// there's no change older than startAfterCSN
|
return new CSN(0, 0, serverId);
|
}
|
finally
|
{
|
close(cursor);
|
}
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public ChangeNumberIndexDB getChangeNumberIndexDB()
|
{
|
synchronized (cnIndexDBLock)
|
{
|
if (cnIndexDB == null)
|
{
|
try
|
{
|
cnIndexDB = new DraftCNDbHandler(replicationServer, this.dbEnv);
|
}
|
catch (Exception e)
|
{
|
logError(ERR_CHANGENUMBER_DATABASE.get(e.getLocalizedMessage()));
|
}
|
}
|
return cnIndexDB;
|
}
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public String getDBDirectoryName()
|
{
|
return this.dbDirectoryName;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public ReplicaDBCursor getCursorFrom(DN baseDN, int serverId,
|
CSN startAfterCSN)
|
{
|
DbHandler dbHandler = getDbHandler(baseDN, serverId);
|
if (dbHandler != null)
|
{
|
try
|
{
|
ReplicaDBCursor cursor = dbHandler.generateCursorFrom(startAfterCSN);
|
cursor.next();
|
return cursor;
|
}
|
catch (ChangelogException e)
|
{
|
// ignored
|
}
|
}
|
return EMPTY_CURSOR;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public boolean publishUpdateMsg(DN baseDN, int serverId,
|
UpdateMsg updateMsg) throws ChangelogException
|
{
|
final Pair<DbHandler, Boolean> pair =
|
getOrCreateDbHandler(baseDN, serverId, replicationServer);
|
final DbHandler dbHandler = pair.getFirst();
|
final boolean wasCreated = pair.getSecond();
|
|
dbHandler.add(updateMsg);
|
return wasCreated;
|
}
|
|
}
|
