/*
* 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-2009 Sun Microsystems, Inc.
* Portions copyright 2013-2014 ForgeRock AS.
*/
/**
* AckMsg messages are used for acknowledging an update that has been sent
* requesting an ack: update sent in Assured Mode, either safe data or safe
* read sub mode.
* The CSN refers to the update CSN that was requested to be acknowledged.
* If some errors occurred during attempt to acknowledge the update in the path
* to final servers, errors are marked with the following fields:
* - hasTimeout:
* Some servers went in timeout when the matching update was sent.
* - hasWrongStatus:
* Some servers were in a status where we cannot ask for an ack when the
* matching update was sent.
* - hasReplayError:
* Some servers made an error replaying the sent matching update.
* - failedServers:
* The list of server ids that had errors for the sent matching update. Each
* /replay error)
*
* AckMsg messages are sent all along the reverse path of the path followed
* an update message.
*/
{
/** CSN of the update that was acked. */
/**
* Did some servers go in timeout when the matching update (corresponding to
* CSN) was sent?.
*/
private boolean hasTimeout = false;
/**
* Were some servers in wrong status when the matching update (corresponding
* to CSN) was sent?.
*/
private boolean hasWrongStatus = false;
/**
* Did some servers make an error replaying the sent matching update
* (corresponding to CSN)?.
*/
private boolean hasReplayError = false;
/**
* The list of server ids that had errors for the sent matching update
* (corresponding to CSN). Each server id of the list had one of the 3
*/
/**
* Creates a new AckMsg from a CSN (no errors).
*
* @param csn The CSN used to build the AckMsg.
*/
{
}
/**
* Creates a new AckMsg from a CSN (with specified error info).
*
* @param csn The CSN used to build the AckMsg.
* @param hasTimeout The hasTimeout info
* @param hasWrongStatus The hasWrongStatus info
* @param hasReplayError The hasReplayError info
* @param failedServers The list of failed servers
*/
{
this.hasTimeout = hasTimeout;
this.hasWrongStatus = hasWrongStatus;
this.hasReplayError = hasReplayError;
this.failedServers = failedServers;
}
/**
* Sets the timeout marker for this message.
* @param hasTimeout True if some timeout occurred
*/
{
this.hasTimeout = hasTimeout;
}
/**
* Sets the wrong status marker for this message.
* @param hasWrongStatus True if some servers were in wrong status
*/
{
this.hasWrongStatus = hasWrongStatus;
}
/**
* Sets the replay error marker for this message.
* @param hasReplayError True if some servers had errors replaying the change
*/
{
this.hasReplayError = hasReplayError;
}
/**
* Sets the list of failing servers for this message.
* @param idList The list of failing servers for this message.
*/
{
this.failedServers = idList;
}
/**
* Creates a new AckMsg by decoding the provided byte array.
*
* @param in The byte array containing the encoded form of the AckMsg.
* @throws DataFormatException If in does not contain a properly encoded
* AckMsg.
*/
{
/*
* The message is stored in the form:
* <operation type><CSN><has timeout><has degraded><has replay
* error><failed server ids>
*/
if (msgType != MSG_TYPE_ACK)
{
throw new DataFormatException("byte[] is not a valid modify msg");
}
{
}
}
/**
* Get the CSN from the message.
*
* @return the CSN
*/
{
return csn;
}
/** {@inheritDoc} */
{
/*
* The message is stored in the form:
* <operation type><CSN><has timeout><has degraded><has replay
* error><failed server ids>
*/
for (int serverId : failedServers)
{
}
return builder.toByteArray();
}
/**
* Tells if the matching update had timeout.
* @return true if the matching update had timeout
*/
public boolean hasTimeout()
{
return hasTimeout;
}
/**
* Tells if the matching update had wrong status error.
* @return true if the matching update had wrong status error
*/
public boolean hasWrongStatus()
{
return hasWrongStatus;
}
/**
* Tells if the matching update had replay error.
* @return true if the matching update had replay error
*/
public boolean hasReplayError()
{
return hasReplayError;
}
/**
* Get the list of failed servers.
* @return the list of failed servers
*/
{
return failedServers;
}
/**
* Transforms the errors information of the ack into human readable string.
* @return A human readable string for errors embedded in the message.
*/
{
"concerned server ids: " + idList;
}
}