/*
|
* 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 2006-2010 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.replication.plugin;
|
import org.opends.messages.Message;
|
|
import static org.opends.server.loggers.ErrorLogger.logError;
|
import static org.opends.messages.ReplicationMessages.*;
|
|
import java.util.ArrayList;
|
import java.util.LinkedHashSet;
|
import java.util.LinkedList;
|
import java.util.List;
|
import java.util.Iterator;
|
|
import org.opends.server.core.DeleteOperationBasis;
|
import org.opends.server.core.DirectoryServer;
|
import org.opends.server.core.ModifyOperationBasis;
|
import org.opends.server.protocols.internal.InternalClientConnection;
|
import org.opends.server.protocols.internal.InternalSearchOperation;
|
import org.opends.server.protocols.ldap.LDAPAttribute;
|
import org.opends.server.protocols.ldap.LDAPFilter;
|
import org.opends.server.protocols.ldap.LDAPModification;
|
import org.opends.server.replication.common.ChangeNumber;
|
import org.opends.server.replication.common.ServerState;
|
import org.opends.server.types.Attribute;
|
import org.opends.server.types.AttributeType;
|
import org.opends.server.types.AttributeValue;
|
import org.opends.server.types.ByteString;
|
import org.opends.server.types.Control;
|
import org.opends.server.types.DN;
|
import org.opends.server.types.DereferencePolicy;
|
import org.opends.server.types.DirectoryException;
|
import org.opends.server.types.LDAPException;
|
import org.opends.server.types.ModificationType;
|
import org.opends.server.types.RawModification;
|
import org.opends.server.types.ResultCode;
|
import org.opends.server.types.SearchFilter;
|
import org.opends.server.types.SearchResultEntry;
|
import org.opends.server.types.SearchScope;
|
|
/**
|
* This class implements a ServerState that is stored on the backends
|
* used to store the synchronized data and that is therefore persistent
|
* across server reboot.
|
*/
|
public class PersistentServerState
|
{
|
private final DN baseDn;
|
private final InternalClientConnection conn =
|
InternalClientConnection.getRootConnection();
|
private final ByteString asn1BaseDn;
|
private final int serverId;
|
|
private final ServerState state;
|
|
/**
|
* The attribute name used to store the state in the backend.
|
*/
|
protected static final String REPLICATION_STATE = "ds-sync-state";
|
|
/**
|
* The attribute name used to store the entryUUID.
|
*/
|
private static final String ENTRY_UUID = "entryUUID";
|
|
/**
|
* The attribute name used to store the RUV elements.
|
*/
|
private static final String REPLICATION_RUV_ELEMENT = "nsds50ruv";
|
|
/**
|
* create a new ServerState.
|
* @param baseDn The baseDN for which the ServerState is created
|
* @param serverId The serverId
|
*/
|
public PersistentServerState(DN baseDn, int serverId)
|
{
|
this.baseDn = baseDn;
|
this.serverId = serverId;
|
this.state = new ServerState();
|
this.asn1BaseDn = ByteString.valueOf(baseDn.toString());
|
loadState();
|
}
|
|
/**
|
* Create a new PersistenServerState based on an already existing ServerState.
|
*
|
* @param baseDn The baseDN for which the ServerState is created.
|
* @param serverId The serverId.
|
* @param state The serverState.
|
*/
|
public PersistentServerState(DN baseDn, int serverId, ServerState state)
|
{
|
this.baseDn = baseDn;
|
this.serverId = serverId;
|
this.state = state;
|
this.asn1BaseDn = ByteString.valueOf(baseDn.toString());
|
loadState();
|
}
|
|
/**
|
* Checks that the ChangeNumber given as a parameter is in this ServerState.
|
*
|
* @param covered The ChangeNumber that should be checked.
|
* @return A boolean indicating if this ServerState contains the ChangeNumber
|
* given in parameter.
|
*/
|
public boolean cover(ChangeNumber covered)
|
{
|
return state.cover(covered);
|
}
|
|
/**
|
* Update the Server State with a ChangeNumber.
|
* All operations with smaller CSN and the same serverID must be committed
|
* before calling this method.
|
*
|
* @param changeNumber The committed ChangeNumber.
|
*
|
* @return a boolean indicating if the update was meaningful.
|
*/
|
public boolean update(ChangeNumber changeNumber)
|
{
|
return state.update(changeNumber);
|
}
|
|
/**
|
* Save this object to persistent storage.
|
*/
|
public void save()
|
{
|
if (state.isSaved())
|
return;
|
|
state.setSaved(true);
|
ResultCode resultCode = updateStateEntry();
|
if (resultCode != ResultCode.SUCCESS)
|
{
|
state.setSaved(false);
|
}
|
}
|
|
/**
|
* Load the ServerState from the backing entry in database to memory.
|
*/
|
public void loadState()
|
{
|
SearchResultEntry stateEntry = null;
|
|
// try to load the state from the base entry.
|
stateEntry = searchBaseEntry();
|
|
if (stateEntry == null)
|
{
|
// The base entry does not exist yet
|
// in the database or was deleted. Try to read the ServerState
|
// from the configuration instead.
|
stateEntry = searchConfigEntry();
|
}
|
|
if (stateEntry != null)
|
{
|
updateStateFromEntry(stateEntry);
|
}
|
|
/*
|
* In order to make sure that the replication never looses changes,
|
* the server needs to search all the entries that have been
|
* updated after the last write of the ServerState.
|
* Inconsistencies may append after a crash.
|
*/
|
checkAndUpdateServerState();
|
}
|
|
/**
|
* Run a search operation to find the base entry
|
* of the replication domain for which this ServerState was created.
|
*
|
* @return The base entry or null if no entry was found;
|
*/
|
private SearchResultEntry searchBaseEntry()
|
{
|
LDAPFilter filter;
|
|
try
|
{
|
filter = LDAPFilter.decode("objectclass=*");
|
} catch (LDAPException e)
|
{
|
// can not happen
|
return null;
|
}
|
|
/*
|
* Search the database entry that is used to periodically
|
* save the ServerState
|
*/
|
LinkedHashSet<String> attributes = new LinkedHashSet<String>(1);
|
attributes.add(REPLICATION_STATE);
|
InternalSearchOperation search = conn.processSearch(asn1BaseDn,
|
SearchScope.BASE_OBJECT,
|
DereferencePolicy.DEREF_ALWAYS, 0, 0, false,
|
filter,attributes);
|
if (((search.getResultCode() != ResultCode.SUCCESS)) &&
|
((search.getResultCode() != ResultCode.NO_SUCH_OBJECT)))
|
{
|
Message message = ERR_ERROR_SEARCHING_RUV.
|
get(search.getResultCode().getResultCodeName(), search.toString(),
|
search.getErrorMessage(), baseDn.toString());
|
logError(message);
|
return null;
|
}
|
|
SearchResultEntry stateEntry = null;
|
if (search.getResultCode() == ResultCode.SUCCESS)
|
{
|
/*
|
* Read the serverState from the REPLICATION_STATE attribute
|
*/
|
LinkedList<SearchResultEntry> result = search.getSearchEntries();
|
if (!result.isEmpty())
|
{
|
stateEntry = result.getFirst();
|
}
|
}
|
return stateEntry;
|
}
|
|
/**
|
* Run a search operation to find the entry with the configuration
|
* of the replication domain for which this ServerState was created.
|
*
|
* @return The configuration Entry or null if no entry was found;
|
*/
|
private SearchResultEntry searchConfigEntry()
|
{
|
try
|
{
|
SearchFilter filter =
|
SearchFilter.createFilterFromString(
|
"(&(objectclass=ds-cfg-replication-domain)"
|
+"(ds-cfg-base-dn="+baseDn+"))");
|
|
LinkedHashSet<String> attributes = new LinkedHashSet<String>(1);
|
attributes.add(REPLICATION_STATE);
|
InternalSearchOperation op =
|
conn.processSearch(DN.decode("cn=config"),
|
SearchScope.SUBORDINATE_SUBTREE,
|
DereferencePolicy.NEVER_DEREF_ALIASES,
|
1, 0, false, filter, attributes);
|
|
if (op.getResultCode() == ResultCode.SUCCESS)
|
{
|
/*
|
* Read the serverState from the REPLICATION_STATE attribute
|
*/
|
LinkedList<SearchResultEntry> resultEntries =
|
op.getSearchEntries();
|
if (!resultEntries.isEmpty())
|
{
|
SearchResultEntry resultEntry = resultEntries.getFirst();
|
return resultEntry;
|
}
|
}
|
return null;
|
} catch (DirectoryException e)
|
{
|
// can not happen
|
return null;
|
}
|
}
|
|
/**
|
* Update this ServerState from the provided entry.
|
*
|
* @param resultEntry The entry that should be used to update this
|
* ServerState.
|
*/
|
private void updateStateFromEntry(SearchResultEntry resultEntry)
|
{
|
AttributeType synchronizationStateType =
|
DirectoryServer.getAttributeType(REPLICATION_STATE);
|
List<Attribute> attrs =
|
resultEntry.getAttribute(synchronizationStateType);
|
if (attrs != null)
|
{
|
Attribute attr = attrs.get(0);
|
for (AttributeValue value : attr)
|
{
|
ChangeNumber changeNumber = new ChangeNumber(value.toString());
|
update(changeNumber);
|
}
|
}
|
}
|
|
/**
|
* Save the current values of this PersistentState object
|
* in the appropriate entry of the database.
|
*
|
* @return a ResultCode indicating if the method was successful.
|
*/
|
private ResultCode updateStateEntry()
|
{
|
/*
|
* Generate a modify operation on the Server State baseD Entry.
|
*/
|
ResultCode result = runUpdateStateEntry(baseDn);
|
|
if (result == ResultCode.NO_SUCH_OBJECT)
|
{
|
// The base entry does not exist yet in the database or
|
// has been deleted, save the state to the config entry instead.
|
SearchResultEntry configEntry = searchConfigEntry();
|
if (configEntry != null)
|
{
|
DN configDN = configEntry.getDN();
|
result = runUpdateStateEntry(configDN);
|
}
|
}
|
return result;
|
}
|
|
/**
|
* Run a modify operation to update the entry whose DN is given as
|
* a parameter with the serverState information.
|
*
|
* @param serverStateEntryDN The DN of the entry to be updated.
|
*
|
* @return A ResultCode indicating if the operation was successful.
|
*/
|
private ResultCode runUpdateStateEntry(DN serverStateEntryDN)
|
{
|
ArrayList<ByteString> values = state.toASN1ArrayList();
|
|
LDAPAttribute attr =
|
new LDAPAttribute(REPLICATION_STATE, values);
|
LDAPModification mod = new LDAPModification(ModificationType.REPLACE, attr);
|
ArrayList<RawModification> mods = new ArrayList<RawModification>(1);
|
mods.add(mod);
|
|
ModifyOperationBasis op =
|
new ModifyOperationBasis(conn, InternalClientConnection.nextOperationID(),
|
InternalClientConnection.nextMessageID(),
|
new ArrayList<Control>(0),
|
ByteString.valueOf(serverStateEntryDN.toString()),
|
mods);
|
op.setInternalOperation(true);
|
op.setSynchronizationOperation(true);
|
op.setDontSynchronize(true);
|
op.run();
|
if (op.getResultCode() != ResultCode.SUCCESS)
|
{
|
Message message = DEBUG_ERROR_UPDATING_RUV.get(
|
op.getResultCode().getResultCodeName().toString(),
|
op.toString(),
|
op.getErrorMessage().toString(),
|
baseDn.toString());
|
logError(message);
|
}
|
return op.getResultCode();
|
}
|
|
/**
|
* Empty the ServerState.
|
* After this call the Server State will be in the same state
|
* as if it was just created.
|
*/
|
public void clearInMemory()
|
{
|
state.clear();
|
state.setSaved(false);
|
}
|
|
/**
|
* Empty the ServerState.
|
* After this call the Server State will be in the same state
|
* as if it was just created.
|
*/
|
public void clear()
|
{
|
clearInMemory();
|
save();
|
}
|
|
/**
|
* The ServerState is saved to the database periodically,
|
* therefore in case of crash it is possible that is does not contain
|
* the latest changes that have been processed and saved to the
|
* database.
|
* In order to make sure that we don't loose them, search all the entries
|
* that have been updated after this entry.
|
* This is done by using the HistoricalCsnOrderingMatchingRule
|
* and an ordering index for historical attribute
|
*/
|
public final void checkAndUpdateServerState() {
|
Message message;
|
InternalSearchOperation op;
|
ChangeNumber serverStateMaxCn;
|
ChangeNumber dbMaxCn;
|
final AttributeType histType =
|
DirectoryServer.getAttributeType(EntryHistorical.HISTORICALATTRIBUTENAME);
|
|
// Retrieves the entries that have changed since the
|
// maxCn stored in the serverState
|
synchronized (this)
|
{
|
serverStateMaxCn = state.getMaxChangeNumber(serverId);
|
|
if (serverStateMaxCn == null)
|
return;
|
|
try {
|
op = LDAPReplicationDomain.searchForChangedEntries(baseDn,
|
serverStateMaxCn, null);
|
}
|
catch (Exception e)
|
{
|
return;
|
}
|
if (op.getResultCode() != ResultCode.SUCCESS)
|
{
|
// An error happened trying to search for the updates
|
// Log an error
|
message = ERR_CANNOT_RECOVER_CHANGES.get(
|
baseDn.toNormalizedString());
|
logError(message);
|
}
|
else
|
{
|
dbMaxCn = serverStateMaxCn;
|
for (SearchResultEntry resEntry : op.getSearchEntries())
|
{
|
List<Attribute> attrs = resEntry.getAttribute(histType);
|
Iterator<AttributeValue> iav = attrs.get(0).iterator();
|
try
|
{
|
while (true)
|
{
|
AttributeValue attrVal = iav.next();
|
HistoricalAttributeValue histVal =
|
new HistoricalAttributeValue(attrVal.toString());
|
ChangeNumber cn = histVal.getCn();
|
|
if ((cn != null) && (cn.getServerId() == serverId))
|
{
|
// compare the csn regarding the maxCn we know and
|
// store the biggest
|
if (ChangeNumber.compare(dbMaxCn, cn) < 0)
|
{
|
dbMaxCn = cn;
|
}
|
}
|
}
|
}
|
catch(Exception e)
|
{
|
}
|
}
|
|
if (ChangeNumber.compare(dbMaxCn, serverStateMaxCn) > 0)
|
{
|
// Update the serverState with the new maxCn
|
// present in the database
|
this.update(dbMaxCn);
|
message = NOTE_SERVER_STATE_RECOVERY.get(
|
baseDn.toNormalizedString(), dbMaxCn.toString());
|
logError(message);
|
}
|
}
|
}
|
}
|
|
/**
|
* Check if a ReplicaUpdateVector entry is present
|
* if so, translate the ruv into a serverState and
|
* a generationId.
|
* @return the generationId translated from the RUV
|
* entry, 0 if no RUV is present
|
*/
|
public Long checkRUVCompat() {
|
|
Long genId = null;
|
SearchResultEntry ruvEntry = null;
|
|
try
|
{
|
|
// Search the RUV in the DB
|
ruvEntry = searchRUVEntry();
|
|
if (ruvEntry == null)
|
return null;
|
|
// Check if the serverState is already initialized
|
|
if( !isServerStateInitilized())
|
{
|
// Translate the ruv to serverState
|
// and GenerationId
|
genId = initializeStateWithRUVEntry(ruvEntry);
|
}
|
}
|
catch (Exception e)
|
{
|
Message message = NOTE_ERR_WHILE_TRYING_TO_DECODE_RUV_IN_STATE.get(
|
baseDn.toString());
|
logError(message);
|
}
|
// In any case, remove the RUV entry
|
// if it exists
|
DeleteOperationBasis del = new DeleteOperationBasis(conn,
|
InternalClientConnection.nextOperationID(),
|
InternalClientConnection.nextMessageID(), null,
|
ByteString.valueOf(ruvEntry.getDN().toNormalizedString()));
|
|
// Run the internal operation
|
del.setInternalOperation(true);
|
del.setSynchronizationOperation(true);
|
del.setDontSynchronize(true);
|
del.run();
|
|
return genId;
|
}
|
|
/**
|
* Initialize the serverState and the GenerationId based on a RUV
|
* entry.
|
* @param ruvEntry the entry to translate into a serverState.
|
* @return the generationId translated from the RUV entry.
|
*/
|
private Long initializeStateWithRUVEntry(SearchResultEntry ruvEntry) {
|
|
Long genId = null;
|
String value = null;
|
String csn = null;
|
|
AttributeType ruvElementType =
|
DirectoryServer.getAttributeType(REPLICATION_RUV_ELEMENT);
|
|
if (ruvElementType == null)
|
return null;
|
|
for (Attribute attr : ruvEntry.getAttribute(ruvElementType))
|
{
|
Iterator<AttributeValue> it = attr.iterator();
|
while (it.hasNext())
|
{
|
value = it.next().toString();
|
// Search for the GenerationId
|
if (value.startsWith("{replicageneration} "))
|
{
|
// Get only the timestamp present in the CSN
|
String replicaGen = value.substring(20, 28);
|
genId = Long.parseLong(replicaGen,16);
|
}
|
else
|
{
|
// Translate the other elements into serverState
|
if (value.startsWith("{replica "))
|
{
|
String[] bits = value.split(" ");
|
|
// Need to take into account when a purl is empty
|
if (bits.length > 3)
|
{
|
if (bits[2].contains("ldap"))
|
{
|
// the ldap url is present so the max csn is the 5th element
|
// Example :
|
// {replica 5 ldap://host:port} 494b6635000000050000 4aeab8f300
|
// 0000050000
|
csn = bits[4];
|
}
|
else
|
{
|
// no ldap url so the max csn is the 4th element
|
// Example :
|
// {replica 31842} 4a0d1ff700017c620000 4a926b6500007c620000
|
csn = bits[3];
|
}
|
|
String temp = csn.substring(0, 8);
|
Long timeStamp = Long.parseLong(temp, 16);
|
|
temp = csn.substring(8, 12);
|
Integer seqNum = Integer.parseInt(temp, 16);
|
|
temp = csn.substring(12, 16);
|
Integer replicaId = Integer.parseInt(temp, 16);
|
|
// No need to take into account the subSeqNum
|
ChangeNumber cn =
|
new ChangeNumber(timeStamp*1000, seqNum, replicaId);
|
|
this.update(cn);
|
}
|
}
|
}
|
}
|
}
|
|
return genId;
|
}
|
|
/**
|
* Check if the server State is initialized by searching
|
* the attribute type REPLICATION_STATE in the root entry.
|
* @return true if the serverState is initialized, false
|
* otherwise
|
*/
|
private boolean isServerStateInitilized() {
|
SearchResultEntry resultEntry = searchBaseEntry();
|
|
AttributeType synchronizationStateType =
|
DirectoryServer.getAttributeType(REPLICATION_STATE);
|
List<Attribute> attrs =
|
resultEntry.getAttribute(synchronizationStateType);
|
|
return (attrs != null);
|
}
|
|
/**
|
* Search the database entry that represent a serverState
|
* using the RUV format (compatibility mode).
|
* @return the corresponding RUV entry, null otherwise
|
*/
|
private SearchResultEntry searchRUVEntry() {
|
LDAPFilter filter;
|
SearchResultEntry ruvEntry = null;
|
|
// Search the RUV entry
|
try
|
{
|
filter = LDAPFilter.decode("objectclass=ldapSubEntry");
|
} catch (LDAPException e)
|
{
|
// can not happen
|
return null;
|
}
|
|
LinkedHashSet<String> attributes = new LinkedHashSet<String>(1);
|
attributes.add(ENTRY_UUID);
|
attributes.add(REPLICATION_RUV_ELEMENT);
|
InternalSearchOperation search = conn.processSearch(asn1BaseDn,
|
SearchScope.SUBORDINATE_SUBTREE,
|
DereferencePolicy.DEREF_ALWAYS, 0, 0, false,
|
filter,attributes);
|
if (((search.getResultCode() != ResultCode.SUCCESS)) &&
|
((search.getResultCode() != ResultCode.NO_SUCH_OBJECT)))
|
return null;
|
|
if (search.getResultCode() == ResultCode.SUCCESS)
|
{
|
/*
|
* Search the ldapSubEntry with the entryUUID equals
|
* to "ffffffff-ffff-ffff-ffff-ffffffffffff"
|
*/
|
LinkedList<SearchResultEntry> result = search.getSearchEntries();
|
if (!result.isEmpty())
|
{
|
for (SearchResultEntry ldapSubEntry : result)
|
{
|
List<Attribute> attrs =
|
ldapSubEntry.getAttribute(ENTRY_UUID.toLowerCase());
|
if (attrs != null)
|
{
|
Iterator<AttributeValue> iav = attrs.get(0).iterator();
|
AttributeValue attrVal = iav.next();
|
if (attrVal.toString().
|
equalsIgnoreCase("ffffffff-ffff-ffff-ffff-ffffffffffff"))
|
{
|
ruvEntry = ldapSubEntry;
|
break;
|
}
|
}
|
}
|
}
|
}
|
return ruvEntry;
|
}
|
|
/**
|
* Get the largest ChangeNumber seen for a given LDAP server ID.
|
*
|
* @param serverID The server ID.
|
*
|
* @return The largest ChangeNumber seen.
|
*/
|
public ChangeNumber getMaxChangeNumber(int serverID)
|
{
|
return state.getMaxChangeNumber(serverID);
|
}
|
}
|
