/*
|
* 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 2008-2010 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.workflowelement.externalchangelog;
|
|
|
|
import static org.opends.messages.CoreMessages.*;
|
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.ServerConstants.*;
|
import static org.opends.server.util.StaticUtils.getExceptionMessage;
|
import static org.opends.server.util.StaticUtils.needsBase64Encoding;
|
|
import java.text.SimpleDateFormat;
|
import java.util.ArrayList;
|
import java.util.Collection;
|
import java.util.Collections;
|
import java.util.Date;
|
import java.util.HashMap;
|
import java.util.HashSet;
|
import java.util.Iterator;
|
import java.util.LinkedHashMap;
|
import java.util.List;
|
import java.util.Map;
|
import java.util.TimeZone;
|
|
import org.opends.messages.Category;
|
import org.opends.messages.Message;
|
import org.opends.messages.Severity;
|
import org.opends.server.api.ClientConnection;
|
import org.opends.server.api.plugin.PluginResult;
|
import org.opends.server.controls.EntryChangelogNotificationControl;
|
import org.opends.server.controls.ExternalChangelogRequestControl;
|
import org.opends.server.controls.LDAPAssertionRequestControl;
|
import org.opends.server.controls.MatchedValuesControl;
|
import org.opends.server.controls.PersistentSearchControl;
|
import org.opends.server.controls.ProxiedAuthV1Control;
|
import org.opends.server.controls.ProxiedAuthV2Control;
|
import org.opends.server.controls.SubentriesControl;
|
import org.opends.server.core.AccessControlConfigManager;
|
import org.opends.server.core.AddOperation;
|
import org.opends.server.core.DirectoryServer;
|
import org.opends.server.core.ModifyDNOperation;
|
import org.opends.server.core.ModifyOperation;
|
import org.opends.server.core.PersistentSearch;
|
import org.opends.server.core.PluginConfigManager;
|
import org.opends.server.core.SearchOperation;
|
import org.opends.server.core.SearchOperationWrapper;
|
import org.opends.server.loggers.debug.DebugTracer;
|
import org.opends.server.protocols.internal.InternalClientConnection;
|
import org.opends.server.replication.common.ChangeNumber;
|
import org.opends.server.replication.common.ExternalChangeLogSession;
|
import org.opends.server.replication.common.MultiDomainServerState;
|
import org.opends.server.replication.plugin.MultimasterReplication;
|
import org.opends.server.replication.protocol.AddMsg;
|
import org.opends.server.replication.protocol.DeleteMsg;
|
import org.opends.server.replication.protocol.ECLUpdateMsg;
|
import org.opends.server.replication.protocol.ModifyDNMsg;
|
import org.opends.server.replication.protocol.ModifyMsg;
|
import org.opends.server.replication.protocol.StartECLSessionMsg;
|
import org.opends.server.replication.protocol.UpdateMsg;
|
import org.opends.server.replication.server.ReplicationServer;
|
import org.opends.server.types.Attribute;
|
import org.opends.server.types.AttributeBuilder;
|
import org.opends.server.types.AttributeType;
|
import org.opends.server.types.AttributeValue;
|
import org.opends.server.types.Attributes;
|
import org.opends.server.types.CancelRequest;
|
import org.opends.server.types.CancelResult;
|
import org.opends.server.types.CanceledOperationException;
|
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.FilterType;
|
import org.opends.server.types.Modification;
|
import org.opends.server.types.ObjectClass;
|
import org.opends.server.types.Privilege;
|
import org.opends.server.types.RawAttribute;
|
import org.opends.server.types.ResultCode;
|
import org.opends.server.types.SearchFilter;
|
import org.opends.server.types.SearchScope;
|
import org.opends.server.types.operation.PostOperationSearchOperation;
|
import org.opends.server.types.operation.PreOperationSearchOperation;
|
import org.opends.server.types.operation.SearchEntrySearchOperation;
|
import org.opends.server.types.operation.SearchReferenceSearchOperation;
|
import org.opends.server.util.Base64;
|
import org.opends.server.util.ServerConstants;
|
import org.opends.server.config.ConfigConstants;
|
|
|
|
/**
|
* This class defines an operation used to search for entries in a local backend
|
* of the Directory Server.
|
*/
|
public class ECLSearchOperation
|
extends SearchOperationWrapper
|
implements PreOperationSearchOperation, PostOperationSearchOperation,
|
SearchEntrySearchOperation, SearchReferenceSearchOperation
|
{
|
/**
|
* The tracer object for the debug logger.
|
*/
|
private static final DebugTracer TRACER = getTracer();
|
|
/**
|
* The ECL Start Session we'll send to the RS.
|
*/
|
private StartECLSessionMsg startECLSessionMsg;
|
|
// The set of objectclasses that will be used in ECL entries.
|
private static HashMap<ObjectClass,String> eclObjectClasses;
|
|
// The associated DN.
|
private DN rootBaseDN;
|
|
/**
|
* The replication server in which the search on ECL is to be performed.
|
*/
|
protected ReplicationServer replicationServer;
|
|
/**
|
* The client connection for the search operation.
|
*/
|
protected ClientConnection clientConnection;
|
|
/**
|
* The base DN for the search.
|
*/
|
protected DN baseDN;
|
|
/**
|
* The persistent search request, if applicable.
|
*/
|
protected PersistentSearch persistentSearch;
|
|
/**
|
* The filter for the search.
|
*/
|
protected SearchFilter filter;
|
|
private ExternalChangeLogSession eclSession;
|
|
// The set of supported controls for this WE
|
private HashSet<String> supportedControls;
|
|
// The set of supported features for this WE
|
// TODO: any special feature to be implemented for an ECL search operation ?
|
private HashSet<String> supportedFeatures;
|
|
String privateDomainsBaseDN;
|
|
/**
|
* Creates a new operation that may be used to search for entries in a local
|
* backend of the Directory Server.
|
*
|
* @param search The operation to process.
|
*/
|
public ECLSearchOperation(SearchOperation search)
|
{
|
super(search);
|
|
try
|
{
|
rootBaseDN = DN.decode(ServerConstants.DN_EXTERNAL_CHANGELOG_ROOT);
|
}
|
catch (Exception e){}
|
|
// Construct the set of objectclasses to include in the base monitor entry.
|
eclObjectClasses = new LinkedHashMap<ObjectClass,String>(2);
|
ObjectClass topOC = DirectoryServer.getObjectClass(OC_TOP, true);
|
eclObjectClasses.put(topOC, OC_TOP);
|
ObjectClass eclEntryOC = DirectoryServer.getObjectClass(OC_CHANGELOG_ENTRY,
|
true);
|
eclObjectClasses.put(eclEntryOC, OC_CHANGELOG_ENTRY);
|
|
|
// Define an empty sets for the supported controls and features.
|
// FIXME:ECL Decide if ServerSideControl and VLV are supported
|
supportedControls = new HashSet<String>(0);
|
supportedControls.add(ServerConstants.OID_SERVER_SIDE_SORT_REQUEST_CONTROL);
|
supportedControls.add(ServerConstants.OID_VLV_REQUEST_CONTROL);
|
supportedFeatures = new HashSet<String>(0);
|
|
ECLWorkflowElement.attachLocalOperation(search, this);
|
}
|
|
|
|
/**
|
* Process this search operation against a local backend.
|
*
|
* @param wfe
|
* The local backend work-flow element.
|
* @throws CanceledOperationException
|
* if this operation should be cancelled
|
*/
|
public void processECLSearch(ECLWorkflowElement wfe)
|
throws CanceledOperationException
|
{
|
boolean executePostOpPlugins = false;
|
|
// Get the plugin config manager that will be used for invoking plugins.
|
PluginConfigManager pluginConfigManager =
|
DirectoryServer.getPluginConfigManager();
|
|
// Check for a request to cancel this operation.
|
checkIfCanceled(false);
|
|
searchProcessing:
|
{
|
replicationServer = wfe.getReplicationServer();
|
clientConnection = getClientConnection();
|
startECLSessionMsg = new StartECLSessionMsg();
|
|
// Set default behavior as "from draft change number".
|
// "from cookie" is set only when cookie is provided.
|
startECLSessionMsg.setECLRequestType(
|
StartECLSessionMsg.REQUEST_TYPE_FROM_DRAFT_CHANGE_NUMBER);
|
|
// Set a string operationid that will help correlate any error message
|
// logged for this operation with the 'real' client operation.
|
startECLSessionMsg.setOperationId(this.toString());
|
|
// Set a list of excluded domains (also exclude 'cn=changelog' itself)
|
ArrayList<String> excludedDomains =
|
MultimasterReplication.getECLDisabledDomains();
|
if (!excludedDomains.contains(ServerConstants.DN_EXTERNAL_CHANGELOG_ROOT))
|
excludedDomains.add(ServerConstants.DN_EXTERNAL_CHANGELOG_ROOT);
|
startECLSessionMsg.setExcludedDNs(excludedDomains);
|
|
// Test existence of the RS - normally should always be here
|
if (replicationServer == null)
|
{
|
setResultCode(ResultCode.OPERATIONS_ERROR);
|
appendErrorMessage(ERR_SEARCH_BASE_DOESNT_EXIST.get(
|
String.valueOf(baseDN)));
|
break searchProcessing;
|
}
|
|
// Process the search base and filter to convert them from their raw forms
|
// as provided by the client to the forms required for the rest of the
|
// search processing.
|
baseDN = getBaseDN();
|
filter = getFilter();
|
if ((baseDN == null) || (filter == null)){
|
break searchProcessing;
|
}
|
|
// Analyse controls - including the cookie control
|
try
|
{
|
handleRequestControls();
|
}
|
catch (DirectoryException de)
|
{
|
if (debugEnabled())
|
TRACER.debugCaught(DebugLogLevel.ERROR, de);
|
setResponseData(de);
|
break searchProcessing;
|
}
|
|
// Process filter - extract draft change number (seqnum) conditions
|
try
|
{
|
evaluateFilter(startECLSessionMsg, this.getFilter());
|
}
|
catch (DirectoryException de)
|
{
|
if (debugEnabled())
|
TRACER.debugCaught(DebugLogLevel.ERROR, de);
|
setResponseData(de);
|
break searchProcessing;
|
}
|
|
// Check for a request to cancel this operation.
|
checkIfCanceled(false);
|
|
// Invoke the pre-operation search plugins.
|
executePostOpPlugins = true;
|
PluginResult.PreOperation preOpResult =
|
pluginConfigManager.invokePreOperationSearchPlugins(this);
|
if (!preOpResult.continueProcessing())
|
{
|
setResultCode(preOpResult.getResultCode());
|
appendErrorMessage(preOpResult.getErrorMessage());
|
setMatchedDN(preOpResult.getMatchedDN());
|
setReferralURLs(preOpResult.getReferralURLs());
|
break searchProcessing;
|
}
|
|
// Check for a request to cancel this operation.
|
checkIfCanceled(false);
|
|
// Be optimistic by default.
|
setResultCode(ResultCode.SUCCESS);
|
|
// If there's a persistent search, then register it with the server.
|
if (persistentSearch != null)
|
{
|
wfe.registerPersistentSearch(persistentSearch);
|
persistentSearch.enable();
|
}
|
|
// Process the search.
|
try
|
{
|
processSearch();
|
}
|
catch (DirectoryException de)
|
{
|
if (debugEnabled())
|
TRACER.debugCaught(DebugLogLevel.ERROR, de);
|
|
setResponseData(de);
|
|
if (persistentSearch != null)
|
{
|
persistentSearch.cancel();
|
setSendResponse(true);
|
}
|
break searchProcessing;
|
}
|
catch (CanceledOperationException coe)
|
{
|
if (persistentSearch != null)
|
{
|
persistentSearch.cancel();
|
setSendResponse(true);
|
}
|
this.abort(null);
|
throw coe;
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
TRACER.debugCaught(DebugLogLevel.ERROR, e);
|
|
setResultCode(DirectoryServer.getServerErrorResultCode());
|
appendErrorMessage(ERR_SEARCH_BACKEND_EXCEPTION.get(
|
getExceptionMessage(e)));
|
if (persistentSearch != null)
|
{
|
persistentSearch.cancel();
|
setSendResponse(true);
|
}
|
break searchProcessing;
|
}
|
}
|
|
// Check for a request to cancel this operation.
|
checkIfCanceled(false);
|
|
// Invoke the post-operation search plugins.
|
if (executePostOpPlugins)
|
{
|
PluginResult.PostOperation postOpResult =
|
pluginConfigManager.invokePostOperationSearchPlugins(this);
|
if (!postOpResult.continueProcessing())
|
{
|
setResultCode(postOpResult.getResultCode());
|
appendErrorMessage(postOpResult.getErrorMessage());
|
setMatchedDN(postOpResult.getMatchedDN());
|
setReferralURLs(postOpResult.getReferralURLs());
|
}
|
}
|
}
|
|
|
/**
|
* Handles any controls contained in the request - including the cookie ctrl.
|
*
|
* @throws DirectoryException If there is a problem with any of the request
|
* controls.
|
*/
|
protected void handleRequestControls()
|
throws DirectoryException
|
{
|
List<Control> requestControls = getRequestControls();
|
if ((requestControls != null) && (! requestControls.isEmpty()))
|
{
|
for (int i=0; i < requestControls.size(); i++)
|
{
|
Control c = requestControls.get(i);
|
String oid = c.getOID();
|
if (! AccessControlConfigManager.getInstance().
|
getAccessControlHandler().isAllowed(baseDN, this, c))
|
{
|
throw new DirectoryException(ResultCode.INSUFFICIENT_ACCESS_RIGHTS,
|
ERR_CONTROL_INSUFFICIENT_ACCESS_RIGHTS.get(oid));
|
}
|
|
if (oid.equals(OID_ECL_COOKIE_EXCHANGE_CONTROL))
|
{
|
ExternalChangelogRequestControl eclControl =
|
getRequestControl(ExternalChangelogRequestControl.DECODER);
|
MultiDomainServerState cookie = eclControl.getCookie();
|
if (cookie!=null)
|
{
|
startECLSessionMsg.setECLRequestType(
|
StartECLSessionMsg.REQUEST_TYPE_FROM_COOKIE);
|
startECLSessionMsg.setCrossDomainServerState(cookie.toString());
|
}
|
}
|
else if (oid.equals(OID_LDAP_ASSERTION))
|
{
|
LDAPAssertionRequestControl assertControl =
|
getRequestControl(LDAPAssertionRequestControl.DECODER);
|
|
try
|
{
|
// FIXME -- We need to determine whether the current user has
|
// permission to make this determination.
|
SearchFilter assertionFilter = assertControl.getSearchFilter();
|
Entry entry;
|
try
|
{
|
entry = DirectoryServer.getEntry(baseDN);
|
}
|
catch (DirectoryException de)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, de);
|
}
|
|
throw new DirectoryException(de.getResultCode(),
|
ERR_SEARCH_CANNOT_GET_ENTRY_FOR_ASSERTION.get(
|
de.getMessageObject()));
|
}
|
|
if (entry == null)
|
{
|
throw new DirectoryException(ResultCode.NO_SUCH_OBJECT,
|
ERR_SEARCH_NO_SUCH_ENTRY_FOR_ASSERTION.get());
|
}
|
|
if (! assertionFilter.matchesEntry(entry))
|
{
|
throw new DirectoryException(ResultCode.ASSERTION_FAILED,
|
ERR_SEARCH_ASSERTION_FAILED.get());
|
}
|
}
|
catch (DirectoryException de)
|
{
|
if (de.getResultCode() == ResultCode.ASSERTION_FAILED)
|
{
|
throw de;
|
}
|
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, de);
|
}
|
|
throw new DirectoryException(ResultCode.PROTOCOL_ERROR,
|
ERR_SEARCH_CANNOT_PROCESS_ASSERTION_FILTER.get(
|
de.getMessageObject()), de);
|
}
|
}
|
else if (oid.equals(OID_PROXIED_AUTH_V1))
|
{
|
// The requester must have the PROXIED_AUTH privilige in order to be
|
// able to use this control.
|
if (! clientConnection.hasPrivilege(Privilege.PROXIED_AUTH, this))
|
{
|
throw new DirectoryException(ResultCode.AUTHORIZATION_DENIED,
|
ERR_PROXYAUTH_INSUFFICIENT_PRIVILEGES.get());
|
}
|
|
ProxiedAuthV1Control proxyControl =
|
getRequestControl(ProxiedAuthV1Control.DECODER);
|
|
Entry authorizationEntry = proxyControl.getAuthorizationEntry();
|
setAuthorizationEntry(authorizationEntry);
|
if (authorizationEntry == null)
|
{
|
setProxiedAuthorizationDN(DN.nullDN());
|
}
|
else
|
{
|
setProxiedAuthorizationDN(authorizationEntry.getDN());
|
}
|
}
|
else if (oid.equals(OID_PROXIED_AUTH_V2))
|
{
|
// The requester must have the PROXIED_AUTH privilige in order to be
|
// able to use this control.
|
if (! clientConnection.hasPrivilege(Privilege.PROXIED_AUTH, this))
|
{
|
throw new DirectoryException(ResultCode.AUTHORIZATION_DENIED,
|
ERR_PROXYAUTH_INSUFFICIENT_PRIVILEGES.get());
|
}
|
|
ProxiedAuthV2Control proxyControl =
|
getRequestControl(ProxiedAuthV2Control.DECODER);
|
|
Entry authorizationEntry = proxyControl.getAuthorizationEntry();
|
setAuthorizationEntry(authorizationEntry);
|
if (authorizationEntry == null)
|
{
|
setProxiedAuthorizationDN(DN.nullDN());
|
}
|
else
|
{
|
setProxiedAuthorizationDN(authorizationEntry.getDN());
|
}
|
}
|
else if (oid.equals(OID_PERSISTENT_SEARCH))
|
{
|
PersistentSearchControl psearchControl =
|
getRequestControl(PersistentSearchControl.DECODER);
|
|
persistentSearch = new PersistentSearch(this,
|
psearchControl.getChangeTypes(),
|
psearchControl.getReturnECs());
|
|
// If we're only interested in changes, then we don't actually want
|
// to process the search now.
|
if (!psearchControl.getChangesOnly())
|
startECLSessionMsg.setPersistent(
|
StartECLSessionMsg.PERSISTENT);
|
else
|
startECLSessionMsg.setPersistent(
|
StartECLSessionMsg.PERSISTENT_CHANGES_ONLY);
|
}
|
else if (oid.equals(OID_LDAP_SUBENTRIES))
|
{
|
SubentriesControl subentriesControl =
|
getRequestControl(SubentriesControl.DECODER);
|
setReturnLDAPSubentries(subentriesControl.getVisibility());
|
}
|
else if (oid.equals(OID_MATCHED_VALUES))
|
{
|
MatchedValuesControl matchedValuesControl =
|
getRequestControl(MatchedValuesControl.DECODER);
|
setMatchedValuesControl(matchedValuesControl);
|
}
|
else if (oid.equals(OID_ACCOUNT_USABLE_CONTROL))
|
{
|
setIncludeUsableControl(true);
|
}
|
else if (oid.equals(OID_REAL_ATTRS_ONLY))
|
{
|
setRealAttributesOnly(true);
|
}
|
else if (oid.equals(OID_VIRTUAL_ATTRS_ONLY))
|
{
|
setVirtualAttributesOnly(true);
|
}
|
else if (oid.equals(OID_GET_EFFECTIVE_RIGHTS) &&
|
DirectoryServer.isSupportedControl(OID_GET_EFFECTIVE_RIGHTS))
|
{
|
// Do nothing here and let AciHandler deal with it.
|
}
|
|
// TODO: Add support for additional controls, including VLV
|
else if (c.isCritical())
|
{
|
if ((replicationServer == null) || (! supportsControl(oid)))
|
{
|
throw new DirectoryException(
|
ResultCode.UNAVAILABLE_CRITICAL_EXTENSION,
|
ERR_SEARCH_UNSUPPORTED_CRITICAL_CONTROL.get(oid));
|
}
|
}
|
}
|
}
|
}
|
|
private void processSearch()
|
throws DirectoryException, CanceledOperationException
|
{
|
if (debugEnabled())
|
TRACER.debugInfo(
|
" processSearch toString=[" + toString() + "] opid=["
|
+ startECLSessionMsg.getOperationId() + "]");
|
|
// Start a specific ECL session
|
eclSession = replicationServer.createECLSession(startECLSessionMsg);
|
|
if (true)
|
{
|
// Loop on result entries
|
int INITIAL=0;
|
int PSEARCH=1;
|
int phase=INITIAL;
|
boolean returnedRoot = false;
|
while (true)
|
{
|
// Check for a request to cancel this operation.
|
checkIfCanceled(false);
|
|
ECLUpdateMsg update = eclSession.getNextUpdate();
|
if (update!=null)
|
{
|
if (!returnedRoot)
|
{
|
returnRootEntryIfRequired(true);
|
returnedRoot = true;
|
}
|
if (phase==INITIAL)
|
{
|
if (!buildAndReturnEntry(update))
|
{
|
// Abandon, Size limit reached
|
eclSession.close();
|
break;
|
}
|
}
|
}
|
else
|
{
|
if (!returnedRoot)
|
{
|
returnRootEntryIfRequired(false);
|
returnedRoot = true;
|
}
|
if (phase==INITIAL)
|
{
|
if (this.persistentSearch == null)
|
{
|
eclSession.close();
|
break;
|
}
|
else
|
{
|
phase=PSEARCH;
|
break;
|
}
|
}
|
}
|
}
|
}
|
}
|
|
private void returnRootEntryIfRequired(boolean hasSubordinates)
|
throws DirectoryException
|
{
|
if (!getScope().equals(SearchScope.SINGLE_LEVEL))
|
{
|
// Root entry
|
Entry entry = createRootEntry(hasSubordinates);
|
if (matchFilter(entry))
|
returnEntry(entry, null);
|
}
|
}
|
|
private boolean supportsControl(String oid)
|
{
|
return ((supportedControls != null) &&
|
supportedControls.contains(oid));
|
}
|
|
/**
|
* Build an ECL entry from a provided ECL msg and return it.
|
* @param eclmsg The provided ECL msg.
|
* @return <CODE>true</CODE> if the caller should continue processing the
|
* search request and sending additional entries and references, or
|
* <CODE>false</CODE> if not for some reason (e.g., the size limit
|
* has been reached or the search has been abandoned).
|
* @throws DirectoryException When an errors occurs.
|
*/
|
private boolean buildAndReturnEntry(ECLUpdateMsg eclmsg)
|
throws DirectoryException
|
{
|
Entry entry = null;
|
|
// build and filter
|
entry = createEntryFromMsg(eclmsg);
|
if (matchFilter(entry))
|
{
|
List<Control> controls = new ArrayList<Control>(0);
|
|
EntryChangelogNotificationControl clrc
|
= new EntryChangelogNotificationControl(
|
true,eclmsg.getCookie().toString());
|
controls.add(clrc);
|
return returnEntry(entry, controls);
|
}
|
return true;
|
}
|
|
/**
|
* Test if the provided entry matches the filter, base and scope.
|
* @param entry The provided entry
|
* @return whether the entry matches.
|
* @throws DirectoryException When a problem occurs.
|
*/
|
private boolean matchFilter(Entry entry)
|
throws DirectoryException
|
{
|
boolean baseScopeMatch = entry.matchesBaseAndScope(getBaseDN(), getScope());
|
boolean filterMatch = getFilter().matchesEntry(entry);
|
return (baseScopeMatch && filterMatch);
|
}
|
|
/**
|
* Create an ECL entry from a provided ECL msg.
|
*
|
* @param eclmsg the provided ECL msg.
|
* @return the created ECL entry.
|
* @throws DirectoryException When an error occurs.
|
*/
|
public static Entry createEntryFromMsg(ECLUpdateMsg eclmsg)
|
throws DirectoryException
|
{
|
Entry clEntry = null;
|
|
// Get the meat fro the ecl msg
|
UpdateMsg msg = eclmsg.getUpdateMsg();
|
|
if (msg instanceof AddMsg)
|
{
|
AddMsg addMsg = (AddMsg)msg;
|
|
// Map the addMsg to an LDIF string for the 'changes' attribute
|
String LDIFchanges = addMsgToLDIFString(addMsg);
|
|
ArrayList<RawAttribute> eclAttributes = addMsg.getEclIncludes();
|
|
clEntry = createChangelogEntry(
|
eclmsg.getServiceId(),
|
eclmsg.getCookie().toString(),
|
DN.decode(addMsg.getDn()),
|
addMsg.getChangeNumber(),
|
LDIFchanges, // entry as created (in LDIF format)
|
addMsg.getUniqueId(),
|
null, // real time current entry
|
eclAttributes, // entry attributes
|
eclmsg.getDraftChangeNumber(),
|
"add", null);
|
|
} else
|
if (msg instanceof ModifyMsg)
|
{
|
ModifyMsg modMsg = (ModifyMsg)msg;
|
InternalClientConnection conn =
|
InternalClientConnection.getRootConnection();
|
try
|
{
|
// Map the modMsg modifications to an LDIF string
|
// for the 'changes' attribute of the CL entry
|
ModifyOperation modifyOperation =
|
(ModifyOperation)modMsg.createOperation(conn);
|
String LDIFchanges = modToLDIF(modifyOperation.getModifications());
|
|
ArrayList<RawAttribute> eclAttributes = modMsg.getEclIncludes();
|
|
clEntry = createChangelogEntry(
|
eclmsg.getServiceId(),
|
eclmsg.getCookie().toString(),
|
DN.decode(modMsg.getDn()),
|
modMsg.getChangeNumber(),
|
LDIFchanges,
|
modMsg.getUniqueId(),
|
null, // real time current entry
|
eclAttributes, // entry attributes
|
eclmsg.getDraftChangeNumber(),
|
"modify",null);
|
|
}
|
catch(Exception e)
|
{
|
// Exceptions raised by createOperation for example
|
throw new DirectoryException(ResultCode.OTHER,
|
Message.raw(Category.SYNC, Severity.NOTICE,
|
" Server fails to create entry: "),e);
|
}
|
}
|
else if (msg instanceof ModifyDNMsg)
|
{
|
try
|
{
|
InternalClientConnection conn =
|
InternalClientConnection.getRootConnection();
|
ModifyDNMsg modDNMsg = (ModifyDNMsg)msg;
|
|
ArrayList<RawAttribute> eclAttributes = modDNMsg.getEclIncludes();
|
ModifyDNOperation modifyDNOperation =
|
(ModifyDNOperation)modDNMsg.createOperation(conn);
|
String LDIFchanges = modToLDIF(modifyDNOperation.getModifications());
|
|
clEntry = createChangelogEntry(
|
eclmsg.getServiceId(),
|
eclmsg.getCookie().toString(),
|
DN.decode(modDNMsg.getDn()),
|
modDNMsg.getChangeNumber(),
|
LDIFchanges,
|
modDNMsg.getUniqueId(),
|
null, // real time current entry
|
eclAttributes, // entry attributes
|
eclmsg.getDraftChangeNumber(),
|
"modrdn", null);
|
|
Attribute a = Attributes.create("newrdn", modDNMsg.getNewRDN());
|
clEntry.addAttribute(a, null);
|
|
if (modDNMsg.getNewSuperior()!=null)
|
{
|
Attribute b = Attributes.create("newsuperior",
|
modDNMsg.getNewSuperior());
|
clEntry.addAttribute(b, null);
|
}
|
|
Attribute c = Attributes.create("deleteoldrdn",
|
String.valueOf(modDNMsg.deleteOldRdn()));
|
clEntry.addAttribute(c, null);
|
}
|
catch(Exception e)
|
{
|
// Exceptions raised by createOperation for example
|
throw new DirectoryException(ResultCode.OTHER,
|
Message.raw(Category.SYNC, Severity.NOTICE,
|
" Server fails to create entry: "),e);
|
}
|
|
}
|
else if (msg instanceof DeleteMsg)
|
{
|
DeleteMsg delMsg = (DeleteMsg)msg;
|
|
ArrayList<RawAttribute> eclAttributes = delMsg.getEclIncludes();
|
|
clEntry = createChangelogEntry(
|
eclmsg.getServiceId(),
|
eclmsg.getCookie().toString(),
|
DN.decode(delMsg.getDn()),
|
delMsg.getChangeNumber(),
|
null, // no changes
|
delMsg.getUniqueId(),
|
null,
|
eclAttributes, // entry attributes
|
eclmsg.getDraftChangeNumber(),
|
"delete", delMsg.getInitiatorsName());
|
}
|
return clEntry;
|
}
|
|
/**
|
* Creates the root entry of the external changelog.
|
* @param hasSubordinates whether the root entry has subordinates or not.
|
* @return The root entry created.
|
*/
|
private Entry createRootEntry(boolean hasSubordinates)
|
{
|
HashMap<ObjectClass,String> oclasses =
|
new LinkedHashMap<ObjectClass,String>(3);
|
|
// Objectclass
|
HashMap<ObjectClass,String> rootObjectClasses =
|
new LinkedHashMap<ObjectClass,String>(2);
|
ObjectClass topOC = DirectoryServer.getObjectClass(OC_TOP, true);
|
rootObjectClasses.put(topOC, OC_TOP);
|
ObjectClass containerOC = DirectoryServer.getObjectClass("container", true);
|
rootObjectClasses.put(containerOC, "container");
|
oclasses.putAll(rootObjectClasses);
|
HashMap<AttributeType,List<Attribute>> userAttrs =
|
new LinkedHashMap<AttributeType,List<Attribute>>();
|
HashMap<AttributeType,List<Attribute>> operationalAttrs =
|
new LinkedHashMap<AttributeType,List<Attribute>>();
|
|
// subSchemaSubentry
|
AttributeType aType =
|
DirectoryServer.getAttributeType(ATTR_SUBSCHEMA_SUBENTRY_LC);
|
if (aType == null)
|
aType = DirectoryServer.getDefaultAttributeType(ATTR_SUBSCHEMA_SUBENTRY);
|
Attribute a = Attributes.create(ATTR_SUBSCHEMA_SUBENTRY,
|
ConfigConstants.DN_DEFAULT_SCHEMA_ROOT);
|
List<Attribute> attrList = Collections.singletonList(a);
|
if (aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
userAttrs.put(aType, attrList);
|
|
// TODO:numSubordinates
|
|
// hasSubordinates
|
if (hasSubordinates)
|
{
|
aType = DirectoryServer.getAttributeType("hassubordinates");
|
if (aType == null)
|
aType = DirectoryServer.getDefaultAttributeType("hasSubordinates");
|
a = Attributes.create("hasSubordinates", "true");
|
attrList = Collections.singletonList(a);
|
if (aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
userAttrs.put(aType, attrList);
|
}
|
|
// entryDN
|
aType = DirectoryServer.getAttributeType("entrydn");
|
if (aType == null)
|
aType = DirectoryServer.getDefaultAttributeType("entryDN");
|
a = Attributes.create("entryDN", rootBaseDN.toNormalizedString());
|
attrList = Collections.singletonList(a);
|
if (aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
userAttrs.put(aType, attrList);
|
|
Entry e = new Entry(this.rootBaseDN, oclasses, userAttrs, operationalAttrs);
|
return e;
|
}
|
|
/**
|
* Create an ECL entry from a set of provided information. This is the part
|
* of entry creation common to all types of msgs (ADD, DEL, MOD, MODDN).
|
*
|
* @param serviceID The provided cookie value.
|
* @param cookie The provided cookie value.
|
* @param targetDN The provided targetDN.
|
* @param changeNumber The provided replication changeNumber.
|
* @param clearLDIFchanges The provided LDIF changes for ADD and MODIFY
|
* @param targetUUID The provided targetUUID.
|
* @param entry The provided related current entry.
|
* @param histEntryAttributes TODO:ECL Adress hist entry attributes
|
* @param draftChangenumber The provided draft change number (integer)
|
* @param changetype The provided change type (add, ...)
|
* @param delInitiatorsName The provided del initiatiors name
|
* @return The created ECL entry.
|
* @throws DirectoryException
|
* When any error occurs.
|
*/
|
public static Entry createChangelogEntry(
|
String serviceID,
|
String cookie,
|
DN targetDN,
|
ChangeNumber changeNumber,
|
String clearLDIFchanges,
|
String targetUUID,
|
Entry entry,
|
List<RawAttribute> histEntryAttributes,
|
int draftChangenumber,
|
String changetype,
|
String delInitiatorsName)
|
throws DirectoryException
|
{
|
AttributeType aType;
|
|
String dnString = "";
|
String pattern;
|
if (draftChangenumber == 0)
|
{
|
// Draft uncompat mode
|
dnString = "replicationcsn="+ changeNumber +"," + serviceID
|
+ "," + ServerConstants.DN_EXTERNAL_CHANGELOG_ROOT;
|
}
|
else
|
{
|
// Draft compat mode
|
dnString = "changenumber="+ draftChangenumber + "," +
|
ServerConstants.DN_EXTERNAL_CHANGELOG_ROOT;
|
}
|
|
// Objectclass
|
HashMap<ObjectClass,String> oClasses =
|
new LinkedHashMap<ObjectClass,String>(3);
|
oClasses.putAll(eclObjectClasses);
|
|
ObjectClass extensibleObjectOC =
|
DirectoryServer.getObjectClass(OC_EXTENSIBLE_OBJECT_LC, true);
|
oClasses.put(extensibleObjectOC, OC_EXTENSIBLE_OBJECT);
|
|
HashMap<AttributeType,List<Attribute>> uAttrs =
|
new LinkedHashMap<AttributeType,List<Attribute>>();
|
|
HashMap<AttributeType,List<Attribute>> operationalAttrs =
|
new LinkedHashMap<AttributeType,List<Attribute>>();
|
|
// Operational standard attributes
|
|
// subSchemaSubentry
|
aType = DirectoryServer.getAttributeType(ATTR_SUBSCHEMA_SUBENTRY_LC);
|
if (aType == null)
|
aType = DirectoryServer.getDefaultAttributeType(ATTR_SUBSCHEMA_SUBENTRY_LC);
|
Attribute a = Attributes.create(ATTR_SUBSCHEMA_SUBENTRY_LC,
|
ConfigConstants.DN_DEFAULT_SCHEMA_ROOT);
|
List<Attribute> attrList = Collections.singletonList(a);
|
if (aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
|
// numSubordinates
|
aType = DirectoryServer.getAttributeType("numsubordinates");
|
if (aType == null)
|
aType = DirectoryServer.getDefaultAttributeType("numSubordinates");
|
a = Attributes.create("numSubordinates", "0");
|
attrList = Collections.singletonList(a);
|
if (aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
|
// hasSubordinates
|
aType = DirectoryServer.getAttributeType("hassubordinates");
|
if (aType == null)
|
aType = DirectoryServer.getDefaultAttributeType("hasSubordinates");
|
a = Attributes.create("hasSubordinates", "false");
|
attrList = Collections.singletonList(a);
|
if (aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
|
// entryDN
|
aType = DirectoryServer.getAttributeType("entrydn");
|
if (aType == null)
|
aType = DirectoryServer.getDefaultAttributeType("entryDN");
|
a = Attributes.create("entryDN", dnString);
|
attrList = Collections.singletonList(a);
|
if (aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
|
// REQUIRED attributes
|
|
// ECL Changelog draft change number
|
if((aType = DirectoryServer.getAttributeType("changenumber")) == null)
|
aType = DirectoryServer.getDefaultAttributeType("changenumber");
|
a = Attributes.create("changenumber", String.valueOf(draftChangenumber));
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
|
//
|
if((aType = DirectoryServer.getAttributeType("changetime")) == null)
|
aType = DirectoryServer.getDefaultAttributeType("changetime");
|
SimpleDateFormat dateFormat;
|
dateFormat = new SimpleDateFormat(DATE_FORMAT_GMT_TIME);
|
dateFormat.setTimeZone(TimeZone.getTimeZone("UTC")); // ??
|
a = Attributes.create(aType,
|
dateFormat.format(new Date(changeNumber.getTime())));
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
|
/* Change time in a friendly format
|
Date date = new Date(changeNumber.getTime());
|
a = Attributes.create("clearChangeTime", date.toString());
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
uAttrs.put(a.getAttributeType(), attrList);
|
*/
|
|
//
|
if((aType = DirectoryServer.getAttributeType("changetype")) == null)
|
aType = DirectoryServer.getDefaultAttributeType("changetype");
|
a = Attributes.create(aType, changetype);
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
|
//
|
if((aType = DirectoryServer.getAttributeType("targetdn")) == null)
|
aType = DirectoryServer.getDefaultAttributeType("targetdn");
|
a = Attributes.create(aType, targetDN.toNormalizedString());
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
|
// NON REQUESTED attributes
|
|
if((aType = DirectoryServer.getAttributeType("replicationcsn")) == null)
|
aType = DirectoryServer.getDefaultAttributeType("replicationcsn");
|
a = Attributes.create(aType, changeNumber.toString());
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
|
//
|
if((aType = DirectoryServer.getAttributeType("replicaidentifier")) == null)
|
aType = DirectoryServer.getDefaultAttributeType("replicaidentifier");
|
a = Attributes.create(aType, Integer.toString(changeNumber.getServerId()));
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
|
if (clearLDIFchanges != null)
|
{
|
if (changetype.equals("add"))
|
{
|
if((aType = DirectoryServer.getAttributeType("changes")) == null)
|
aType = DirectoryServer.getDefaultAttributeType("changes");
|
|
a = Attributes.create(aType, clearLDIFchanges + "\n");
|
// force base64
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
|
pattern = "creatorsName: ";
|
try
|
{
|
int att_cr = clearLDIFchanges.indexOf(pattern);
|
if (att_cr>0)
|
{
|
int start_val_cr = clearLDIFchanges.indexOf(':', att_cr);
|
int end_val_cr = clearLDIFchanges.indexOf(EOL, att_cr);
|
String creatorsName =
|
clearLDIFchanges.substring(start_val_cr+2, end_val_cr);
|
|
if((aType =
|
DirectoryServer.getAttributeType("changeInitiatorsName")) == null)
|
aType =
|
DirectoryServer.getDefaultAttributeType("changeInitiatorsName");
|
a = Attributes.create(aType, creatorsName);
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
}
|
}
|
catch(Exception e)
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, e);
|
logError(Message.raw(Category.SYNC, Severity.MILD_ERROR,
|
"Error in External Change Log when looking for pattern \""
|
+ pattern + "\" in string \""+
|
clearLDIFchanges + "\" for change " + dnString));
|
}
|
}
|
else if (changetype.equals("modify")||changetype.equals("modrdn"))
|
{
|
if (changetype.equals("modify"))
|
{
|
if((aType = DirectoryServer.getAttributeType("changes")) == null)
|
aType = DirectoryServer.getDefaultAttributeType("changes");
|
|
a = Attributes.create(aType, clearLDIFchanges + "\n");
|
// force base64
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
}
|
|
pattern = "modifiersName: ";
|
try
|
{
|
int att_cr = clearLDIFchanges.indexOf(pattern);
|
if (att_cr>0)
|
{
|
int start_val_cr = att_cr + pattern.length();
|
int end_val_cr = clearLDIFchanges.indexOf(EOL, att_cr);
|
String modifiersName =
|
clearLDIFchanges.substring(start_val_cr, end_val_cr);
|
|
if((aType =
|
DirectoryServer.getAttributeType("changeInitiatorsName")) == null)
|
aType =
|
DirectoryServer.getDefaultAttributeType("changeInitiatorsName");
|
a = Attributes.create(aType, modifiersName);
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
}
|
}
|
catch(Exception e)
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, e);
|
logError(Message.raw(Category.SYNC, Severity.MILD_ERROR,
|
"Error in External Change Log when looking for pattern \""
|
+ pattern + "\" in string \""+
|
clearLDIFchanges + "\" for change " + dnString));
|
}
|
}
|
}
|
|
if (changetype.equals("delete") && (delInitiatorsName!=null))
|
{
|
if((aType = DirectoryServer.getAttributeType("changeInitiatorsName"))
|
== null)
|
aType = DirectoryServer.getDefaultAttributeType("changeInitiatorsName");
|
a = Attributes.create(aType, delInitiatorsName);
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
}
|
|
if (targetUUID != null)
|
{
|
if((aType = DirectoryServer.getAttributeType("targetentryuuid")) == null)
|
aType = DirectoryServer.getDefaultAttributeType("targetentryuuid");
|
a = Attributes.create(aType, targetUUID);
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
|
if (draftChangenumber>0)
|
{
|
// compat mode
|
if((aType = DirectoryServer.getAttributeType("targetuniqueid")) == null)
|
aType = DirectoryServer.getDefaultAttributeType("targetuniqueid");
|
String dseeValue = null;
|
try
|
{
|
dseeValue = ECLSearchOperation.openDsToSunDseeNsUniqueId(targetUUID);
|
}
|
catch(Exception e)
|
{
|
Message errMessage =
|
NOTE_ERR_ENTRY_UID_DSEE_MAPPING.get(
|
targetDN.toNormalizedString(),
|
targetUUID,
|
e.getLocalizedMessage());
|
logError(errMessage);
|
if (debugEnabled())
|
TRACER.debugCaught(DebugLogLevel.ERROR, e);
|
}
|
|
// If the mapping fails, we don't want to stop the operation
|
// or not return this entry.
|
if (dseeValue != null)
|
{
|
a = Attributes.create(aType, dseeValue);
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
}
|
}
|
}
|
|
if((aType = DirectoryServer.getAttributeType("changelogcookie")) == null)
|
aType = DirectoryServer.getDefaultAttributeType("changelogcookie");
|
a = Attributes.create(aType, cookie);
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(a);
|
if(aType.isOperational())
|
operationalAttrs.put(aType, attrList);
|
else
|
uAttrs.put(aType, attrList);
|
|
if (histEntryAttributes != null)
|
{
|
for (RawAttribute ra : histEntryAttributes)
|
{
|
try
|
{
|
String attrName = ra.getAttributeType().toLowerCase();
|
String eclName = "target" + attrName;
|
AttributeBuilder builder = new AttributeBuilder(
|
DirectoryServer.getDefaultAttributeType(eclName));
|
AttributeType at = builder.getAttributeType();
|
builder.setOptions(ra.toAttribute().getOptions());
|
builder.addAll(ra.toAttribute());
|
attrList = new ArrayList<Attribute>(1);
|
attrList.add(builder.toAttribute());
|
uAttrs.put(at, attrList);
|
}
|
catch(Exception e)
|
{
|
|
}
|
}
|
}
|
|
// at the end build the CL entry to be returned
|
Entry cle = new Entry(
|
DN.decode(dnString),
|
eclObjectClasses,
|
uAttrs,
|
operationalAttrs);
|
|
return cle;
|
}
|
|
/**
|
* Dump a replication AddMsg to an LDIF string that will be the 'changes'
|
* attributes of the ECL entry.
|
* @param addMsg The provided replication add msg.
|
* @return The LDIF string.
|
*/
|
private static String addMsgToLDIFString(AddMsg addMsg)
|
{
|
StringBuilder modTypeLine = new StringBuilder();
|
// LinkedList<StringBuilder> ldifLines =
|
// new LinkedList<StringBuilder>();
|
|
try
|
{
|
AddOperation addOperation = (AddOperation)addMsg.createOperation(
|
InternalClientConnection.getRootConnection());
|
|
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);
|
}
|
}
|
for (List<Attribute> attrList : attributes.values())
|
{
|
for (Attribute a : attrList)
|
{
|
StringBuilder attrName = new StringBuilder(a.getName());
|
for (String o : a.getOptions())
|
{
|
attrName.append(";");
|
attrName.append(o);
|
}
|
for (AttributeValue av : a)
|
{
|
String stringValue = av.toString();
|
|
modTypeLine.append(attrName);
|
if (needsBase64Encoding(stringValue))
|
{
|
modTypeLine.append(":: ");
|
modTypeLine.append(Base64.encode(av.getValue()));
|
}
|
else
|
{
|
modTypeLine.append(": ");
|
modTypeLine.append(stringValue);
|
}
|
modTypeLine.append("\n");
|
}
|
}
|
}
|
return modTypeLine.toString();
|
}
|
catch(Exception e)
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, e);
|
}
|
return null;
|
}
|
|
/**
|
* Dump a replication delMsg to an LDIF string that will be the 'changes'
|
* attributes of the ECL entry.
|
* @param addMsg The provided replication del msg.
|
* @return The LDIF string.
|
private static String delMsgToLDIFString(ArrayList<RawAttribute> rattributes)
|
{
|
StringBuilder delTypeLine = new StringBuilder();
|
try
|
{
|
|
Map<AttributeType,List<Attribute>> attributes =
|
new HashMap<AttributeType,List<Attribute>>();
|
|
for (RawAttribute a : rattributes)
|
{
|
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);
|
}
|
}
|
|
for (List<Attribute> attrList : attributes.values())
|
{
|
for (Attribute a : attrList)
|
{
|
StringBuilder attrName = new StringBuilder(a.getName());
|
for (String o : a.getOptions())
|
{
|
attrName.append(";");
|
attrName.append(o);
|
}
|
for (AttributeValue av : a)
|
{
|
// ??
|
String stringValue = av.toString();
|
delTypeLine.append(attrName);
|
if (needsBase64Encoding(stringValue))
|
{
|
delTypeLine.append(":: ");
|
delTypeLine.append(Base64.encode(av.getValue()));
|
}
|
else
|
{
|
delTypeLine.append(": ");
|
delTypeLine.append(stringValue);
|
}
|
delTypeLine.append("\n");
|
}
|
}
|
}
|
return delTypeLine.toString();
|
}
|
catch(Exception e)
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, e);
|
}
|
return null;
|
}
|
*/
|
|
/**
|
* Dumps a list of modifications into an LDIF string.
|
* @param mods The provided list of modifications.
|
* @return The LDIF string.
|
*/
|
public static String modToLDIF(List<Modification> mods)
|
{
|
if (mods==null)
|
{
|
// test case only
|
return null;
|
}
|
StringBuilder modTypeLine = new StringBuilder();
|
Iterator<Modification> iterator = mods.iterator();
|
while (iterator.hasNext())
|
{
|
Modification m = iterator.next();
|
Attribute a = m.getAttribute();
|
String attrName = a.getName();
|
modTypeLine.append(m.getModificationType().getLDIFName());
|
modTypeLine.append(": ");
|
modTypeLine.append(attrName);
|
modTypeLine.append("\n");
|
|
Iterator<AttributeValue> iteratorValues = a.iterator();
|
while (iteratorValues.hasNext())
|
{
|
AttributeValue av = iteratorValues.next();
|
|
String stringValue = av.toString();
|
|
modTypeLine.append(attrName);
|
if (needsBase64Encoding(stringValue))
|
{
|
modTypeLine.append(":: ");
|
modTypeLine.append(Base64.encode(av.getValue()));
|
}
|
else
|
{
|
modTypeLine.append(": ");
|
modTypeLine.append(stringValue);
|
}
|
modTypeLine.append("\n");
|
}
|
|
modTypeLine.append("-");
|
if (iterator.hasNext())
|
{
|
modTypeLine.append("\n");
|
}
|
}
|
return modTypeLine.toString();
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public CancelResult cancel(CancelRequest cancelRequest)
|
{
|
if (debugEnabled())
|
TRACER.debugInfo(this + " cancel() " + eclSession);
|
if (eclSession != null)
|
{
|
try
|
{
|
eclSession.close();
|
}
|
catch(Exception e){}
|
}
|
return super.cancel(cancelRequest);
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public void abort(CancelRequest cancelRequest)
|
{
|
if (debugEnabled())
|
TRACER.debugInfo(this + " abort() " + eclSession);
|
if (eclSession != null)
|
{
|
try
|
{
|
eclSession.close();
|
}
|
catch(Exception e){}
|
}
|
}
|
|
/**
|
* The unique identifier used in DSEE is named nsUniqueId and its format is
|
* HHHHHHHH-HHHHHHHH-HHHHHHHH-HHHHHHHH where H is a hex digit.
|
* An nsUniqueId value is for example 3970de28-08b311d9-8095b9bf-c4d9231c
|
* The unique identifier used in OpenDS is named entryUUID.
|
* Its value is for example entryUUID: 50dd9673-71e1-4478-b13c-dba387c4d7e1
|
* @param entryUid the OpenDS entry UID
|
* @return the Dsee format for the entry UID
|
*/
|
private static String openDsToSunDseeNsUniqueId(String entryUid)
|
{
|
// the conversion from one unique identifier to an other is
|
// a question of formating : the last "-" is placed
|
StringBuffer buffer = new StringBuffer(entryUid);
|
// Delete a "-" at 13 to get something like
|
buffer.deleteCharAt(13);
|
|
// Delete a "-" at 23 to get something like
|
buffer.deleteCharAt(22);
|
|
// Add the last "-" to get something like
|
buffer.insert(26,'-');
|
|
return buffer.toString();
|
}
|
|
/**
|
* Traverse the provided search filter, looking for some conditions
|
* on attributes that can be optimized in the ECL.
|
* When found, populate the provided StartECLSessionMsg.
|
* @param startCLmsg the startCLMsg to be populated.
|
* @param sf the provided search filter.
|
* @throws DirectoryException when an exception occurs.
|
*/
|
public static void evaluateFilter(StartECLSessionMsg startCLmsg,
|
SearchFilter sf)
|
throws DirectoryException
|
{
|
StartECLSessionMsg msg = evaluateFilter2(sf);
|
startCLmsg.setFirstDraftChangeNumber(msg.getFirstDraftChangeNumber());
|
startCLmsg.setLastDraftChangeNumber(msg.getLastDraftChangeNumber());
|
startCLmsg.setChangeNumber(msg.getChangeNumber());
|
}
|
|
private static StartECLSessionMsg evaluateFilter2(SearchFilter sf)
|
throws DirectoryException
|
{
|
StartECLSessionMsg startCLmsg = new StartECLSessionMsg();
|
startCLmsg.setFirstDraftChangeNumber(-1);
|
startCLmsg.setLastDraftChangeNumber(-1);
|
startCLmsg.setChangeNumber(new ChangeNumber(0,0,(short)0));
|
|
// Here are the 3 elementary cases we know how to optimize
|
if ((sf != null)
|
&& (sf.getFilterType() == FilterType.GREATER_OR_EQUAL)
|
&& (sf.getAttributeType() != null)
|
&& (sf.getAttributeType().getPrimaryName().
|
equalsIgnoreCase("changeNumber")))
|
{
|
int sn = Integer.decode(
|
sf.getAssertionValue().getNormalizedValue().toString());
|
startCLmsg.setFirstDraftChangeNumber(sn);
|
return startCLmsg;
|
}
|
else if ((sf != null)
|
&& (sf.getFilterType() == FilterType.LESS_OR_EQUAL)
|
&& (sf.getAttributeType() != null)
|
&& (sf.getAttributeType().getPrimaryName().
|
equalsIgnoreCase("changeNumber")))
|
{
|
int sn = Integer.decode(
|
sf.getAssertionValue().getNormalizedValue().toString());
|
startCLmsg.setLastDraftChangeNumber(sn);
|
return startCLmsg;
|
}
|
else if ((sf != null)
|
&& (sf.getFilterType() == FilterType.EQUALITY)
|
&& (sf.getAttributeType() != null)
|
&& (sf.getAttributeType().getPrimaryName().
|
equalsIgnoreCase("replicationcsn")))
|
{
|
// == exact changenumber
|
ChangeNumber cn = new ChangeNumber(sf.getAssertionValue().toString());
|
startCLmsg.setChangeNumber(cn);
|
return startCLmsg;
|
}
|
else if ((sf != null)
|
&& (sf.getFilterType() == FilterType.EQUALITY)
|
&& (sf.getAttributeType() != null)
|
&& (sf.getAttributeType().getPrimaryName().
|
equalsIgnoreCase("changenumber")))
|
{
|
int sn = Integer.decode(
|
sf.getAssertionValue().getNormalizedValue().toString());
|
startCLmsg.setFirstDraftChangeNumber(sn);
|
startCLmsg.setLastDraftChangeNumber(sn);
|
return startCLmsg;
|
}
|
else if ((sf != null)
|
&& (sf.getFilterType() == FilterType.AND))
|
{
|
// Here is the only binary operation we know how to optimize
|
Collection<SearchFilter> comps = sf.getFilterComponents();
|
SearchFilter sfs[] = comps.toArray(new SearchFilter[0]);
|
StartECLSessionMsg m1 = evaluateFilter2(sfs[0]);
|
StartECLSessionMsg m2 = evaluateFilter2(sfs[1]);
|
|
int l1 = m1.getLastDraftChangeNumber();
|
int l2 = m2.getLastDraftChangeNumber();
|
if (l1 == -1)
|
startCLmsg.setLastDraftChangeNumber(l2);
|
else
|
if (l2 == -1)
|
startCLmsg.setLastDraftChangeNumber(l1);
|
else
|
startCLmsg.setLastDraftChangeNumber(Math.min(l1,l2));
|
|
int f1 = m1.getFirstDraftChangeNumber();
|
int f2 = m2.getFirstDraftChangeNumber();
|
startCLmsg.setFirstDraftChangeNumber(Math.max(f1,f2));
|
return startCLmsg;
|
}
|
else
|
{
|
return startCLmsg;
|
}
|
}
|
}
|
