001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    
028    package org.opends.server.replication.protocol;
029    
030    import java.util.zip.DataFormatException;
031    
032    /**
033     * This message is sent at regular intervals by the replication server
034     * when it is sending no other messages.  It allows the directory server to
035     * detect a problem sooner when a synchronization server has crashed or has
036     * been isolated from the network.
037     */
038    public class HeartbeatMessage extends ReplicationMessage
039    {
040      /**
041       * Create a new HeartbeatMessage.
042       *
043       */
044      public HeartbeatMessage()
045      {
046      }
047    
048      /**
049       * Creates a new heartbeat message from its encoded form.
050       *
051       * @param in The byte array containing the encoded form of the message.
052       * @throws java.util.zip.DataFormatException If the byte array does not
053       * contain a valid encoded form of the message.
054       */
055      public HeartbeatMessage(byte[] in) throws DataFormatException
056      {
057        /* The heartbeat message is encoded in the form :
058         * <msg-type>
059         */
060    
061        /* first byte is the type */
062        if (in.length != 1 || in[0] != MSG_TYPE_HEARTBEAT)
063          throw new DataFormatException("Input is not a valid Heartbeat Message.");
064      }
065    
066      /**
067       * {@inheritDoc}
068       */
069      @Override
070      public byte[] getBytes()
071      {
072        /*
073         * The heartbeat message contains:
074         * <msg-type>
075         */
076        int length = 1;
077        byte[] resultByteArray = new byte[length];
078    
079        /* put the message type */
080        resultByteArray[0] = MSG_TYPE_HEARTBEAT;
081    
082        return resultByteArray;
083      }
084    
085    }