org.openlca.ipc.RpcRequest 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.3.0

package org.openlca.ipc;

import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonPrimitive;
import org.openlca.core.services.Response;

/**
 * A rpc call is represented by sending a Request object to a Server.
 * See: http://www.jsonrpc.org/specification
 */
public class RpcRequest {

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

	/**
	 * A String containing the name of the method to be invoked. Method names
	 * that begin with the word rpc followed by a period character (U+002E or
	 * ASCII 46) are reserved for rpc-internal methods and extensions and MUST
	 * NOT be used for anything else.
	 */
	public String method;

	/**
	 * A Structured value that holds the parameter values to be used during the
	 * invocation of the method. This member MAY be omitted.
	 */
	public JsonElement params;

	/**
	 * An identifier established by the Client that MUST contain a String,
	 * Number, or NULL value if included. If it is not included it is assumed to
	 * be a notification. The value SHOULD normally not be Null [1] and Numbers
	 * SHOULD NOT contain fractional parts
	 */
	public JsonPrimitive id;

	public Response requireJsonObject() {
		return params == null || ! params.isJsonObject()
			? Response.error("the request parameter must be a Json object")
			: Response.of(params.getAsJsonObject());
	}

}