/*
|
* 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
|
*
|
*
|
* Portions Copyright 2007 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.replication.server;
|
import static org.opends.messages.BackendMessages.*;
|
import static org.opends.messages.JebMessages.INFO_JEB_EXPORT_FINAL_STATUS;
|
import static org.opends.messages.JebMessages.INFO_JEB_EXPORT_PROGRESS_REPORT;
|
import static org.opends.messages.ReplicationMessages.*;
|
import static org.opends.server.loggers.ErrorLogger.logError;
|
import static org.opends.server.loggers.debug.DebugLogger.debugEnabled;
|
import static org.opends.server.loggers.debug.DebugLogger.getTracer;
|
import static org.opends.server.util.StaticUtils.getExceptionMessage;
|
|
import java.io.BufferedReader;
|
import java.io.ByteArrayInputStream;
|
import java.io.ByteArrayOutputStream;
|
import java.io.IOException;
|
import java.io.StringReader;
|
import java.util.ArrayList;
|
import java.util.HashMap;
|
import java.util.HashSet;
|
import java.util.Iterator;
|
import java.util.LinkedHashSet;
|
import java.util.LinkedList;
|
import java.util.List;
|
import java.util.Map;
|
import java.util.Timer;
|
import java.util.TimerTask;
|
|
import org.opends.messages.Message;
|
import org.opends.server.admin.Configuration;
|
import org.opends.server.admin.std.server.BackendCfg;
|
import org.opends.server.admin.std.server.LocalDBBackendCfg;
|
import org.opends.server.api.Backend;
|
import org.opends.server.api.SynchronizationProvider;
|
import org.opends.server.backends.jeb.BackupManager;
|
import org.opends.server.config.ConfigException;
|
import org.opends.server.core.AddOperation;
|
import org.opends.server.core.DeleteOperation;
|
import org.opends.server.core.DirectoryServer;
|
import org.opends.server.core.ModifyDNOperation;
|
import org.opends.server.core.ModifyOperation;
|
import org.opends.server.core.SearchOperation;
|
import org.opends.server.loggers.debug.DebugTracer;
|
import org.opends.server.protocols.internal.InternalClientConnection;
|
import org.opends.server.replication.plugin.MultimasterReplication;
|
import org.opends.server.replication.plugin.ReplicationServerListener;
|
import org.opends.server.replication.protocol.AddMsg;
|
import org.opends.server.replication.protocol.DeleteMsg;
|
import org.opends.server.replication.protocol.ModifyDNMsg;
|
import org.opends.server.replication.protocol.ModifyMsg;
|
import org.opends.server.replication.protocol.UpdateMessage;
|
import org.opends.server.types.Attribute;
|
import org.opends.server.types.AttributeType;
|
import org.opends.server.types.AttributeValue;
|
import org.opends.server.types.BackupConfig;
|
import org.opends.server.types.BackupDirectory;
|
import org.opends.server.types.ConditionResult;
|
import org.opends.server.types.Control;
|
import org.opends.server.types.DN;
|
import org.opends.server.types.DebugLogLevel;
|
import org.opends.server.types.DirectoryException;
|
import org.opends.server.types.Entry;
|
import org.opends.server.types.IndexType;
|
import org.opends.server.types.InitializationException;
|
import org.opends.server.types.LDIFExportConfig;
|
import org.opends.server.types.LDIFImportConfig;
|
import org.opends.server.types.LDIFImportResult;
|
import org.opends.server.types.RawAttribute;
|
import org.opends.server.types.RestoreConfig;
|
import org.opends.server.types.ResultCode;
|
import org.opends.server.types.SearchFilter;
|
import org.opends.server.types.SearchScope;
|
import org.opends.server.util.AddChangeRecordEntry;
|
import org.opends.server.util.DeleteChangeRecordEntry;
|
import org.opends.server.util.LDIFReader;
|
import org.opends.server.util.LDIFWriter;
|
import org.opends.server.util.ModifyChangeRecordEntry;
|
import org.opends.server.util.ModifyDNChangeRecordEntry;
|
import org.opends.server.util.Validator;
|
|
/**
|
* This class defines a backend that stores its information in an
|
* associated replication server object.
|
* This is primarily intended to take advantage of the backup/restore/
|
* import/export of the backend API, and to provide an LDAP access
|
* to the replication server database.
|
* <BR><BR>
|
* Entries stored in this backend are held in the DB associated with
|
* the replication server.
|
* <BR><BR>
|
* Currently are only implemented the create and restore backup features.
|
*
|
*/
|
public class ReplicationBackend
|
extends Backend
|
{
|
/**
|
* The tracer object for the debug logger.
|
*/
|
private static final DebugTracer TRACER = getTracer();
|
|
private static final String EXPORT_BASE_DN = "dc=replicationChanges";
|
|
// The base DNs for this backend.
|
private DN[] baseDNs;
|
|
// The mapping between parent DNs and their immediate children.
|
private HashMap<DN,HashSet<DN>> childDNs;
|
|
// The base DNs for this backend, in a hash set.
|
private HashSet<DN> baseDNSet;
|
|
// The set of supported controls for this backend.
|
private HashSet<String> supportedControls;
|
|
// The set of supported features for this backend.
|
private HashSet<String> supportedFeatures;
|
|
// The directory associated with this backend.
|
private BackupDirectory backendDirectory;
|
|
ReplicationServer server;
|
|
/**
|
* The configuration of this backend.
|
*/
|
private LocalDBBackendCfg cfg;
|
|
/**
|
* The number of milliseconds between job progress reports.
|
*/
|
private long progressInterval = 10000;
|
|
/**
|
* The current number of entries exported.
|
*/
|
private long exportedCount = 0;
|
|
/**
|
* The current number of entries skipped.
|
*/
|
private long skippedCount = 0;
|
|
/**
|
* Creates a new backend with the provided information. All backend
|
* implementations must implement a default constructor that use
|
* <CODE>super()</CODE> to invoke this constructor.
|
*/
|
public ReplicationBackend()
|
{
|
super();
|
// Perform all initialization in initializeBackend.
|
}
|
|
|
/**
|
* Set the base DNs for this backend. This is used by the unit tests
|
* to set the base DNs without having to provide a configuration
|
* object when initializing the backend.
|
* @param baseDNs The set of base DNs to be served by this memory backend.
|
*/
|
public void setBaseDNs(DN[] baseDNs)
|
{
|
this.baseDNs = baseDNs;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public void configureBackend(Configuration config) throws ConfigException
|
{
|
if (config != null)
|
{
|
Validator.ensureTrue(config instanceof BackendCfg);
|
cfg = (LocalDBBackendCfg)config;
|
DN[] baseDNs = new DN[cfg.getBaseDN().size()];
|
cfg.getBaseDN().toArray(baseDNs);
|
setBaseDNs(baseDNs);
|
backendDirectory = new BackupDirectory(
|
cfg.getDBDirectory(), null);
|
}
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public synchronized void initializeBackend()
|
throws ConfigException, InitializationException
|
{
|
if ((baseDNs == null) || (baseDNs.length != 1))
|
{
|
Message message = ERR_MEMORYBACKEND_REQUIRE_EXACTLY_ONE_BASE.get();
|
throw new ConfigException(message);
|
}
|
|
baseDNSet = new HashSet<DN>();
|
for (DN dn : baseDNs)
|
{
|
baseDNSet.add(dn);
|
}
|
|
childDNs = new HashMap<DN,HashSet<DN>>();
|
|
supportedControls = new HashSet<String>();
|
supportedFeatures = new HashSet<String>();
|
|
for (DN dn : baseDNs)
|
{
|
try
|
{
|
DirectoryServer.registerBaseDN(dn, this, true);
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, e);
|
}
|
|
Message message = ERR_BACKEND_CANNOT_REGISTER_BASEDN.get(
|
dn.toString(), getExceptionMessage(e));
|
throw new InitializationException(message, e);
|
}
|
}
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public synchronized void finalizeBackend()
|
{
|
for (DN dn : baseDNs)
|
{
|
try
|
{
|
DirectoryServer.deregisterBaseDN(dn);
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, e);
|
}
|
}
|
}
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public DN[] getBaseDNs()
|
{
|
return baseDNs;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public synchronized long getEntryCount()
|
{
|
return -1;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public boolean isLocal()
|
{
|
return true;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public boolean isIndexed(AttributeType attributeType, IndexType indexType)
|
{
|
// This needs to be updated when the backend implementation is complete.
|
return false;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public synchronized Entry getEntry(DN entryDN)
|
{
|
return null;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public synchronized boolean entryExists(DN entryDN)
|
{
|
return false;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public synchronized void addEntry(Entry entry, AddOperation addOperation)
|
throws DirectoryException
|
{
|
Message message = ERR_BACKUP_ADD_NOT_SUPPORTED.get();
|
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM, message);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public synchronized void deleteEntry(DN entryDN,
|
DeleteOperation deleteOperation)
|
throws DirectoryException
|
{
|
Message message = ERR_BACKUP_DELETE_NOT_SUPPORTED.get();
|
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM, message);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public synchronized void replaceEntry(Entry entry,
|
ModifyOperation modifyOperation)
|
throws DirectoryException
|
{
|
Message message = ERR_BACKUP_MODIFY_NOT_SUPPORTED.get();
|
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM, message);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public synchronized void renameEntry(DN currentDN, Entry entry,
|
ModifyDNOperation modifyDNOperation)
|
throws DirectoryException
|
{
|
Message message = ERR_BACKUP_MODIFY_DN_NOT_SUPPORTED.get();
|
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM, message);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public HashSet<String> getSupportedControls()
|
{
|
return supportedControls;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public HashSet<String> getSupportedFeatures()
|
{
|
return supportedFeatures;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public boolean supportsLDIFExport()
|
{
|
return true;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public synchronized void exportLDIF(LDIFExportConfig exportConfig)
|
throws DirectoryException
|
{
|
List<DN> includeBranches = exportConfig.getIncludeBranches();
|
DN baseDN;
|
ArrayList<ReplicationCache> exportContainers =
|
new ArrayList<ReplicationCache>();
|
|
Iterator<ReplicationCache> rcachei = server.getCacheIterator();
|
if (rcachei != null)
|
{
|
while (rcachei.hasNext())
|
{
|
ReplicationCache rc = rcachei.next();
|
|
// Skip containers that are not covered by the include branches.
|
baseDN = DN.decode(rc.getBaseDn().toString() + "," + EXPORT_BASE_DN);
|
|
if (includeBranches == null || includeBranches.isEmpty())
|
{
|
exportContainers.add(rc);
|
}
|
else
|
{
|
for (DN includeBranch : includeBranches)
|
{
|
if (includeBranch.isDescendantOf(baseDN) ||
|
includeBranch.isAncestorOf(baseDN))
|
{
|
exportContainers.add(rc);
|
}
|
}
|
}
|
}
|
}
|
|
// Make a note of the time we started.
|
long startTime = System.currentTimeMillis();
|
|
// Start a timer for the progress report.
|
Timer timer = new Timer();
|
TimerTask progressTask = new ProgressTask();
|
timer.scheduleAtFixedRate(progressTask, progressInterval,
|
progressInterval);
|
|
// Create the LDIF writer.
|
LDIFWriter ldifWriter;
|
try
|
{
|
ldifWriter = new LDIFWriter(exportConfig);
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, e);
|
}
|
|
Message message =
|
ERR_BACKEND_CANNOT_CREATE_LDIF_WRITER.get(String.valueOf(e));
|
throw new DirectoryException(DirectoryServer.getServerErrorResultCode(),
|
message, e);
|
}
|
|
exportRootChanges(exportContainers, exportConfig, ldifWriter);
|
|
// Iterate through the containers.
|
try
|
{
|
for (ReplicationCache exportContainer : exportContainers)
|
{
|
processContainer(exportContainer, exportConfig, ldifWriter, null);
|
}
|
}
|
finally
|
{
|
timer.cancel();
|
|
// Close the LDIF writer
|
try
|
{
|
ldifWriter.close();
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, e);
|
}
|
}
|
}
|
|
long finishTime = System.currentTimeMillis();
|
long totalTime = (finishTime - startTime);
|
|
float rate = 0;
|
if (totalTime > 0)
|
{
|
rate = 1000f*exportedCount / totalTime;
|
}
|
|
Message message = INFO_JEB_EXPORT_FINAL_STATUS.get(
|
exportedCount, skippedCount, totalTime/1000, rate);
|
logError(message);
|
}
|
|
/*
|
* Exports the root changes of the export, and one entry by domain.
|
*/
|
private void exportRootChanges(List<ReplicationCache> exportContainers,
|
LDIFExportConfig exportConfig, LDIFWriter ldifWriter)
|
{
|
Map<AttributeType,List<Attribute>> attributes =
|
new HashMap<AttributeType,List<Attribute>>();
|
ArrayList<Attribute> ldapAttrList = new ArrayList<Attribute>();
|
|
AttributeType ocType=
|
DirectoryServer.getAttributeType("objectclass", true);
|
LinkedHashSet<AttributeValue> ocValues =
|
new LinkedHashSet<AttributeValue>();
|
ocValues.add(new AttributeValue(ocType, "top"));
|
ocValues.add(new AttributeValue(ocType, "domain"));
|
Attribute ocAttr = new Attribute(ocType, "objectclass", ocValues);
|
ldapAttrList.add(ocAttr);
|
attributes.put(ocType, ldapAttrList);
|
|
try
|
{
|
AddChangeRecordEntry changeRecord =
|
new AddChangeRecordEntry(DN.decode(EXPORT_BASE_DN),
|
attributes);
|
ldifWriter.writeChangeRecord(changeRecord);
|
}
|
catch (Exception e) {}
|
|
for (ReplicationCache exportContainer : exportContainers)
|
{
|
attributes.clear();
|
ldapAttrList.clear();
|
|
ldapAttrList.add(ocAttr);
|
|
AttributeType stateType=
|
DirectoryServer.getAttributeType("state", true);
|
LinkedHashSet<AttributeValue> stateValues =
|
new LinkedHashSet<AttributeValue>();
|
stateValues.add(new AttributeValue(stateType,
|
exportContainer.getDbServerState().toString()));
|
TRACER.debugInfo("State=" +
|
exportContainer.getDbServerState().toString());
|
Attribute stateAttr = new Attribute(ocType, "state", stateValues);
|
ldapAttrList.add(stateAttr);
|
|
AttributeType genidType=
|
DirectoryServer.getAttributeType("generation-id", true);
|
LinkedHashSet<AttributeValue> genidValues =
|
new LinkedHashSet<AttributeValue>();
|
genidValues.add(new AttributeValue(genidType,
|
String.valueOf(exportContainer.getGenerationId())+
|
exportContainer.getBaseDn()));
|
Attribute genidAttr = new Attribute(ocType, "generation-id", genidValues);
|
ldapAttrList.add(genidAttr);
|
attributes.put(genidType, ldapAttrList);
|
|
try
|
{
|
AddChangeRecordEntry changeRecord =
|
new AddChangeRecordEntry(DN.decode(
|
exportContainer.getBaseDn() + "," + EXPORT_BASE_DN),
|
attributes);
|
ldifWriter.writeChangeRecord(changeRecord);
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, e);
|
}
|
Message message = ERR_BACKEND_EXPORT_ENTRY.get(
|
exportContainer.getBaseDn() + "," + EXPORT_BASE_DN,
|
String.valueOf(e));
|
logError(message);
|
}
|
}
|
}
|
|
/**
|
* Processes the changes for a given ReplicationCache.
|
*/
|
private void processContainer(ReplicationCache rc,
|
LDIFExportConfig exportConfig, LDIFWriter ldifWriter,
|
SearchOperation searchOperation)
|
{
|
// Walk through the servers
|
for (Short serverId : rc.getServers())
|
{
|
ReplicationIterator ri = rc.getChangelogIterator(serverId,
|
null);
|
|
if (ri != null)
|
{
|
try
|
{
|
// Walk through the changes
|
while (ri.getChange() != null)
|
{
|
UpdateMessage msg = ri.getChange();
|
processChange(msg, exportConfig, ldifWriter, searchOperation);
|
if (!ri.next())
|
break;
|
}
|
}
|
finally
|
{
|
ri.releaseCursor();
|
}
|
}
|
}
|
}
|
|
/**
|
* Export one change.
|
*/
|
private void processChange(UpdateMessage msg,
|
LDIFExportConfig exportConfig, LDIFWriter ldifWriter,
|
SearchOperation searchOperation)
|
{
|
InternalClientConnection conn =
|
InternalClientConnection.getRootConnection();
|
Entry entry = null;
|
DN dn = null;
|
|
try
|
{
|
if (msg instanceof AddMsg)
|
{
|
AddMsg addMsg = (AddMsg)msg;
|
AddOperation addOperation = (AddOperation)msg.createOperation(conn);
|
|
dn = DN.decode("puid=" + addMsg.getParentUid() + "," +
|
"changeNumber=" + msg.getChangeNumber().toString() + "," +
|
msg.getDn() +","+ "dc=replicationChanges");
|
|
Map<AttributeType,List<Attribute>> attributes =
|
new HashMap<AttributeType,List<Attribute>>();
|
|
for (RawAttribute a : addOperation.getRawAttributes())
|
{
|
Attribute attr = a.toAttribute();
|
AttributeType attrType = attr.getAttributeType();
|
List<Attribute> attrs = attributes.get(attrType);
|
if (attrs == null)
|
{
|
attrs = new ArrayList<Attribute>(1);
|
attrs.add(attr);
|
attributes.put(attrType, attrs);
|
}
|
else
|
{
|
attrs.add(attr);
|
}
|
}
|
|
AddChangeRecordEntry changeRecord =
|
new AddChangeRecordEntry(dn, attributes);
|
if (exportConfig != null)
|
{
|
ldifWriter.writeChangeRecord(changeRecord);
|
}
|
else
|
{
|
Writer writer = new Writer();
|
LDIFWriter ldifWriter2 = writer.getLDIFWriter();
|
ldifWriter2.writeChangeRecord(changeRecord);
|
LDIFReader reader = writer.getLDIFReader();
|
entry = reader.readEntry();
|
}
|
}
|
else if (msg instanceof DeleteMsg)
|
{
|
DeleteMsg delMsg = (DeleteMsg)msg;
|
|
dn = DN.decode("uuid=" + msg.getUniqueId() + "," +
|
"changeNumber=" + delMsg.getChangeNumber().toString()+ "," +
|
msg.getDn() +","+ "dc=replicationChanges");
|
|
DeleteChangeRecordEntry changeRecord =
|
new DeleteChangeRecordEntry(dn);
|
if (exportConfig != null)
|
{
|
ldifWriter.writeChangeRecord(changeRecord);
|
}
|
else
|
{
|
Writer writer = new Writer();
|
LDIFWriter ldifWriter2 = writer.getLDIFWriter();
|
ldifWriter2.writeChangeRecord(changeRecord);
|
LDIFReader reader = writer.getLDIFReader();
|
entry = reader.readEntry();
|
}
|
}
|
else if (msg instanceof ModifyMsg)
|
{
|
ModifyOperation op = (ModifyOperation)msg.createOperation(conn);
|
|
dn = DN.decode("uuid=" + msg.getUniqueId() + "," +
|
"changeNumber=" + msg.getChangeNumber().toString()+ "," +
|
msg.getDn() +","+ "dc=replicationChanges");
|
op.setInternalOperation(true);
|
|
ModifyChangeRecordEntry changeRecord =
|
new ModifyChangeRecordEntry(dn, op.getRawModifications());
|
if (exportConfig != null)
|
{
|
ldifWriter.writeChangeRecord(changeRecord);
|
}
|
else
|
{
|
Writer writer = new Writer();
|
LDIFWriter ldifWriter2 = writer.getLDIFWriter();
|
ldifWriter2.writeChangeRecord(changeRecord);
|
LDIFReader reader = writer.getLDIFReader();
|
entry = reader.readEntry();
|
}
|
}
|
else if (msg instanceof ModifyDNMsg)
|
{
|
ModifyDNOperation op = (ModifyDNOperation)msg.createOperation(conn);
|
|
dn = DN.decode("uuid=" + msg.getUniqueId() + "," +
|
"changeNumber=" + msg.getChangeNumber().toString()+ "," +
|
msg.getDn() +","+ "dc=replicationChanges");
|
op.setInternalOperation(true);
|
|
ModifyDNChangeRecordEntry changeRecord =
|
new ModifyDNChangeRecordEntry(dn, op.getNewRDN(), op.deleteOldRDN(),
|
op.getNewSuperior());
|
|
if (exportConfig != null)
|
{
|
ldifWriter.writeChangeRecord(changeRecord);
|
}
|
else
|
{
|
Writer writer = new Writer();
|
LDIFWriter ldifWriter2 = writer.getLDIFWriter();
|
ldifWriter2.writeChangeRecord(changeRecord);
|
LDIFReader reader = writer.getLDIFReader();
|
Entry modDNEntry = reader.readEntry();
|
entry = modDNEntry;
|
}
|
}
|
|
if (exportConfig != null)
|
{
|
this.exportedCount++;
|
}
|
else
|
{
|
// Get the base DN, scope, and filter for the search.
|
DN searchBaseDN = searchOperation.getBaseDN();
|
SearchScope scope = searchOperation.getScope();
|
SearchFilter filter = searchOperation.getFilter();
|
|
if (entry.matchesBaseAndScope(searchBaseDN, scope) &&
|
filter.matchesEntry(entry))
|
{
|
searchOperation.returnEntry(entry, new LinkedList<Control>());
|
}
|
}
|
}
|
catch (Exception e)
|
{
|
this.skippedCount++;
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, e);
|
}
|
Message message = null;
|
if (exportConfig != null)
|
{
|
message = ERR_BACKEND_EXPORT_ENTRY.get(
|
dn.toNormalizedString(), String.valueOf(e));
|
}
|
else
|
{
|
message = ERR_BACKEND_SEARCH_ENTRY.get(
|
dn.toNormalizedString(), e.getLocalizedMessage());
|
}
|
logError(message);
|
}
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public boolean supportsLDIFImport()
|
{
|
return false;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public synchronized LDIFImportResult importLDIF(LDIFImportConfig importConfig)
|
throws DirectoryException
|
{
|
return new LDIFImportResult(0, 0, 0);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public boolean supportsBackup()
|
{
|
// This backend does not provide a backup/restore mechanism.
|
return true;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public boolean supportsBackup(BackupConfig backupConfig,
|
StringBuilder unsupportedReason)
|
{
|
return true;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public void createBackup(BackupConfig backupConfig)
|
throws DirectoryException
|
{
|
BackupManager backupManager =
|
new BackupManager(getBackendID());
|
backupManager.createBackup(cfg, backupConfig);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public void removeBackup(BackupDirectory backupDirectory,
|
String backupID)
|
throws DirectoryException
|
{
|
BackupManager backupManager =
|
new BackupManager(getBackendID());
|
backupManager.removeBackup(this.backendDirectory, backupID);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public boolean supportsRestore()
|
{
|
return true;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public void restoreBackup(RestoreConfig restoreConfig)
|
throws DirectoryException
|
{
|
BackupManager backupManager =
|
new BackupManager(getBackendID());
|
backupManager.restoreBackup(cfg, restoreConfig);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public long numSubordinates(DN entryDN)
|
throws DirectoryException
|
{
|
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM,
|
ERR_NUM_SUBORDINATES_NOT_SUPPORTED.get());
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public ConditionResult hasSubordinates(DN entryDN)
|
throws DirectoryException
|
{
|
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM,
|
ERR_HAS_SUBORDINATES_NOT_SUPPORTED.get());
|
}
|
|
/**
|
* Set the replication server associated with this backend.
|
* @param server The replication server.
|
*/
|
public void setServer(ReplicationServer server)
|
{
|
this.server = server;
|
}
|
|
/**
|
* This class reports progress of the export job at fixed intervals.
|
*/
|
class ProgressTask extends TimerTask
|
{
|
/**
|
* The number of entries that had been exported at the time of the
|
* previous progress report.
|
*/
|
private long previousCount = 0;
|
|
/**
|
* The time in milliseconds of the previous progress report.
|
*/
|
private long previousTime;
|
|
/**
|
* Create a new export progress task.
|
*/
|
public ProgressTask()
|
{
|
previousTime = System.currentTimeMillis();
|
}
|
|
/**
|
* The action to be performed by this timer task.
|
*/
|
public void run()
|
{
|
long latestCount = exportedCount;
|
long deltaCount = (latestCount - previousCount);
|
long latestTime = System.currentTimeMillis();
|
long deltaTime = latestTime - previousTime;
|
|
if (deltaTime == 0)
|
{
|
return;
|
}
|
|
float rate = 1000f*deltaCount / deltaTime;
|
|
Message message =
|
INFO_JEB_EXPORT_PROGRESS_REPORT.get(latestCount, skippedCount, rate);
|
logError(message);
|
|
previousCount = latestCount;
|
previousTime = latestTime;
|
}
|
};
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public synchronized void search(SearchOperation searchOperation)
|
throws DirectoryException
|
{
|
// Get the base DN, scope, and filter for the search.
|
DN searchBaseDN = searchOperation.getBaseDN();
|
DN baseDN;
|
ArrayList<ReplicationCache> searchContainers =
|
new ArrayList<ReplicationCache>();
|
|
if (server==null)
|
{
|
server = retrievesReplicationServer();
|
|
if (server == null)
|
{
|
Message message = ERR_REPLICATIONBACKEND_ENTRY_DOESNT_EXIST.
|
get(String.valueOf(searchBaseDN));
|
throw new DirectoryException(
|
ResultCode.NO_SUCH_OBJECT, message, null, null);
|
}
|
}
|
|
// Make sure the base entry exists if it's supposed to be in this backend.
|
if (!handlesEntry(searchBaseDN))
|
{
|
DN matchedDN = searchBaseDN.getParentDNInSuffix();
|
while (matchedDN != null)
|
{
|
if (handlesEntry(matchedDN))
|
{
|
break;
|
}
|
matchedDN = matchedDN.getParentDNInSuffix();
|
}
|
|
Message message = ERR_REPLICATIONBACKEND_ENTRY_DOESNT_EXIST.
|
get(String.valueOf(searchBaseDN));
|
throw new DirectoryException(
|
ResultCode.NO_SUCH_OBJECT, message, matchedDN, null);
|
}
|
|
// Walk through all entries and send the ones that match.
|
Iterator<ReplicationCache> rcachei = server.getCacheIterator();
|
if (rcachei != null)
|
{
|
while (rcachei.hasNext())
|
{
|
ReplicationCache rc = rcachei.next();
|
|
// Skip containers that are not covered by the include branches.
|
baseDN = DN.decode(rc.getBaseDn().toString() + "," + EXPORT_BASE_DN);
|
|
if (searchBaseDN.isDescendantOf(baseDN) ||
|
searchBaseDN.isAncestorOf(baseDN))
|
{
|
searchContainers.add(rc);
|
}
|
}
|
}
|
|
for (ReplicationCache exportContainer : searchContainers)
|
{
|
processContainer(exportContainer, null, null, searchOperation);
|
}
|
}
|
|
/**
|
* Export the changes for a given ReplicationCache.
|
*/
|
private void searchContainer2(ReplicationCache rc,
|
SearchOperation searchOperation)
|
throws DirectoryException
|
{
|
// Walk through the servers
|
for (Short serverId : rc.getServers())
|
{
|
ReplicationIterator ri = rc.getChangelogIterator(serverId,
|
null);
|
|
if (ri == null)
|
break;
|
|
// Walk through the changes
|
while (ri.getChange() != null)
|
{
|
UpdateMessage msg = ri.getChange();
|
processChange(msg, null, null, searchOperation);
|
if (!ri.next())
|
break;
|
}
|
}
|
}
|
|
/**
|
* Retrieves the replication server associated to this backend.
|
*
|
* @return The server retrieved
|
* @throws DirectoryException When it occurs.
|
*/
|
protected static ReplicationServer retrievesReplicationServer()
|
throws DirectoryException
|
{
|
ReplicationServer replicationServer = null;
|
|
DirectoryServer.getSynchronizationProviders();
|
for (SynchronizationProvider provider :
|
DirectoryServer.getSynchronizationProviders())
|
{
|
if (provider instanceof MultimasterReplication)
|
{
|
MultimasterReplication mmp = (MultimasterReplication)provider;
|
ReplicationServerListener list = mmp.getReplicationServerListener();
|
if (list != null)
|
{
|
replicationServer = list.getReplicationServer();
|
break;
|
}
|
}
|
}
|
return replicationServer;
|
}
|
|
/**
|
* Writer class to read/write from/to a bytearray.
|
*/
|
private static final class Writer
|
{
|
// The underlying output stream.
|
private final ByteArrayOutputStream stream;
|
|
// The underlying LDIF config.
|
private final LDIFExportConfig config;
|
|
// The LDIF writer.
|
private final LDIFWriter writer;
|
|
/**
|
* Create a new string writer.
|
*/
|
public Writer() {
|
this.stream = new ByteArrayOutputStream();
|
this.config = new LDIFExportConfig(stream);
|
try {
|
this.writer = new LDIFWriter(config);
|
} catch (IOException e) {
|
// Should not happen.
|
throw new RuntimeException(e);
|
}
|
}
|
|
/**
|
* Get the LDIF writer.
|
*
|
* @return Returns the LDIF writer.
|
*/
|
public LDIFWriter getLDIFWriter() {
|
return writer;
|
}
|
|
/**
|
* Close the writer and get a string reader for the LDIF content.
|
*
|
* @return Returns the string contents of the writer.
|
* @throws Exception
|
* If an error occurred closing the writer.
|
*/
|
public BufferedReader getLDIFBufferedReader() throws Exception {
|
writer.close();
|
String ldif = stream.toString("UTF-8");
|
StringReader reader = new StringReader(ldif);
|
return new BufferedReader(reader);
|
}
|
|
/**
|
* Close the writer and get an LDIF reader for the LDIF content.
|
*
|
* @return Returns an LDIF Reader.
|
* @throws Exception
|
* If an error occurred closing the writer.
|
*/
|
public LDIFReader getLDIFReader() throws Exception {
|
writer.close();
|
ByteArrayInputStream istream = new
|
ByteArrayInputStream(stream.toByteArray());
|
String ldif = stream.toString("UTF-8");
|
ldif = ldif.replace("\n-\n", "\n");
|
istream = new ByteArrayInputStream(ldif.getBytes());
|
LDIFImportConfig config = new LDIFImportConfig(istream);
|
return new LDIFReader(config);
|
}
|
}
|
}
|
