ErrorMessage.java revision 336ccbd284177b59fca3636fc5fc7212b2f67061
/*
* 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
*
*
* Portions Copyright 2006-2007 Sun Microsystems, Inc.
*/
/**
* This message is part of the replication protocol.
* This message is sent by a server or a changelog server when an error
* is detected in the context of a total update.
*/
public class ErrorMessage extends RoutableMessage implements
{
private static final long serialVersionUID = 2726389860247088266L;
// Specifies the messageID built form the error that was detected
private int msgID;
// Specifies the complementary details about the error that was detected
/**
* Create a InitializeMessage.
* @param sender The server ID of the server that send this message.
* @param destination The destination server or servers of this message.
* @param msgID The error message ID.
* @param details The details of the error.
*/
{
super(sender, destination);
}
/**
* Create a InitializeMessage.
*
* @param destination changelog server id
* @param msgID error message ID
* @param details details of the error
*/
{
super((short)-2, destination);
}
/**
* Creates a new InitializeMessage by decoding the provided byte array.
* @param in A byte array containing the encoded information for the Message
* @throws DataFormatException If the in does not contain a properly
* encoded InitializeMessage.
*/
{
super();
try
{
/* first byte is the type */
throw new DataFormatException("input is not a valid InitializeMessage");
int pos = 1;
// sender
// destination
// MsgID
// Details
}
catch (UnsupportedEncodingException e)
{
throw new DataFormatException("UTF-8 is not supported by this jvm.");
}
}
/**
* Get the base DN from this InitializeMessage.
*
* @return the base DN from this InitializeMessage.
*/
public String getDetails()
{
return details;
}
/**
* Get the base DN from this InitializeMessage.
*
* @return the base DN from this InitializeMessage.
*/
public int getMsgID()
{
return msgID;
}
/**
* {@inheritDoc}
*/
public byte[] getBytes()
{
/* The InitializeMessage is stored in the form :
* <operation type><basedn><serverid>
*/
try {
byte[] resultByteArray = new byte[length];
// put the type of the operation
int pos = 1;
// sender
// destination
// MsgId
// details
return resultByteArray;
}
catch (UnsupportedEncodingException e)
{
return null;
}
}
}