ErrorMsg.java revision 417c4b209ecdd73bab557aa0d9b8b7eb753c1b62
/*
* 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
* 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-2010 Sun Microsystems, Inc.
* Portions Copyright 2013-2015 ForgeRock AS.
*/
/**
* This message is part of the replication protocol.
* This message is sent by a server or a replication server when an error
* is detected in the context of a total update.
*/
public class ErrorMsg extends RoutableMsg
{
/** The tracer object for the debug logger. */
/** Specifies the messageID built from the error that was detected. */
/** Specifies the complementary details about the error that was detected. */
private final LocalizableMessage details;
/**
* The time of creation of this message.
* <p>
* protocol version previous to V4
*/
/**
* Creates an ErrorMsg providing the destination server.
*
* @param sender The server ID of the server that send this message.
* @param destination The destination server or servers of this message.
* @param details The message containing the details of the error.
*/
{
super(sender, destination);
if (logger.isTraceEnabled())
{
}
}
/**
* Creates an ErrorMsg.
*
* @param destination replication server id
* @param details details of the error
*/
{
}
/** Returns the unique message Id. */
{
}
/**
* Creates a new ErrorMsg by decoding the provided byte array.
*
* @param in A byte array containing the encoded information for the message
* @param version The protocol version to use to decode the msg.
* @throws DataFormatException If the in does not contain a properly
* encoded message.
*/
{
if (msgType != MSG_TYPE_ERROR)
{
throw new DataFormatException("input is not a valid "
+ getClass().getCanonicalName());
}
{
}
}
/**
* Get the details from this message.
*
* @return the details from this message.
*/
public LocalizableMessage getDetails()
{
return details;
}
/**
* Get the msgID from this message.
*
* @return the msgID from this message.
*/
{
return msgID;
}
// ============
// Msg encoding
// ============
/** {@inheritDoc} */
{
{
}
return builder.toByteArray();
}
/**
* Returns a string representation of the message.
*
* @return the string representation of this message.
*/
{
return "ErrorMessage=["+
" sender=" + this.senderID +
" destination=" + this.destination +
" msgID=" + this.msgID +
" details=" + this.details +
}
/**
* Get the creation time of this message.
* When several attempts of initialization are done sequentially, it helps
* sorting the good ones, from the ones that relate to ended initialization
* when they are received.
*
* @return the creation time of this message.
*/
public long getCreationTime()
{
return creationTime;
}
/**
* Get the creation time of this message.
* @param creationTime the creation time of this message.
*/
public void setCreationTime(long creationTime)
{
this.creationTime = creationTime;
}
}