HeartbeatMessage.java revision a395dd575518d9e5280fc5d5d5ef47c61b174647
/*
* 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
* 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 Sun Microsystems, Inc.
*/
/**
* This message is sent at regular intervals by the replication server
* when it is sending no other messages. It allows the directory server to
* detect a problem sooner when a synchronization server has crashed or has
* been isolated from the network.
*/
public class HeartbeatMessage extends ReplicationMessage
{
/**
* Create a new HeartbeatMessage.
*
*/
public HeartbeatMessage()
{
}
/**
* Creates a new heartbeat message from its encoded form.
*
* @param in The byte array containing the encoded form of the message.
* @throws java.util.zip.DataFormatException If the byte array does not
* contain a valid encoded form of the message.
*/
{
/* The heartbeat message is encoded in the form :
* <msg-type>
*/
/* first byte is the type */
throw new DataFormatException("Input is not a valid Heartbeat Message.");
}
/**
* {@inheritDoc}
*/
public byte[] getBytes()
{
/*
* The heartbeat message contains:
* <msg-type>
*/
int length = 1;
byte[] resultByteArray = new byte[length];
/* put the message type */
return resultByteArray;
}
}