Package pt.unl.fct.di.novasys.babel.protocols.storage.replies

Class ExecuteJSONReply

java.lang.Object

pt.unl.fct.di.novasys.babel.generic.ProtoIPC

pt.unl.fct.di.novasys.babel.generic.ProtoReply

pt.unl.fct.di.novasys.babel.protocols.storage.replies.common.CommonReply

pt.unl.fct.di.novasys.babel.protocols.storage.replies.common.CommonExecuteReply

pt.unl.fct.di.novasys.babel.protocols.storage.replies.ExecuteJSONReply

public class ExecuteJSONReply
extends CommonExecuteReply

A reply of an operation parsed as a JSON string. The object representing the result is passed as an argument in the construct and converted to a JSON string by the GSON package. It stores information about the result of the operation as well as the type of operation (e.g., READ, UPDATE, etc.) issued.

Nested Class Summary

Nested classes/interfaces inherited from class pt.unl.fct.di.novasys.babel.generic.ProtoIPC

pt.unl.fct.di.novasys.babel.generic.ProtoIPC.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final com.google.gson.Gson	gson
static final short	REPLY_ID

Fields inherited from class pt.unl.fct.di.novasys.babel.protocols.storage.replies.common.CommonReply

EMPTY_MSG

Constructor Summary

Constructors

Constructor	Description
ExecuteJSONReply(CommonOperationStatus status, CommonOperationType type, Object result)	Creates a execute JSON reply with the status of the operation, the type of operation issued, and an object representing the result, that is going to be converted to a JSON string.
ExecuteJSONReply(CommonOperationStatus status, CommonOperationType type, String keySpace, String collection, String objectID, Object result)	Creates a execute JSON reply with the status of the operation, the type of operation issued, and an object representing the result, that is going to be converted to a JSON string.
ExecuteJSONReply(CommonOperationStatus status, CommonOperationType type, String keySpace, String collection, String objectID, String message, Object result)	Creates a execute JSON reply with the status of the operation, the type of operation issued, and an object representing the result, that is going to be converted to a JSON string.
ExecuteJSONReply(CommonOperationStatus status, CommonOperationType type, String keySpace, String collection, String objectID, String message, Object result, String reqID)	Creates a execute JSON reply with the status of the operation, the type of operation issued, and an object representing the result, that is going to be converted to a JSON string.

Method Summary

Modifier and Type	Method	Description
String	getResult()	Gets the result of the operation as a JSON string.
Class<? extends Object>	getResultType()	Gets the class type associated with the result.

Methods inherited from class pt.unl.fct.di.novasys.babel.protocols.storage.replies.common.CommonExecuteReply

getCollection, getKeySpace, getObjectID, getOperationType

Methods inherited from class pt.unl.fct.di.novasys.babel.protocols.storage.replies.common.CommonReply

getMessage, getReqID, getStatus, hasReqID

Methods inherited from class pt.unl.fct.di.novasys.babel.generic.ProtoReply

getId

Methods inherited from class pt.unl.fct.di.novasys.babel.generic.ProtoIPC

getType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

REPLY_ID

public static final short REPLY_ID

See Also:

• Constant Field Values

gson

public static final com.google.gson.Gson gson

Constructor Details

ExecuteJSONReply

public ExecuteJSONReply(CommonOperationStatus status,
 CommonOperationType type,
 Object result)

Creates a execute JSON reply with the status of the operation, the type of operation issued, and an object representing the result, that is going to be converted to a JSON string. No information about the keySpace or collection is passed

Parameters:

status - the status of the operation.

type - the type of operation committed.

result - the result of the operation.

ExecuteJSONReply

public ExecuteJSONReply(CommonOperationStatus status,
 CommonOperationType type,
 String keySpace,
 String collection,
 String objectID,
 Object result)

Creates a execute JSON reply with the status of the operation, the type of operation issued, and an object representing the result, that is going to be converted to a JSON string.

Parameters:

status - the status of the operation.

type - the type of operation committed.

keySpace - the keySpace where the operation was executed

collection - the collection where the operation was executed

objectID - the identifier of the object

result - the result of the operation.

ExecuteJSONReply

public ExecuteJSONReply(CommonOperationStatus status,
 CommonOperationType type,
 String keySpace,
 String collection,
 String objectID,
 String message,
 Object result)

Creates a execute JSON reply with the status of the operation, the type of operation issued, and an object representing the result, that is going to be converted to a JSON string. The message should detail the status of the operation.

Parameters:

status - the status of the operation.

type - the type of operation committed.

keySpace - the keySpace where the operation was executed

collection - the collection where the operation was executed

objectID - the identifier of the object

message - a message detailing the status.

result - the result of the operation.

ExecuteJSONReply

public ExecuteJSONReply(CommonOperationStatus status,
 CommonOperationType type,
 String keySpace,
 String collection,
 String objectID,
 String message,
 Object result,
 String reqID)

Creates a execute JSON reply with the status of the operation, the type of operation issued, and an object representing the result, that is going to be converted to a JSON string. The message should detail the status of the operation. Additionally, the reply also stores the request identifier associated with the reply.

Parameters:

status - the status of the operation.

type - the type of operation committed.

keySpace - the keySpace where the operation was executed

collection - the collection where the operation was executed

objectID - the identifier of the object

message - a message detailing the status.

result - the result of the operation.

reqID - the request identifier associated with the reply.

Method Details

getResult

public String getResult()

Gets the result of the operation as a JSON string.

Returns:

the result of the operation.

getResultType

public Class<? extends Object> getResultType()

Gets the class type associated with the result. This can aid in parsing the result back to a readable object.

Returns:

the class type associated with the result.