/*
|
* 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 legal-notices/CDDLv1_0.txt
|
* or http://forgerock.org/license/CDDLv1.0.html.
|
* 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 legal-notices/CDDLv1_0.txt.
|
* If applicable, add the following below this CDDL HEADER, with the
|
* fields enclosed by brackets "[]" replaced with your own identifying
|
* information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Copyright 2009 Sun Microsystems, Inc.
|
* Portions Copyright 2013-2014 ForgeRock AS.
|
*/
|
package org.opends.server.replication.protocol;
|
|
import java.io.IOException;
|
import java.io.UnsupportedEncodingException;
|
import java.util.HashMap;
|
import java.util.Iterator;
|
import java.util.Map;
|
import java.util.Map.Entry;
|
import java.util.zip.DataFormatException;
|
|
import org.forgerock.opendj.io.ASN1;
|
import org.forgerock.opendj.io.ASN1Reader;
|
import org.forgerock.opendj.io.ASN1Writer;
|
import org.opends.server.replication.common.CSN;
|
import org.opends.server.replication.common.ServerState;
|
import org.forgerock.opendj.ldap.ByteSequenceReader;
|
import org.forgerock.opendj.ldap.ByteString;
|
import org.forgerock.opendj.ldap.ByteStringBuilder;
|
|
/**
|
* This message is part of the replication protocol.
|
* RS1 sends a MonitorRequestMessage to RS2 to requests its monitoring
|
* information.
|
* When RS2 receives a MonitorRequestMessage from RS1, RS2 responds with a
|
* MonitorMsg.
|
*/
|
public class MonitorMsg extends ReplicationMsg
|
{
|
/**
|
* The destination server or servers of this message.
|
*/
|
private final int destination;
|
|
/**
|
* The serverID of the server that sends this message.
|
*/
|
private final int senderID;
|
|
|
|
/**
|
* Data structure to manage the state and the approximation of the data of the
|
* first missing change for each LDAP server connected to a Replication
|
* Server.
|
*/
|
static class ServerData
|
{
|
private ServerState state;
|
private long approxFirstMissingDate;
|
}
|
|
/**
|
* Data structure to manage the state of this replication server
|
* and the state information for the servers connected to it.
|
*/
|
static class SubTopoMonitorData
|
{
|
/** This replication server DbState. */
|
private ServerState replServerDbState;
|
/** The data related to the LDAP servers connected to this RS. */
|
private final Map<Integer, ServerData> ldapStates =
|
new HashMap<Integer, ServerData>();
|
/** The data related to the RS servers connected to this RS. */
|
private final Map<Integer, ServerData> rsStates =
|
new HashMap<Integer, ServerData>();
|
}
|
|
private SubTopoMonitorData data = new SubTopoMonitorData();
|
|
/**
|
* Creates a new MonitorMsg.
|
*
|
* @param sender The sender of this message.
|
* @param destination The destination of this message.
|
*/
|
public MonitorMsg(int sender, int destination)
|
{
|
this.senderID = sender;
|
this.destination = destination;
|
}
|
|
/**
|
* Sets the state of the replication server.
|
* @param state The state.
|
*/
|
public void setReplServerDbState(ServerState state)
|
{
|
data.replServerDbState = state;
|
}
|
|
/**
|
* Sets the information of an LDAP server.
|
* @param serverId The serverID.
|
* @param state The server state.
|
* @param approxFirstMissingDate The approximation of the date
|
* of the older missing change. null when none.
|
* @param isLDAP Specifies whether the server is a LS or a RS
|
*/
|
public void setServerState(int serverId, ServerState state,
|
long approxFirstMissingDate, boolean isLDAP)
|
{
|
ServerData sd = new ServerData();
|
sd.state = state;
|
sd.approxFirstMissingDate = approxFirstMissingDate;
|
if (isLDAP)
|
data.ldapStates.put(serverId, sd);
|
else
|
data.rsStates.put(serverId, sd);
|
}
|
|
/**
|
* Get the server state for the LDAP server with the provided serverId.
|
* @param serverId The provided serverId.
|
* @return The state.
|
*/
|
public ServerState getLDAPServerState(int serverId)
|
{
|
return data.ldapStates.get(serverId).state;
|
}
|
|
/**
|
* Get the server state for the RS server with the provided serverId.
|
* @param serverId The provided serverId.
|
* @return The state.
|
*/
|
public ServerState getRSServerState(int serverId)
|
{
|
return data.rsStates.get(serverId).state;
|
}
|
|
|
/**
|
* Get the approximation of the date of the older missing change for the
|
* LDAP Server with the provided server Id.
|
* @param serverId The provided serverId.
|
* @return The approximated state.
|
*/
|
public long getLDAPApproxFirstMissingDate(int serverId)
|
{
|
return data.ldapStates.get(serverId).approxFirstMissingDate;
|
}
|
|
/**
|
* Get the approximation of the date of the older missing change for the
|
* RS Server with the provided server Id.
|
* @param serverId The provided serverId.
|
* @return The approximated state.
|
*/
|
public long getRSApproxFirstMissingDate(int serverId)
|
{
|
return data.rsStates.get(serverId).approxFirstMissingDate;
|
}
|
|
/**
|
* Creates a new EntryMessage from its encoded form.
|
*
|
* @param in The byte array containing the encoded form of the message.
|
* @param version The version of the protocol to use to decode the msg.
|
* @throws DataFormatException If the byte array does not contain a valid
|
* encoded form of the ServerStartMessage.
|
*/
|
public MonitorMsg(byte[] in, short version) throws DataFormatException
|
{
|
ByteSequenceReader reader = ByteString.wrap(in).asReader();
|
|
if (version == ProtocolVersion.REPLICATION_PROTOCOL_V1)
|
{
|
try
|
{
|
/* first byte is the type */
|
if (in[0] != MSG_TYPE_REPL_SERVER_MONITOR)
|
throw new DataFormatException("input is not a valid " +
|
this.getClass().getCanonicalName());
|
int pos = 1;
|
|
// sender
|
int length = getNextLength(in, pos);
|
String senderIDString = new String(in, pos, length, "UTF-8");
|
this.senderID = Integer.valueOf(senderIDString);
|
pos += length +1;
|
|
// destination
|
length = getNextLength(in, pos);
|
String destinationString = new String(in, pos, length, "UTF-8");
|
this.destination = Integer.valueOf(destinationString);
|
pos += length +1;
|
|
reader.position(pos);
|
}
|
catch (UnsupportedEncodingException e)
|
{
|
throw new DataFormatException("UTF-8 is not supported by this jvm.");
|
}
|
}
|
else
|
{
|
if (reader.get() != MSG_TYPE_REPL_SERVER_MONITOR)
|
throw new DataFormatException("input is not a valid " +
|
this.getClass().getCanonicalName());
|
|
/*
|
* V4 and above uses integers for its serverIds while V2 and V3
|
* use shorts.
|
*/
|
if (version <= ProtocolVersion.REPLICATION_PROTOCOL_V3)
|
{
|
// sender
|
this.senderID = reader.getShort();
|
|
// destination
|
this.destination = reader.getShort();
|
}
|
else
|
{
|
// sender
|
this.senderID = reader.getInt();
|
|
// destination
|
this.destination = reader.getInt();
|
}
|
}
|
|
|
ASN1Reader asn1Reader = ASN1.getReader(reader);
|
try
|
{
|
asn1Reader.readStartSequence();
|
// loop on the servers
|
while(asn1Reader.hasNextElement())
|
{
|
ServerState newState = new ServerState();
|
int serverId = 0;
|
long outime = 0;
|
boolean isLDAPServer = false;
|
|
asn1Reader.readStartSequence();
|
// loop on the list of CSN of the state
|
while(asn1Reader.hasNextElement())
|
{
|
CSN csn;
|
if (version >= ProtocolVersion.REPLICATION_PROTOCOL_V7)
|
{
|
csn = CSN.valueOf(asn1Reader.readOctetString());
|
}
|
else
|
{
|
csn = CSN.valueOf(asn1Reader.readOctetStringAsString());
|
}
|
|
if (data.replServerDbState != null && serverId == 0)
|
{
|
// we are on the first CSN that is a fake CSN to store the serverId
|
// and the older update time
|
serverId = csn.getServerId();
|
outime = csn.getTime();
|
isLDAPServer = csn.getSeqnum() > 0;
|
}
|
else
|
{
|
// we are on a normal CSN
|
newState.update(csn);
|
}
|
}
|
asn1Reader.readEndSequence();
|
|
if (data.replServerDbState == null)
|
{
|
// the first state is the replication state
|
data.replServerDbState = newState;
|
}
|
else
|
{
|
// the next states are the server states
|
ServerData sd = new ServerData();
|
sd.state = newState;
|
sd.approxFirstMissingDate = outime;
|
if (isLDAPServer)
|
data.ldapStates.put(serverId, sd);
|
else
|
data.rsStates.put(serverId, sd);
|
}
|
}
|
asn1Reader.readEndSequence();
|
} catch(Exception e)
|
{ /* do nothing */
|
}
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override
|
public byte[] getBytes(short protocolVersion)
|
{
|
try
|
{
|
ByteStringBuilder byteBuilder = new ByteStringBuilder();
|
|
if (protocolVersion > ProtocolVersion.REPLICATION_PROTOCOL_V1)
|
{
|
/* put the type of the operation */
|
byteBuilder.append(MSG_TYPE_REPL_SERVER_MONITOR);
|
|
/*
|
* V4 and above uses integers for its serverIds while V2 and V3
|
* use shorts.
|
*/
|
if (protocolVersion >= ProtocolVersion.REPLICATION_PROTOCOL_V4)
|
{
|
byteBuilder.append(senderID);
|
byteBuilder.append(destination);
|
}
|
else
|
{
|
byteBuilder.append((short)senderID);
|
byteBuilder.append((short)destination);
|
}
|
}
|
|
/* Put the serverStates ... */
|
ASN1Writer writer = ASN1.getWriter(byteBuilder);
|
writer.writeStartSequence();
|
{
|
/* first put the Replication Server state */
|
writer.writeStartSequence();
|
{
|
data.replServerDbState.writeTo(writer, protocolVersion);
|
}
|
writer.writeEndSequence();
|
|
// then the LDAP server data
|
writeServerStates(protocolVersion, writer, false /* DS */);
|
|
// then the RS server datas
|
writeServerStates(protocolVersion, writer, true /* RS */);
|
}
|
writer.writeEndSequence();
|
|
if (protocolVersion > ProtocolVersion.REPLICATION_PROTOCOL_V1)
|
{
|
return byteBuilder.toByteArray();
|
}
|
else
|
{
|
byte[] temp = byteBuilder.toByteArray();
|
|
byte[] senderBytes = String.valueOf(senderID).getBytes("UTF-8");
|
byte[] destinationBytes = String.valueOf(destination).getBytes("UTF-8");
|
|
int length = 1 + 1 + senderBytes.length +
|
1 + destinationBytes.length + temp.length +1;
|
byte[] resultByteArray = new byte[length];
|
|
/* put the type of the operation */
|
resultByteArray[0] = MSG_TYPE_REPL_SERVER_MONITOR;
|
int pos = 1;
|
|
pos = addByteArray(senderBytes, resultByteArray, pos);
|
pos = addByteArray(destinationBytes, resultByteArray, pos);
|
pos = addByteArray(temp, resultByteArray, pos);
|
|
return resultByteArray;
|
}
|
}
|
catch (Exception e)
|
{
|
return null;
|
}
|
}
|
|
private void writeServerStates(short protocolVersion, ASN1Writer writer,
|
boolean writeRSStates) throws IOException
|
{
|
final Map<Integer, ServerData> servers =
|
writeRSStates ? data.rsStates : data.ldapStates;
|
final int seqNum = writeRSStates ? 0 : 1;
|
for (Map.Entry<Integer, ServerData> server : servers.entrySet())
|
{
|
writer.writeStartSequence();
|
{
|
/*
|
* A fake CSN helps storing the LDAP server ID. The sequence number will
|
* be used to differentiate between an LDAP server (1) or an RS (0).
|
*/
|
CSN csn = new CSN(
|
server.getValue().approxFirstMissingDate, seqNum,
|
server.getKey());
|
if (protocolVersion >= ProtocolVersion.REPLICATION_PROTOCOL_V7)
|
{
|
writer.writeOctetString(csn.toByteString());
|
}
|
else
|
{
|
writer.writeOctetString(csn.toString());
|
}
|
|
// the CSNs that make the state
|
server.getValue().state.writeTo(writer, protocolVersion);
|
}
|
writer.writeEndSequence();
|
}
|
}
|
|
/**
|
* Get the state of the replication server that sent this message.
|
* @return The state.
|
*/
|
public ServerState getReplServerDbState()
|
{
|
return data.replServerDbState;
|
}
|
|
/**
|
* Returns an iterator on the serverId of the connected LDAP servers.
|
* @return The iterator.
|
*/
|
public Iterator<Integer> ldapIterator()
|
{
|
return data.ldapStates.keySet().iterator();
|
}
|
|
/**
|
* Returns an iterator on the serverId of the connected RS servers.
|
* @return The iterator.
|
*/
|
public Iterator<Integer> rsIterator()
|
{
|
return data.rsStates.keySet().iterator();
|
}
|
|
|
|
/**
|
* Get the destination.
|
*
|
* @return the destination
|
*/
|
public int getDestination()
|
{
|
return destination;
|
}
|
|
|
|
/**
|
* Get the server ID of the server that sent this message.
|
*
|
* @return the server id
|
*/
|
public int getSenderID()
|
{
|
return senderID;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override
|
public String toString()
|
{
|
StringBuilder stateS = new StringBuilder("\nRState:[");
|
stateS.append(data.replServerDbState);
|
stateS.append("]");
|
|
stateS.append("\nLDAPStates:[");
|
for (Entry<Integer, ServerData> entry : data.ldapStates.entrySet())
|
{
|
ServerData sd = entry.getValue();
|
stateS.append("\n[LSstate(").append(entry.getKey()).append(")=")
|
.append(sd.state).append("]").append(" afmd=")
|
.append(sd.approxFirstMissingDate).append("]");
|
}
|
|
stateS.append("\nRSStates:[");
|
for (Entry<Integer, ServerData> entry : data.rsStates.entrySet())
|
{
|
ServerData sd = entry.getValue();
|
stateS.append("\n[RSState(").append(entry.getKey()).append(")=")
|
.append(sd.state).append("]").append(" afmd=")
|
.append(sd.approxFirstMissingDate + "]");
|
}
|
return getClass().getCanonicalName() +
|
"[ sender=" + this.senderID +
|
" destination=" + this.destination +
|
" data=[" + stateS + "]" +
|
"]";
|
}
|
}
|
