org.openlca.ipc.RpcResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of olca-ipc Show documentation

There is a newer version: 2.4.0

package org.openlca.ipc;

import com.google.gson.JsonElement;
import com.google.gson.JsonPrimitive;

/**
 * When a rpc call is made, the Server MUST reply with a Response, except for in
 * the case of Notifications. The Response is expressed as a single JSON Object.
 * see: ...
 */
public class RpcResponse {

	/**
	 * A String specifying the version of the JSON-RPC protocol.
	 * MUST be exactly "2.0".
	 */
	public final String jsonrpc = "2.0";

	/**
	 * This member is REQUIRED on success.
	 * This member MUST NOT exist if there was an error invoking the method.
	 * The value of this member is determined by the method invoked on the
	 * Server.
	 */
	public JsonElement result;

	/**
	 * This member is REQUIRED on error.
	 * This member MUST NOT exist if there was no error triggered during invocation.
	 * The value for this member MUST be an Object as defined in section 5.1.
	 */
	public RpcError error;

	/**
	 * This member is REQUIRED.
	 * It MUST be the same as the value of the id member in the Request Object.
	 * If there was an error in detecting the id in the Request object (e.g.
	 * Parse error/Invalid Request), it MUST be Null.
	 */
	public JsonPrimitive id;

}