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 legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2009 Sun Microsystems, Inc. 025 * Portions copyright 2013-2015 ForgeRock AS. 026 */ 027package org.opends.server.replication.protocol; 028 029import java.util.zip.DataFormatException; 030 031/** 032 * This message is part of the replication protocol. 033 * This message is sent by a server to tell a peer the communication will be 034 * terminated. 035 */ 036public class StopMsg extends ReplicationMsg 037{ 038 /** 039 * Creates a message. 040 */ 041 public StopMsg() 042 { 043 } 044 045 /** 046 * Creates a new message by decoding the provided byte array. 047 * @param in A byte array containing the encoded information for the message, 048 * @throws DataFormatException If the in does not contain a properly, 049 * encoded message. 050 */ 051 public StopMsg(byte[] in) throws DataFormatException 052 { 053 // First byte is the type 054 if (in[0] != MSG_TYPE_STOP) 055 { 056 throw new DataFormatException("input is not a valid Stop message: " + in[0]); 057 } 058 } 059 060 /** {@inheritDoc} */ 061 @Override 062 public byte[] getBytes(short protocolVersion) 063 { 064 return new byte[] { MSG_TYPE_STOP }; 065 } 066 067 /** {@inheritDoc} */ 068 @Override 069 public String toString() 070 { 071 return getClass().getSimpleName(); 072 } 073}