getBaseDNs()
{
return baseDNs;
}
@Override
public boolean isIndexed(final AttributeType attributeType, final IndexType indexType)
{
return true;
}
/**
* {@inheritDoc}
*
* Only the base changelog entry can be retrieved by DN. Change records are streamed by
* {@link #search(SearchOperation)}, which needs the search filter and the change number range to
* position its cursors, so they cannot be looked up individually and {@code null} is returned for
* them. None of them is ever an alias, so callers dereferencing aliases get the answer they need.
*/
@Override
public Entry getEntry(final DN entryDN) throws DirectoryException
{
if (entryDN == null)
{
throw new DirectoryException(DirectoryServer.getCoreConfigManager().getServerErrorResultCode(),
ERR_BACKEND_GET_ENTRY_NULL.get(getBackendID()));
}
if (CHANGELOG_BASE_DN.equals(entryDN))
{
return buildBaseChangelogEntry();
}
return null;
}
@Override
public ConditionResult hasSubordinates(final DN entryDN) throws DirectoryException
{
if (CHANGELOG_BASE_DN.equals(entryDN))
{
final Boolean hasSubs = baseChangelogHasSubordinates();
if (hasSubs == null)
{
return ConditionResult.UNDEFINED;
}
return ConditionResult.valueOf(hasSubs);
}
return ConditionResult.FALSE;
}
private Boolean baseChangelogHasSubordinates() throws DirectoryException
{
if (baseEntryHasSubordinates == null)
{
// compute its value
try
{
final ReplicationDomainDB replicationDomainDB = getChangelogDB().getReplicationDomainDB();
CursorOptions options = new CursorOptions(GREATER_THAN_OR_EQUAL_TO_KEY, ON_MATCHING_KEY);
try (final MultiDomainDBCursor cursor =
replicationDomainDB.getCursorFrom(new MultiDomainServerState(), options, getExcludedBaseDNs()))
{
baseEntryHasSubordinates = cursor.next();
}
}
catch (ChangelogException e)
{
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM, ERR_CHANGELOG_BACKEND_ATTRIBUTE.get(
"hasSubordinates", DN_EXTERNAL_CHANGELOG_ROOT, stackTraceToSingleLineString(e)));
}
}
return baseEntryHasSubordinates;
}
@Override
public long getNumberOfEntriesInBaseDN(final DN baseDN) throws DirectoryException
{
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM, ERR_NUM_SUBORDINATES_NOT_SUPPORTED.get());
}
@Override
public long getNumberOfChildren(final DN parentDN) throws DirectoryException
{
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM, ERR_NUM_SUBORDINATES_NOT_SUPPORTED.get());
}
/**
* Notifies persistent searches of this backend that a new cookie entry was added to it.
*
* Note: This method correspond to the "persistent search" phase.
* It is executed multiple times per persistent search, multi-threaded, until the persistent search is cancelled.
*
* This method must only be called after the provided data have been persisted to disk.
*
* @param baseDN
* the baseDN of the newly added entry.
* @param updateMsg
* the update message of the newly added entry
* @throws ChangelogException
* If a problem occurs while notifying of the newly added entry.
*/
public void notifyCookieEntryAdded(DN baseDN, UpdateMsg updateMsg) throws ChangelogException
{
if (!(updateMsg instanceof LDAPUpdateMsg))
{
return;
}
try
{
for (PersistentSearch pSearch : cookieBasedPersistentSearches)
{
final SearchOperation searchOp = pSearch.getSearchOperation();
final CookieEntrySender entrySender = searchOp.getAttachment(ENTRY_SENDER_ATTACHMENT);
entrySender.persistentSearchSendEntry(baseDN, updateMsg);
}
}
catch (DirectoryException e)
{
throw new ChangelogException(e.getMessageObject(), e);
}
}
/**
* Notifies persistent searches of this backend that a new change number entry was added to it.
*
* Note: This method correspond to the "persistent search" phase.
* It is executed multiple times per persistent search, multi-threaded, until the persistent search is cancelled.
*
* This method must only be called after the provided data have been persisted to disk.
*
* @param baseDN
* the baseDN of the newly added entry.
* @param changeNumber
* the change number of the newly added entry. It will be greater
* than zero for entries added to the change number index and less
* than or equal to zero for entries added to any replica DB
* @param cookieString
* a string representing the cookie of the newly added entry.
* This is only meaningful for entries added to the change number index
* @param updateMsg
* the update message of the newly added entry
* @throws ChangelogException
* If a problem occurs while notifying of the newly added entry.
*/
public void notifyChangeNumberEntryAdded(DN baseDN, long changeNumber, String cookieString, UpdateMsg updateMsg)
throws ChangelogException
{
if (!(updateMsg instanceof LDAPUpdateMsg)
|| changeNumberBasedPersistentSearches.isEmpty())
{
return;
}
try
{
// changeNumber entry can be shared with multiple persistent searches
final Entry changeNumberEntry = createEntryFromMsg(baseDN, changeNumber, cookieString, updateMsg);
for (PersistentSearch pSearch : changeNumberBasedPersistentSearches)
{
final SearchOperation searchOp = pSearch.getSearchOperation();
final ChangeNumberEntrySender entrySender = searchOp.getAttachment(ENTRY_SENDER_ATTACHMENT);
entrySender.persistentSearchSendEntry(changeNumber, changeNumberEntry);
}
}
catch (DirectoryException e)
{
throw new ChangelogException(e.getMessageObject(), e);
}
}
private boolean isCookieBased(final SearchOperation searchOp)
{
for (Control c : searchOp.getRequestControls())
{
if (OID_ECL_COOKIE_EXCHANGE_CONTROL.equals(c.getOID()))
{
return true;
}
}
return false;
}
@Override
public void addEntry(Entry entry, AddOperation addOperation)
throws DirectoryException, CanceledOperationException
{
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM,
ERR_BACKEND_ADD_NOT_SUPPORTED.get(String.valueOf(entry.getName()), getBackendID()));
}
@Override
public void deleteEntry(DN entryDN, DeleteOperation deleteOperation)
throws DirectoryException, CanceledOperationException
{
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM,
ERR_BACKEND_DELETE_NOT_SUPPORTED.get(String.valueOf(entryDN), getBackendID()));
}
@Override
public void replaceEntry(Entry oldEntry, Entry newEntry,
ModifyOperation modifyOperation) throws DirectoryException,
CanceledOperationException
{
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM,
ERR_BACKEND_MODIFY_NOT_SUPPORTED.get(String.valueOf(newEntry.getName()), getBackendID()));
}
@Override
public void renameEntry(DN currentDN, Entry entry,
ModifyDNOperation modifyDNOperation) throws DirectoryException,
CanceledOperationException
{
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM,
ERR_BACKEND_MODIFY_DN_NOT_SUPPORTED.get(String.valueOf(currentDN), getBackendID()));
}
/**
* {@inheritDoc}
*
* Runs the "initial search" phase (as opposed to a "persistent search"
* phase). The "initial search" phase is the only search run by normal
* searches, but it is also run by persistent searches with
* changesOnly=false. Persistent searches with
* changesOnly=true never execute this code.
*
* Note: this method is executed only once per persistent search, single
* threaded.
*/
@Override
public void search(final SearchOperation searchOperation) throws DirectoryException
{
checkChangelogReadPrivilege(searchOperation);
final Set excludedBaseDNs = getExcludedBaseDNs();
final MultiDomainServerState cookie = getCookieFromControl(searchOperation, excludedBaseDNs);
final ChangeNumberRange range = optimizeSearch(searchOperation.getBaseDN(), searchOperation.getFilter());
try
{
final boolean isPersistentSearch = isPersistentSearch(searchOperation);
if (cookie != null)
{
initialSearchFromCookie(
getCookieEntrySender(SearchPhase.INITIAL, searchOperation, cookie, excludedBaseDNs, isPersistentSearch));
}
else
{
initialSearchFromChangeNumber(
getChangeNumberEntrySender(SearchPhase.INITIAL, searchOperation, range, isPersistentSearch));
}
}
catch (ChangelogException e)
{
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM, ERR_CHANGELOG_BACKEND_SEARCH.get(
searchOperation.getBaseDN(), searchOperation.getFilter(), stackTraceToSingleLineString(e)));
}
}
private MultiDomainServerState getCookieFromControl(final SearchOperation searchOperation, Set excludedBaseDNs)
throws DirectoryException
{
final ExternalChangelogRequestControl eclRequestControl =
searchOperation.getRequestControl(ExternalChangelogRequestControl.DECODER);
if (eclRequestControl != null)
{
final MultiDomainServerState cookie = eclRequestControl.getCookie();
validateProvidedCookie(cookie, excludedBaseDNs);
return cookie;
}
return null;
}
@Override
public Set getSupportedControls()
{
return supportedControls;
}
@Override
public Set getSupportedFeatures()
{
return Collections.emptySet();
}
@Override
public boolean supports(BackendOperation backendOperation)
{
return false;
}
@Override
public void exportLDIF(final LDIFExportConfig exportConfig)
throws DirectoryException
{
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM,
ERR_BACKEND_IMPORT_AND_EXPORT_NOT_SUPPORTED.get(getBackendID()));
}
@Override
public LDIFImportResult importLDIF(LDIFImportConfig importConfig, ServerContext serverContext)
throws DirectoryException
{
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM,
ERR_BACKEND_IMPORT_AND_EXPORT_NOT_SUPPORTED.get(getBackendID()));
}
@Override
public void createBackup(BackupConfig backupConfig) throws DirectoryException
{
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM,
ERR_BACKEND_BACKUP_AND_RESTORE_NOT_SUPPORTED.get(getBackendID()));
}
@Override
public void removeBackup(BackupDirectory backupDirectory, String backupID) throws DirectoryException
{
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM,
ERR_BACKEND_BACKUP_AND_RESTORE_NOT_SUPPORTED.get(getBackendID()));
}
@Override
public void restoreBackup(RestoreConfig restoreConfig) throws DirectoryException
{
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM,
ERR_BACKEND_BACKUP_AND_RESTORE_NOT_SUPPORTED.get(getBackendID()));
}
@Override
public long getEntryCount()
{
try
{
return getNumberOfEntriesInBaseDN(CHANGELOG_BASE_DN) + 1;
}
catch (DirectoryException e)
{
logger.traceException(e);
return -1;
}
}
/**
* Represent the change number range targeted by a search operation.
*
* This class should be visible for tests.
*/
static final class ChangeNumberRange
{
private long lowerBound = -1;
private long upperBound = -1;
/**
* Returns the lowest change number to retrieve (inclusive).
*
* @return the lowest change number
*/
long getLowerBound()
{
return lowerBound;
}
/**
* Returns the highest change number to retrieve (inclusive).
*
* @return the highest change number
*/
long getUpperBound()
{
return upperBound;
}
}
/**
* Returns the set of DNs to exclude from the search.
*
* @return the DNs corresponding to domains to exclude from the search.
* @throws DirectoryException
* If a DN can't be decoded.
*/
private static Set getExcludedBaseDNs() throws DirectoryException
{
return getExcludedChangelogDomains();
}
/**
* Optimize the search parameters by analyzing the DN and filter.
* It also performs validation on some search parameters
* for both cookie and change number based changelogs.
*
* @param baseDN the provided search baseDN.
* @param userFilter the provided search filter.
* @return the optimized change number range
* @throws DirectoryException when an exception occurs.
*/
ChangeNumberRange optimizeSearch(final DN baseDN, final SearchFilter userFilter) throws DirectoryException
{
SearchFilter equalityFilter = null;
switch (baseDN.size())
{
case 1:
// "cn=changelog" : use user-provided search filter.
break;
case 2:
// It is probably "changeNumber=xxx,cn=changelog", use equality filter
// But it also could be ",cn=changelog" so need to check on attribute
equalityFilter = buildSearchFilterFrom(baseDN, CHANGE_NUMBER_ATTR);
break;
default:
// "replicationCSN=xxx,,cn=changelog" : use equality filter
equalityFilter = buildSearchFilterFrom(baseDN, "replicationCSN");
break;
}
return optimizeSearchUsingFilter(equalityFilter != null ? equalityFilter : userFilter);
}
/**
* Build a search filter from given DN and attribute.
*
* @return the search filter or {@code null} if attribute is not present in
* the provided DN
*/
private SearchFilter buildSearchFilterFrom(final DN baseDN, final String attrName)
{
final RDN rdn = baseDN.rdn();
AttributeType attrType = getServerContext().getSchema().getAttributeType(attrName);
final ByteString attrValue = rdn.getAttributeValue(attrType);
if (attrValue != null)
{
return SearchFilter.createEqualityFilter(attrType, attrValue);
}
return null;
}
private ChangeNumberRange optimizeSearchUsingFilter(final SearchFilter filter) throws DirectoryException
{
final ChangeNumberRange range = new ChangeNumberRange();
if (filter == null)
{
return range;
}
if (matches(filter, FilterType.GREATER_OR_EQUAL, CHANGE_NUMBER_ATTR))
{
range.lowerBound = decodeChangeNumber(filter.getAssertionValue());
}
else if (matches(filter, FilterType.LESS_OR_EQUAL, CHANGE_NUMBER_ATTR))
{
range.upperBound = decodeChangeNumber(filter.getAssertionValue());
}
else if (matches(filter, FilterType.EQUALITY, CHANGE_NUMBER_ATTR))
{
final long number = decodeChangeNumber(filter.getAssertionValue());
range.lowerBound = number;
range.upperBound = number;
}
else if (matches(filter, FilterType.EQUALITY, "replicationcsn"))
{
// == exact CSN
// validate provided CSN is correct
new CSN(filter.getAssertionValue().toString());
}
else if (filter.getFilterType() == FilterType.AND)
{
// TODO: it looks like it could be generalized to N components, not only two
final Collection components = filter.getFilterComponents();
final SearchFilter filters[] = components.toArray(new SearchFilter[0]);
long upper1 = -1;
long lower1 = -1;
long upper2 = -1;
long lower2 = -1;
if (filters.length > 0)
{
ChangeNumberRange range1 = optimizeSearchUsingFilter(filters[0]);
upper1 = range1.upperBound;
lower1 = range1.lowerBound;
}
if (filters.length > 1)
{
ChangeNumberRange range2 = optimizeSearchUsingFilter(filters[1]);
upper2 = range2.upperBound;
lower2 = range2.lowerBound;
}
if (upper1 == -1)
{
range.upperBound = upper2;
}
else if (upper2 == -1)
{
range.upperBound = upper1;
}
else
{
range.upperBound = Math.min(upper1, upper2);
}
range.lowerBound = Math.max(lower1, lower2);
}
return range;
}
private static long decodeChangeNumber(final ByteString assertionValue)
throws DirectoryException
{
try
{
return Long.decode(assertionValue.toString());
}
catch (NumberFormatException e)
{
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
LocalizableMessage.raw("Could not convert value '%s' to long", assertionValue));
}
}
private boolean matches(SearchFilter filter, FilterType filterType, String primaryName)
{
return filter.getFilterType() == filterType
&& filter.getAttributeType() != null
&& filter.getAttributeType().getNameOrOID().equalsIgnoreCase(primaryName);
}
/** Search the changelog when a cookie control is provided. */
private void initialSearchFromCookie(final CookieEntrySender entrySender)
throws DirectoryException, ChangelogException
{
if (!sendBaseChangelogEntry(entrySender.searchOp))
{ // only return the base entry: stop here
return;
}
final ReplicationDomainDB replicationDomainDB = getChangelogDB().getReplicationDomainDB();
CursorOptions options = new CursorOptions(GREATER_THAN_OR_EQUAL_TO_KEY, AFTER_MATCHING_KEY);
try (final MultiDomainDBCursor cursor =
replicationDomainDB.getCursorFrom(entrySender.cookie, options, entrySender.excludedBaseDNs);
ECLMultiDomainDBCursor replicaUpdatesCursor = new ECLMultiDomainDBCursor(domainPredicate, cursor))
{
if (sendCookieEntriesFromCursor(entrySender, replicaUpdatesCursor))
{
entrySender.transitioningToPersistentSearchPhase();
sendCookieEntriesFromCursor(entrySender, replicaUpdatesCursor);
}
}
finally
{
entrySender.finalizeInitialSearch();
}
}
private CookieEntrySender getCookieEntrySender(SearchPhase startPhase, final SearchOperation searchOperation,
MultiDomainServerState cookie, Set excludedBaseDNs, boolean isPersistentSearch)
{
if (isPersistentSearch && SearchPhase.INITIAL.equals(startPhase))
{
return searchOperation.getAttachment(ENTRY_SENDER_ATTACHMENT);
}
return new CookieEntrySender(searchOperation, startPhase, cookie, excludedBaseDNs);
}
private boolean sendCookieEntriesFromCursor(final CookieEntrySender entrySender,
final ECLMultiDomainDBCursor replicaUpdatesCursor) throws ChangelogException, DirectoryException
{
boolean continueSearch = true;
while (continueSearch && replicaUpdatesCursor.next())
{
final UpdateMsg updateMsg = replicaUpdatesCursor.getRecord();
final DN domainBaseDN = replicaUpdatesCursor.getData();
continueSearch = entrySender.initialSearchSendEntry(updateMsg, domainBaseDN);
}
return continueSearch;
}
private boolean isPersistentSearch(SearchOperation op)
{
for (PersistentSearch pSearch : getPersistentSearches())
{
if (op == pSearch.getSearchOperation())
{
return true;
}
}
return false;
}
@Override
public void registerPersistentSearch(PersistentSearch pSearch) throws DirectoryException
{
initializePersistentSearch(pSearch);
if (isCookieBased(pSearch.getSearchOperation()))
{
cookieBasedPersistentSearches.add(pSearch);
}
else
{
changeNumberBasedPersistentSearches.add(pSearch);
}
super.registerPersistentSearch(pSearch);
}
private void initializePersistentSearch(PersistentSearch pSearch) throws DirectoryException
{
final SearchOperation searchOp = pSearch.getSearchOperation();
// Validation must be done during registration for changes only persistent searches.
// Otherwise, when there is an initial search phase,
// validation is performed by the search() method.
if (pSearch.isChangesOnly())
{
checkChangelogReadPrivilege(searchOp);
}
final ChangeNumberRange range = optimizeSearch(searchOp.getBaseDN(), searchOp.getFilter());
final SearchPhase startPhase = pSearch.isChangesOnly() ? SearchPhase.PERSISTENT : SearchPhase.INITIAL;
if (isCookieBased(searchOp))
{
final Set excludedBaseDNs = getExcludedBaseDNs();
final MultiDomainServerState cookie = getCookie(pSearch.isChangesOnly(), searchOp, excludedBaseDNs);
searchOp.setAttachment(ENTRY_SENDER_ATTACHMENT,
new CookieEntrySender(searchOp, startPhase, cookie, excludedBaseDNs));
}
else
{
searchOp.setAttachment(ENTRY_SENDER_ATTACHMENT,
new ChangeNumberEntrySender(searchOp, startPhase, range));
}
}
private MultiDomainServerState getCookie(boolean isChangesOnly, SearchOperation searchOp, Set excludedBaseDNs)
throws DirectoryException
{
if (isChangesOnly)
{
// this changesOnly persistent search will not go through #initialSearch()
// so we must initialize the cookie here
return getNewestCookie(searchOp);
}
return getCookieFromControl(searchOp, excludedBaseDNs);
}
private MultiDomainServerState getNewestCookie(SearchOperation searchOp)
{
if (!isCookieBased(searchOp))
{
return null;
}
final MultiDomainServerState cookie = new MultiDomainServerState();
for (final Iterator it =
replicationServer.getDomainIterator(); it.hasNext();)
{
final DN baseDN = it.next().getBaseDN();
final ServerState state = getChangelogDB().getReplicationDomainDB().getDomainNewestCSNs(baseDN);
cookie.update(baseDN, state);
}
return cookie;
}
/**
* Validates the cookie contained in search parameters by checking its content
* with the actual replication server state.
*
* @throws DirectoryException
* If the state is not valid
*/
private void validateProvidedCookie(final MultiDomainServerState cookie, Set excludedBaseDNs)
throws DirectoryException
{
if (cookie != null && !cookie.isEmpty())
{
replicationServer.validateCookie(cookie, excludedBaseDNs);
}
}
/** Search the changelog using change number(s). */
private void initialSearchFromChangeNumber(final ChangeNumberEntrySender entrySender)
throws ChangelogException, DirectoryException
{
if (!sendBaseChangelogEntry(entrySender.searchOp))
{ // only return the base entry: stop here
return;
}
final AtomicReference replicaUpdatesCursor = new AtomicReference<>();
try (DBCursor cnIndexDBCursor = getCNIndexDBCursor(entrySender.lowestChangeNumber))
{
final MultiDomainServerState cookie = new MultiDomainServerState();
if (sendChangeNumberEntriesFromCursors(entrySender, cnIndexDBCursor, replicaUpdatesCursor, cookie))
{
entrySender.transitioningToPersistentSearchPhase();
sendChangeNumberEntriesFromCursors(entrySender, cnIndexDBCursor, replicaUpdatesCursor, cookie);
}
}
finally
{
entrySender.finalizeInitialSearch();
StaticUtils.close(replicaUpdatesCursor.get());
}
}
private ChangeNumberEntrySender getChangeNumberEntrySender(SearchPhase startPhase,
final SearchOperation searchOperation, ChangeNumberRange range, boolean isPersistentSearch)
{
if (isPersistentSearch && SearchPhase.INITIAL.equals(startPhase))
{
return searchOperation.getAttachment(ENTRY_SENDER_ATTACHMENT);
}
return new ChangeNumberEntrySender(searchOperation, SearchPhase.INITIAL, range);
}
private boolean sendChangeNumberEntriesFromCursors(final ChangeNumberEntrySender entrySender,
DBCursor cnIndexDBCursor, AtomicReference replicaUpdatesCursor,
MultiDomainServerState cookie) throws ChangelogException, DirectoryException
{
boolean continueSearch = true;
while (continueSearch && cnIndexDBCursor.next())
{
// Handle the current cnIndex record
final ChangeNumberIndexRecord cnIndexRecord = cnIndexDBCursor.getRecord();
if (replicaUpdatesCursor.get() == null)
{
replicaUpdatesCursor.set(initializeReplicaUpdatesCursor(cnIndexRecord));
initializeCookieForChangeNumberMode(cookie, cnIndexRecord);
}
else
{
cookie.update(cnIndexRecord.getBaseDN(), cnIndexRecord.getCSN());
}
continueSearch = entrySender.changeNumberIsInRange(cnIndexRecord.getChangeNumber());
if (continueSearch)
{
final UpdateMsg updateMsg = findReplicaUpdateMessage(replicaUpdatesCursor.get(), cnIndexRecord.getCSN());
if (updateMsg != null)
{
continueSearch = entrySender.initialSearchSendEntry(cnIndexRecord, updateMsg, cookie);
replicaUpdatesCursor.get().next();
}
}
}
return continueSearch;
}
/** Initialize the provided cookie from the provided change number index record. */
private void initializeCookieForChangeNumberMode(
MultiDomainServerState cookie, final ChangeNumberIndexRecord cnIndexRecord) throws ChangelogException
{
// Initialize the multi domain cursor only from the change number index record.
// The cookie is always empty at this stage.
CursorOptions options = new CursorOptions(LESS_THAN_OR_EQUAL_TO_KEY, ON_MATCHING_KEY, cnIndexRecord.getCSN());
MultiDomainServerState unused = new MultiDomainServerState();
MultiDomainDBCursor cursor = getChangelogDB().getReplicationDomainDB().getCursorFrom(unused, options);
try (ECLMultiDomainDBCursor eclCursor = new ECLMultiDomainDBCursor(domainPredicate, cursor))
{
updateCookieToMediumConsistencyPoint(cookie, eclCursor, cnIndexRecord);
}
}
/**
* Rebuilds the changelogcookie starting at the newest change number index record.
*
* It updates the provided cookie with the changes from the provided ECL cursor,
* up to (and including) the provided change number index record.
*
* Therefore, after calling this method, the cursor is positioned
* to the change immediately following the provided change number index record.
*
* @param cookie the cookie to update
* @param cursor the cursor where to read changes from
* @param cnIndexRecord the change number index record to go right after
* @throws ChangelogException if any problem occurs
*/
public static void updateCookieToMediumConsistencyPoint(
MultiDomainServerState cookie, ECLMultiDomainDBCursor cursor, ChangeNumberIndexRecord cnIndexRecord)
throws ChangelogException
{
if (cnIndexRecord == null)
{
return;
}
while (cursor.next())
{
UpdateMsg updateMsg = cursor.getRecord();
if (updateMsg.getCSN().compareTo(cnIndexRecord.getCSN()) > 0)
{
break;
}
cookie.update(cursor.getData(), updateMsg.getCSN());
}
}
private MultiDomainDBCursor initializeReplicaUpdatesCursor(
final ChangeNumberIndexRecord cnIndexRecord) throws ChangelogException
{
final MultiDomainServerState state = new MultiDomainServerState();
state.update(cnIndexRecord.getBaseDN(), cnIndexRecord.getCSN());
// No need for ECLMultiDomainDBCursor in this case
// as updateMsg will be matched with cnIndexRecord
CursorOptions options = new CursorOptions(GREATER_THAN_OR_EQUAL_TO_KEY, ON_MATCHING_KEY);
final MultiDomainDBCursor replicaUpdatesCursor =
getChangelogDB().getReplicationDomainDB().getCursorFrom(state, options);
replicaUpdatesCursor.next();
return replicaUpdatesCursor;
}
/**
* Returns the replica update message corresponding to the provided
* cnIndexRecord.
*
* @return the update message, which may be {@code null} if the update message
* could not be found because it was purged or because corresponding
* baseDN was removed from the changelog
* @throws DirectoryException
* If inconsistency is detected between the available update
* messages and the provided cnIndexRecord
*/
private UpdateMsg findReplicaUpdateMessage(final MultiDomainDBCursor replicaUpdatesCursor, CSN csn)
throws ChangelogException, DirectoryException
{
while (true)
{
final UpdateMsg updateMsg = replicaUpdatesCursor.getRecord();
final int compareIndexWithUpdateMsg = csn.compareTo(updateMsg.getCSN());
if (compareIndexWithUpdateMsg < 0) {
// Either update message has been purged or baseDN has been removed from changelogDB,
// ignore current index record and go to the next one
return null;
}
else if (compareIndexWithUpdateMsg == 0)
{
// Found the matching update message
return updateMsg;
}
// Case compareIndexWithUpdateMsg > 0 : the update message has not bean reached yet
if (!replicaUpdatesCursor.next())
{
// Should never happen, as it means some messages have disappeared
// TODO : put the correct I18N message
throw new DirectoryException(ResultCode.OPERATIONS_ERROR,
LocalizableMessage.raw("Could not find replica update message matching index record. " +
"No more replica update messages with a csn newer than " + updateMsg.getCSN() + " exist."));
}
}
}
/** Returns a cursor on CNIndexDB for the provided first change number. */
private DBCursor getCNIndexDBCursor(
final long firstChangeNumber) throws ChangelogException
{
final ChangeNumberIndexDB cnIndexDB = getChangelogDB().getChangeNumberIndexDB();
long changeNumberToUse = firstChangeNumber;
if (changeNumberToUse <= 1)
{
final ChangeNumberIndexRecord oldestRecord = cnIndexDB.getOldestRecord();
changeNumberToUse = oldestRecord == null ? CHANGE_NUMBER_FOR_EMPTY_CURSOR : oldestRecord.getChangeNumber();
}
return cnIndexDB.getCursorFrom(changeNumberToUse);
}
/** Creates a changelog entry. */
private static Entry createEntryFromMsg(final DN baseDN, final long changeNumber, final String cookie,
final UpdateMsg msg) throws DirectoryException
{
if (msg instanceof AddMsg)
{
return createAddMsg(baseDN, changeNumber, cookie, msg);
}
else if (msg instanceof ModifyCommonMsg)
{
return createModifyMsg(baseDN, changeNumber, cookie, msg);
}
else if (msg instanceof DeleteMsg)
{
final DeleteMsg delMsg = (DeleteMsg) msg;
return createChangelogEntry(baseDN, changeNumber, cookie, delMsg, null, "delete", delMsg.getInitiatorsName());
}
throw new DirectoryException(ResultCode.OPERATIONS_ERROR,
LocalizableMessage.raw("Unexpected message type when trying to create changelog entry for dn %s : %s", baseDN,
msg.getClass()));
}
/**
* Creates an entry from an add message.
*
* Map addMsg to an LDIF string for the 'changes' attribute, and pull out
* change initiators name if available which is contained in the creatorsName
* attribute.
*/
private static Entry createAddMsg(final DN baseDN, final long changeNumber, final String cookie, final UpdateMsg msg)
throws DirectoryException
{
final AddMsg addMsg = (AddMsg) msg;
String changeInitiatorsName = null;
String ldifChanges = null;
try
{
final StringBuilder builder = new StringBuilder(256);
for (Attribute attr : addMsg.getAttributes())
{
if (!attr.isEmpty()
&& attr.getAttributeDescription().getAttributeType().equals(getCreatorsNameAttributeType()))
{
// This attribute is not multi-valued.
changeInitiatorsName = attr.iterator().next().toString();
}
for (ByteString value : attr)
{
builder.append(attr.getAttributeDescription());
appendLDIFSeparatorAndValue(builder, value);
builder.append('\n');
}
}
ldifChanges = builder.toString();
}
catch (Exception e)
{
logEncodingMessageError("add", addMsg.getDN(), e);
}
return createChangelogEntry(baseDN, changeNumber, cookie, addMsg, ldifChanges, "add", changeInitiatorsName);
}
/**
* Creates an entry from a modify message.
*
* Map the modifyMsg to an LDIF string for the 'changes' attribute, and pull
* out change initiators name if available which is contained in the
* modifiersName attribute.
*/
private static Entry createModifyMsg(final DN baseDN, final long changeNumber, final String cookie,
final UpdateMsg msg) throws DirectoryException
{
final ModifyCommonMsg modifyMsg = (ModifyCommonMsg) msg;
String changeInitiatorsName = null;
String ldifChanges = null;
try
{
final StringBuilder builder = new StringBuilder(128);
for (Modification mod : modifyMsg.getMods())
{
final Attribute attr = mod.getAttribute();
if (mod.getModificationType() == ModificationType.REPLACE
&& !attr.isEmpty()
&& attr.getAttributeDescription().getAttributeType().equals(getModifiersNameAttributeType()))
{
// This attribute is not multi-valued.
changeInitiatorsName = attr.iterator().next().toString();
}
final AttributeDescription attrDesc = attr.getAttributeDescription();
builder.append(mod.getModificationType());
builder.append(": ");
builder.append(attrDesc);
builder.append('\n');
for (ByteString value : attr)
{
builder.append(attrDesc);
appendLDIFSeparatorAndValue(builder, value);
builder.append('\n');
}
builder.append("-\n");
}
ldifChanges = builder.toString();
}
catch (Exception e)
{
logEncodingMessageError("modify", modifyMsg.getDN(), e);
}
final boolean isModifyDNMsg = modifyMsg instanceof ModifyDNMsg;
final Entry entry = createChangelogEntry(baseDN, changeNumber, cookie, modifyMsg, ldifChanges,
isModifyDNMsg ? "modrdn" : "modify", changeInitiatorsName);
if (isModifyDNMsg)
{
final ModifyDNMsg modDNMsg = (ModifyDNMsg) modifyMsg;
addAttribute(entry, "newrdn", modDNMsg.getNewRDN());
if (modDNMsg.getNewSuperior() != null)
{
addAttribute(entry, "newsuperior", modDNMsg.getNewSuperior());
}
addAttribute(entry, "deleteoldrdn", String.valueOf(modDNMsg.deleteOldRdn()));
}
return entry;
}
/**
* Log an encoding message error.
*
* @param messageType
* String identifying type of message. Should be "add" or "modify".
* @param entryDN
* DN of original entry
*/
private static void logEncodingMessageError(String messageType, DN entryDN, Exception exception)
{
logger.traceException(exception);
logger.error(LocalizableMessage.raw(
"An exception was encountered while trying to encode a replication " + messageType + " message for entry \""
+ entryDN + "\" into an External Change Log entry: " + exception.getMessage()));
}
private void checkChangelogReadPrivilege(SearchOperation searchOp) throws DirectoryException
{
if (!searchOp.getClientConnection().hasPrivilege(Privilege.CHANGELOG_READ, searchOp))
{
throw new DirectoryException(ResultCode.INSUFFICIENT_ACCESS_RIGHTS,
NOTE_SEARCH_CHANGELOG_INSUFFICIENT_PRIVILEGES.get());
}
}
/**
* Create a changelog entry from a set of provided information. This is the part of
* entry creation common to all types of msgs (ADD, DEL, MOD, MODDN).
*/
private static Entry createChangelogEntry(final DN baseDN, final long changeNumber, final String cookie,
final LDAPUpdateMsg msg, final String ldifChanges, final String changeType,
final String changeInitiatorsName) throws DirectoryException
{
final CSN csn = msg.getCSN();
String dnString;
if (changeNumber > 0)
{
// change number mode
dnString = "changeNumber=" + changeNumber + "," + DN_EXTERNAL_CHANGELOG_ROOT;
}
else
{
// Cookie mode
dnString = "replicationCSN=" + csn + "," + baseDN + "," + DN_EXTERNAL_CHANGELOG_ROOT;
}
final Map> userAttrs = new LinkedHashMap<>();
final Map> opAttrs = new LinkedHashMap<>();
// Operational standard attributes
addAttributeByType(ATTR_SUBSCHEMA_SUBENTRY_LC, DN_DEFAULT_SCHEMA_ROOT, userAttrs, opAttrs);
addAttributeByType("numSubordinates", "0", userAttrs, opAttrs);
addAttributeByType("hasSubordinates", "false", userAttrs, opAttrs);
addAttributeByType("entryDN", dnString, userAttrs, opAttrs);
// REQUIRED attributes
if (changeNumber > 0)
{
addAttributeByType("changeNumber", String.valueOf(changeNumber), userAttrs, opAttrs);
}
SimpleDateFormat dateFormat = new SimpleDateFormat(DATE_FORMAT_GMT_TIME);
dateFormat.setTimeZone(TimeZone.getTimeZone("UTC")); // ??
final String format = dateFormat.format(new Date(csn.getTime()));
addAttributeByType("changeTime", format, userAttrs, opAttrs);
addAttributeByType("changeType", changeType, userAttrs, opAttrs);
addAttributeByType("targetDN", msg.getDN().toString(), userAttrs, opAttrs);
// NON REQUESTED attributes
addAttributeByType("replicationCSN", csn.toString(), userAttrs, opAttrs);
addAttributeByType("replicaIdentifier", Integer.toString(csn.getServerId()), userAttrs, opAttrs);
if (ldifChanges != null)
{
addAttributeByType("changes", ldifChanges, userAttrs, opAttrs);
}
if (changeInitiatorsName != null)
{
addAttributeByType("changeInitiatorsName", changeInitiatorsName, userAttrs, opAttrs);
}
final String targetUUID = msg.getEntryUUID();
if (targetUUID != null)
{
addAttributeByType("targetEntryUUID", targetUUID, userAttrs, opAttrs);
}
final String cookie2 = cookie != null ? cookie : "";
addAttributeByType("changeLogCookie", cookie2, userAttrs, opAttrs);
final List includedAttributes = msg.getEclIncludes();
if (includedAttributes != null && !includedAttributes.isEmpty())
{
final StringBuilder builder = new StringBuilder(256);
for (final RawAttribute includedAttribute : includedAttributes)
{
final String name = includedAttribute.getAttributeType();
for (final ByteString value : includedAttribute.getValues())
{
builder.append(name);
appendLDIFSeparatorAndValue(builder, value);
builder.append('\n');
}
}
final String includedAttributesLDIF = builder.toString();
addAttributeByType("includedAttributes", includedAttributesLDIF, userAttrs, opAttrs);
}
return new Entry(DN.valueOf(dnString), CHANGELOG_ENTRY_OBJECT_CLASSES, userAttrs, opAttrs);
}
/**
* Sends the entry if it matches the base, scope and filter of the current search operation.
* It will also send the base changelog entry if it needs to be sent and was not sent before.
*
* @return {@code true} if search should continue, {@code false} otherwise
*/
private static boolean sendEntryIfMatches(SearchOperation searchOp, Entry entry, String cookie)
throws DirectoryException
{
if (matchBaseAndScopeAndFilter(searchOp, entry))
{
return searchOp.returnEntry(entry, getControls(cookie));
}
// maybe the next entry will match?
return true;
}
/** Indicates if the provided entry matches the filter, base and scope. */
private static boolean matchBaseAndScopeAndFilter(SearchOperation searchOp, Entry entry) throws DirectoryException
{
return entry.matchesBaseAndScope(searchOp.getBaseDN(), searchOp.getScope())
&& searchOp.getFilter().matchesEntry(entry);
}
private static List getControls(String cookie)
{
if (cookie != null)
{
final Control c = new EntryChangelogNotificationControl(true, cookie);
return Collections.singletonList(c);
}
return Collections.emptyList();
}
/**
* Create and returns the base changelog entry to the underlying search operation.
*
* "initial search" phase must return the base entry immediately.
*
* @return {@code true} if search should continue, {@code false} otherwise
*/
private boolean sendBaseChangelogEntry(SearchOperation searchOp) throws DirectoryException
{
final DN baseDN = searchOp.getBaseDN();
final SearchFilter filter = searchOp.getFilter();
final SearchScope scope = searchOp.getScope();
if (ChangelogBackend.CHANGELOG_BASE_DN.isInScopeOf(baseDN, scope))
{
final Entry entry = buildBaseChangelogEntry();
if (filter.matchesEntry(entry) && !searchOp.returnEntry(entry, null))
{
// Abandon, size limit reached.
return false;
}
}
return !baseDN.equals(ChangelogBackend.CHANGELOG_BASE_DN)
|| !scope.equals(SearchScope.BASE_OBJECT);
}
private Entry buildBaseChangelogEntry() throws DirectoryException
{
final String hasSubordinatesStr = Boolean.toString(baseChangelogHasSubordinates());
final Map> userAttrs = new LinkedHashMap<>();
final Map> operationalAttrs = new LinkedHashMap<>();
// We never return the numSubordinates attribute for the base changelog entry
// and there is a very good reason for that:
// - Either we compute it before sending the entries,
// -- then we risk returning more entries if new entries come in after we computed numSubordinates
// -- or we risk returning less entries if purge kicks in after we computed numSubordinates
// - Or we accumulate all the entries that must be returned before sending them => OutOfMemoryError
addAttributeByName(ATTR_COMMON_NAME, BACKEND_ID, userAttrs, operationalAttrs);
addAttributeByName(ATTR_SUBSCHEMA_SUBENTRY, DN_DEFAULT_SCHEMA_ROOT, userAttrs, operationalAttrs);
addAttributeByName("hasSubordinates", hasSubordinatesStr, userAttrs, operationalAttrs);
addAttributeByName("entryDN", DN_EXTERNAL_CHANGELOG_ROOT, userAttrs, operationalAttrs);
return new Entry(CHANGELOG_BASE_DN, CHANGELOG_ROOT_OBJECT_CLASSES, userAttrs, operationalAttrs);
}
private static void addAttribute(final Entry e, final String attrType, final String attrValue)
{
e.addAttribute(Attributes.create(attrType, attrValue), null);
}
private static void addAttributeByType(String attrName, String attrValue,
Map> userAttrs,
Map> operationalAttrs)
{
addAttribute(attrName, attrValue, userAttrs, operationalAttrs, true);
}
private static void addAttributeByName(String attrName, String attrValue,
Map> userAttrs,
Map> operationalAttrs)
{
addAttribute(attrName, attrValue, userAttrs, operationalAttrs, false);
}
private static void addAttribute(final String attrName, final String attrValue,
final Map> userAttrs,
final Map> operationalAttrs, final boolean addByType)
{
final Attribute a = addByType
? Attributes.create(getServerContext().getSchema().getAttributeType(attrName), attrValue)
: Attributes.create(attrName, attrValue);
final AttributeType attrType = a.getAttributeDescription().getAttributeType();
final List attrList = Collections.singletonList(a);
if (attrType.isOperational())
{
operationalAttrs.put(attrType, attrList);
}
else
{
userAttrs.put(attrType, attrList);
}
}
/** Describes the current search phase. */
private enum SearchPhase
{
/**
* "Initial search" phase. The "initial search" phase is running
* concurrently. All update notifications are ignored.
*/
INITIAL,
/**
* Transitioning from the "initial search" phase to the "persistent search"
* phase. "Initial search" phase has finished reading from the DB. It now
* verifies if any more updates have been persisted to the DB since stopping
* and send them. All update notifications are blocked.
*/
TRANSITIONING,
/**
* "Persistent search" phase. "Initial search" phase has completed. All
* update notifications are published.
*/
PERSISTENT;
}
/**
* Contains data to ensure that the same change is not sent twice to clients
* because of race conditions between the "initial search" phase and the
* "persistent search" phase.
*/
private static class SendEntryData>
{
private final AtomicReference searchPhase = new AtomicReference<>(SearchPhase.INITIAL);
private final Object transitioningLock = new Object();
private volatile K lastKeySentByInitialSearch;
private SendEntryData(SearchPhase startPhase)
{
searchPhase.set(startPhase);
}
private void finalizeInitialSearch()
{
searchPhase.set(SearchPhase.PERSISTENT);
synchronized (transitioningLock)
{ // initial search phase has completed, release all persistent searches
transitioningLock.notifyAll();
}
}
public void transitioningToPersistentSearchPhase()
{
searchPhase.set(SearchPhase.TRANSITIONING);
}
private void initialSearchSendsEntry(final K key)
{
lastKeySentByInitialSearch = key;
}
private boolean persistentSearchCanSendEntry(K key)
{
final SearchPhase stateValue = searchPhase.get();
switch (stateValue)
{
case INITIAL:
return false;
case TRANSITIONING:
synchronized (transitioningLock)
{
while (SearchPhase.TRANSITIONING.equals(searchPhase.get()))
{
// "initial search" phase is over, and is now verifying whether new
// changes have been published to the DB.
// Wait for this check to complete
try
{
transitioningLock.wait();
}
catch (InterruptedException e)
{
Thread.currentThread().interrupt();
// Shutdown must have been called. Stop sending entries.
return false;
}
}
}
return key.compareTo(lastKeySentByInitialSearch) > 0;
case PERSISTENT:
return true;
default:
throw new RuntimeException("Not implemented for " + stateValue);
}
}
}
/** Sends entries to clients for change number searches. */
private static class ChangeNumberEntrySender
{
private final SearchOperation searchOp;
private final long lowestChangeNumber;
private final long highestChangeNumber;
private final SendEntryData sendEntryData;
private ChangeNumberEntrySender(SearchOperation searchOp, SearchPhase startPhase, ChangeNumberRange range)
{
this.searchOp = searchOp;
this.sendEntryData = new SendEntryData<>(startPhase);
this.lowestChangeNumber = range.lowerBound;
this.highestChangeNumber = range.upperBound;
}
/**
* Indicates if provided change number is compatible with last change
* number.
*
* @param changeNumber
* The change number to test.
* @return {@code true} if and only if the provided change number is in the
* range of the last change number.
*/
boolean changeNumberIsInRange(long changeNumber)
{
return highestChangeNumber == -1 || changeNumber <= highestChangeNumber;
}
private void finalizeInitialSearch()
{
sendEntryData.finalizeInitialSearch();
}
private void transitioningToPersistentSearchPhase()
{
sendEntryData.transitioningToPersistentSearchPhase();
}
/**
* @return {@code true} if search should continue, {@code false} otherwise
*/
private boolean initialSearchSendEntry(ChangeNumberIndexRecord cnIndexRecord, UpdateMsg updateMsg,
MultiDomainServerState cookie) throws DirectoryException
{
final DN baseDN = cnIndexRecord.getBaseDN();
sendEntryData.initialSearchSendsEntry(cnIndexRecord.getChangeNumber());
final Entry entry = createEntryFromMsg(baseDN, cnIndexRecord.getChangeNumber(), cookie.toString(), updateMsg);
return sendEntryIfMatches(searchOp, entry, null);
}
private void persistentSearchSendEntry(long changeNumber, Entry entry) throws DirectoryException
{
if (sendEntryData.persistentSearchCanSendEntry(changeNumber))
{
sendEntryIfMatches(searchOp, entry, null);
}
}
}
/** Sends entries to clients for cookie-based searches. */
private static class CookieEntrySender {
private final SearchOperation searchOp;
private final SearchPhase startPhase;
private final Set excludedBaseDNs;
private final MultiDomainServerState cookie;
private final ConcurrentSkipListMap> replicaIdToSendEntryData =
new ConcurrentSkipListMap<>();
private CookieEntrySender(SearchOperation searchOp, SearchPhase startPhase, MultiDomainServerState cookie,
Set excludedBaseDNs)
{
this.searchOp = searchOp;
this.startPhase = startPhase;
this.cookie = cookie;
this.excludedBaseDNs = excludedBaseDNs;
}
private void finalizeInitialSearch()
{
for (SendEntryData sendEntryData : replicaIdToSendEntryData.values())
{
sendEntryData.finalizeInitialSearch();
}
}
private void transitioningToPersistentSearchPhase()
{
for (SendEntryData sendEntryData : replicaIdToSendEntryData.values())
{
sendEntryData.transitioningToPersistentSearchPhase();
}
}
private SendEntryData getSendEntryData(DN baseDN, CSN csn)
{
final ReplicaId replicaId = ReplicaId.of(baseDN, csn.getServerId());
SendEntryData data = replicaIdToSendEntryData.get(replicaId);
if (data == null)
{
final SendEntryData newData = new SendEntryData<>(startPhase);
data = replicaIdToSendEntryData.putIfAbsent(replicaId, newData);
return data == null ? newData : data;
}
return data;
}
private boolean initialSearchSendEntry(final UpdateMsg updateMsg, final DN baseDN) throws DirectoryException
{
final CSN csn = updateMsg.getCSN();
final SendEntryData sendEntryData = getSendEntryData(baseDN, csn);
sendEntryData.initialSearchSendsEntry(csn);
final String cookieString = updateCookie(baseDN, updateMsg.getCSN());
final Entry entry = createEntryFromMsg(baseDN, 0, cookieString, updateMsg);
return sendEntryIfMatches(searchOp, entry, cookieString);
}
private void persistentSearchSendEntry(DN baseDN, UpdateMsg updateMsg)
throws DirectoryException
{
final CSN csn = updateMsg.getCSN();
final SendEntryData sendEntryData = getSendEntryData(baseDN, csn);
if (sendEntryData.persistentSearchCanSendEntry(csn))
{
// multi threaded case: wait for the "initial search" phase to set the cookie
final String cookieString = updateCookie(baseDN, updateMsg.getCSN());
final Entry cookieEntry = createEntryFromMsg(baseDN, 0, cookieString, updateMsg);
// FIXME JNR use this instead of previous line:
// entry.replaceAttribute(Attributes.create("changelogcookie", cookieString));
sendEntryIfMatches(searchOp, cookieEntry, cookieString);
}
}
private String updateCookie(DN baseDN, final CSN csn)
{
synchronized (cookie)
{ // forbid concurrent updates to the cookie
cookie.update(baseDN, csn);
return cookie.toString();
}
}
}
}