/* * 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-2010 Sun Microsystems, Inc. * Portions Copyright 2011-2013 ForgeRock AS */ package org.opends.server.replication.server.changelog.je; import java.util.ArrayList; import java.util.List; import java.util.Map; import java.util.concurrent.locks.ReentrantLock; import org.opends.messages.MessageBuilder; import org.opends.server.admin.std.server.MonitorProviderCfg; import org.opends.server.api.DirectoryThread; import org.opends.server.api.MonitorProvider; import org.opends.server.config.ConfigException; import org.opends.server.core.DirectoryServer; import org.opends.server.loggers.debug.DebugTracer; import org.opends.server.replication.common.CSN; import org.opends.server.replication.common.MultiDomainServerState; import org.opends.server.replication.common.ServerState; import org.opends.server.replication.server.ReplicationServer; import org.opends.server.replication.server.ReplicationServerDomain; import org.opends.server.replication.server.changelog.api.*; import org.opends.server.replication.server.changelog.je.DraftCNDB.*; import org.opends.server.types.*; 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.*; /** * This class is used for managing the replicationServer database for each * server in the topology. It is responsible for efficiently saving the updates * that is received from each master server into stable storage. This class is * also able to generate a {@link ChangeNumberIndexDBCursor} that can be used to * read all changes from a given change number. *
* This class publishes some monitoring information below
* cn=monitor.
*/
public class DraftCNDbHandler implements ChangeNumberIndexDB, Runnable
{
/**
* The tracer object for the debug logger.
*/
private static final DebugTracer TRACER = getTracer();
private static int NO_KEY = 0;
private DraftCNDB db;
/**
* FIXME Is this field that useful? {@link #getFirstChangeNumber()} does not
* even use it!
*/
private long firstChangeNumber = NO_KEY;
/**
* FIXME Is this field that useful? {@link #getLastChangeNumber()} does not
* even use it!
*/
private long lastChangeNumber = NO_KEY;
private DbMonitorProvider dbMonitor = new DbMonitorProvider();
private boolean shutdown = false;
private boolean trimDone = false;
/**
* A dedicated thread loops trim().
*
* trim() : deletes from the DB a number of changes that are older than a * certain date. */ private DirectoryThread thread; /** * The trim age in milliseconds. Changes record in the change DB that are * older than this age are removed. *
* FIXME it never gets updated even when the replication server purge delay is * updated */ private long trimAge; private ReplicationServer replicationServer; /** * Creates a new dbHandler associated to a given LDAP server. * * @param replicationServer The ReplicationServer that creates this dbHandler. * @param dbenv the Database Env to use to create the ReplicationServer DB. * server for this domain. * @throws ChangelogException If a database problem happened */ public DraftCNDbHandler(ReplicationServer replicationServer, ReplicationDbEnv dbenv) throws ChangelogException { this.replicationServer = replicationServer; this.trimAge = replicationServer.getTrimAge(); // DB initialization db = new DraftCNDB(dbenv); firstChangeNumber = getChangeNumber(db.readFirstRecord()); lastChangeNumber = getChangeNumber(db.readLastRecord()); // Trimming thread thread = new DirectoryThread(this, "Replication DraftCN db"); thread.start(); // Monitoring registration DirectoryServer.deregisterMonitorProvider(dbMonitor); DirectoryServer.registerMonitorProvider(dbMonitor); } private long getChangeNumber(CNIndexRecord record) throws ChangelogException { if (record != null) { return record.getChangeNumber(); } return 0; } /** {@inheritDoc} */ @Override public void addRecord(CNIndexRecord record) throws ChangelogException { db.addRecord(record); if (debugEnabled()) TRACER.debugInfo("In DraftCNDbhandler.add, added: " + record); } /** {@inheritDoc} */ @Override public CNIndexRecord getFirstRecord() throws ChangelogException { return db.readFirstRecord(); } /** {@inheritDoc} */ @Override public CNIndexRecord getLastRecord() throws ChangelogException { return db.readLastRecord(); } /** * Get the number of changes. * @return Returns the number of changes. */ public long count() { return db.count(); } /** {@inheritDoc} */ @Override public boolean isEmpty() throws ChangelogException { return getLastRecord() == null; } /** * Get a read cursor on the database from a provided key. The cursor MUST be * closed after use. *
* This method is only used by unit tests.
*
* @param startChangeNumber
* The change number from where to start.
* @return the new cursor.
* @throws ChangelogException
* if a database problem occurs.
*/
DraftCNDBCursor getReadCursor(long startChangeNumber)
throws ChangelogException
{
return db.openReadCursor(startChangeNumber);
}
/** {@inheritDoc} */
@Override
public ChangeNumberIndexDBCursor getCursorFrom(long startChangeNumber)
throws ChangelogException
{
return new DraftCNDbIterator(db, startChangeNumber);
}
/** {@inheritDoc} */
@Override
public void shutdown()
{
if (shutdown)
{
return;
}
shutdown = true;
synchronized (this)
{
notifyAll();
}
synchronized (this)
{ /* Can we just do a thread.join() ? */
while (!trimDone)
{
try
{
wait();
} catch (InterruptedException e)
{ /* do nothing */ }
}
}
db.shutdown();
DirectoryServer.deregisterMonitorProvider(dbMonitor);
}
/**
* Run method for this class.
* Periodically Flushes the ReplicationServerDomain cache from memory to the
* stable storage and trims the old updates.
*/
@Override
public void run()
{
while (!shutdown)
{
try {
trim();
synchronized (this)
{
try
{
wait(1000);
} catch (InterruptedException e)
{
Thread.currentThread().interrupt();
}
}
} catch (Exception end)
{
MessageBuilder mb = new MessageBuilder();
mb.append(ERR_EXCEPTION_CHANGELOG_TRIM_FLUSH.get());
mb.append(" ");
mb.append(stackTraceToSingleLineString(end));
logError(mb.toMessage());
if (replicationServer != null)
replicationServer.shutdown();
break;
}
}
synchronized (this)
{
trimDone = true;
notifyAll();
}
}
/**
* Trim old changes from this database.
* @throws ChangelogException In case of database problem.
*/
public void trim() throws ChangelogException
{
if (trimAge == 0)
return;
clear(null);
}
/** {@inheritDoc} */
@Override
public void clear(DN baseDNToClear) throws ChangelogException
{
if (isEmpty())
{
return;
}
for (int i = 0; i < 100; i++)
{
final DraftCNDBCursor cursor = db.openDeleteCursor();
try
{
for (int j = 0; j < 50; j++)
{
// let's traverse the DraftCNDb
if (!cursor.next())
{
cursor.close();
return;
}
// From the draftCNDb change record, get the domain and CSN
final CNIndexRecord record = cursor.currentRecord();
if (baseDNToClear != null && baseDNToClear.equals(record.getBaseDN()))
{
cursor.delete();
continue;
}
final ReplicationServerDomain domain =
replicationServer.getReplicationServerDomain(record.getBaseDN());
if (domain == null)
{
// the domain has been removed since the record was written in the
// draftCNDb, thus it makes no sense to keep the record in the
// draftCNDb.
cursor.delete();
continue;
}
final CSN csn = record.getCSN();
final ServerState startState = domain.getStartState();
final CSN fcsn = startState.getCSN(csn.getServerId());
final long currentChangeNumber = record.getChangeNumber();
if (csn.older(fcsn))
{
cursor.delete();
continue;
}
ServerState csnVector;
try
{
Map