/*
|
* 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 2006-2009 Sun Microsystems, Inc.
|
* Portions copyright 2013-2014 ForgeRock AS.
|
*/
|
package org.opends.server.replication.protocol;
|
|
import java.util.zip.DataFormatException;
|
|
import org.opends.server.replication.common.CSN;
|
|
import static org.opends.server.replication.protocol.ByteArrayBuilder.*;
|
import static org.opends.server.replication.protocol.ProtocolVersion.*;
|
|
/**
|
* Class that define messages sent by a replication domain (DS) to the
|
* replication server to let the RS know the DS current change time.
|
*/
|
public class ChangeTimeHeartbeatMsg extends ReplicationMsg
|
{
|
private static final byte NORMAL_HEARTBEAT = 0;
|
private static final byte REPLICA_OFFLINE_HEARTBEAT = 1;
|
|
/**
|
* The CSN containing the change time.
|
*/
|
private final CSN csn;
|
/**
|
* The CSN containing the change time.
|
*/
|
private final byte eventType;
|
|
private ChangeTimeHeartbeatMsg(CSN csn, byte eventType)
|
{
|
this.csn = csn;
|
this.eventType = eventType;
|
}
|
|
/**
|
* Factory method that builds a change time heartbeat message providing the
|
* change time value in a CSN.
|
*
|
* @param csn
|
* The provided CSN.
|
* @return a new ChangeTimeHeartbeatMsg
|
*/
|
public static ChangeTimeHeartbeatMsg heartbeatMsg(CSN csn)
|
{
|
return new ChangeTimeHeartbeatMsg(csn, NORMAL_HEARTBEAT);
|
}
|
|
/**
|
* Factory method that builds a change time heartbeat message for a replica
|
* going offline.
|
*
|
* @param offlineCSN
|
* the serverId and timestamp of the replica going offline
|
* @return a new ChangeTimeHeartbeatMsg
|
*/
|
public static ChangeTimeHeartbeatMsg replicaOfflineMsg(CSN offlineCSN)
|
{
|
return new ChangeTimeHeartbeatMsg(offlineCSN, REPLICA_OFFLINE_HEARTBEAT);
|
}
|
|
/**
|
* Get a CSN with the transmitted change time.
|
*
|
* @return the CSN
|
*/
|
public CSN getCSN()
|
{
|
return csn;
|
}
|
|
/**
|
* Returns whether this is a replica offline message.
|
*
|
* @return true if this is a replica offline message, false if this is a
|
* regular heartbeat message.
|
*/
|
public boolean isReplicaOfflineMsg()
|
{
|
return eventType == REPLICA_OFFLINE_HEARTBEAT;
|
}
|
|
/**
|
* Creates a message from a provided byte array.
|
*
|
* @param in
|
* The provided byte array.
|
* @param version
|
* The version of the protocol to use to decode the msg.
|
* @throws DataFormatException
|
* When an error occurs.
|
*/
|
public ChangeTimeHeartbeatMsg(byte[] in, short version)
|
throws DataFormatException
|
{
|
try
|
{
|
final ByteArrayScanner scanner = new ByteArrayScanner(in);
|
final byte msgType = scanner.nextByte();
|
if (msgType != MSG_TYPE_CT_HEARTBEAT)
|
{
|
throw new DataFormatException("input is not a valid "
|
+ getClass().getSimpleName() + " message: " + msgType);
|
}
|
|
csn = version >= REPLICATION_PROTOCOL_V7
|
? scanner.nextCSN()
|
: scanner.nextCSNUTF8();
|
eventType = version >= REPLICATION_PROTOCOL_V8
|
? scanner.nextByte()
|
: NORMAL_HEARTBEAT;
|
|
if (!scanner.isEmpty())
|
{
|
throw new DataFormatException(
|
"Did not expect to find more bytes to read for "
|
+ getClass().getSimpleName() + " message.");
|
}
|
}
|
catch (RuntimeException e)
|
{
|
// Index out of bounds, bad format, etc.
|
throw new DataFormatException("byte[] is not a valid CT_HEARTBEAT msg");
|
}
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public byte[] getBytes(short protocolVersion)
|
{
|
if (protocolVersion < ProtocolVersion.REPLICATION_PROTOCOL_V7)
|
{
|
ByteArrayBuilder builder = new ByteArrayBuilder(bytes(1) + csnsUTF8(1));
|
builder.append(MSG_TYPE_CT_HEARTBEAT);
|
builder.appendUTF8(csn);
|
return builder.toByteArray();
|
}
|
|
final ByteArrayBuilder builder = new ByteArrayBuilder(bytes(1) + csns(1));
|
builder.append(MSG_TYPE_CT_HEARTBEAT);
|
builder.append(csn);
|
if (protocolVersion >= ProtocolVersion.REPLICATION_PROTOCOL_V8)
|
{
|
builder.append(eventType);
|
}
|
return builder.toByteArray();
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public String toString()
|
{
|
return getClass().getSimpleName() + ", csn=" + csn.toStringUI();
|
}
|
|
}
|
