com.github.jinahya.jsonrpc.bind.v2

Interface JsonrpcRequestMessage

All Superinterfaces:

JsonrpcMessage, JsonrpcObject

All Known Implementing Classes:

AbstractJsonrpcRequestMessage

public interface JsonrpcRequestMessage
extends JsonrpcMessage

An interface JSON-RPC 2.0 request messages.

Author:

Jin Kwon <onacit_at_gmail.com>

See Also:

Request Object (JSON-RPC 2.0)

Method Summary

Modifier and Type	Method and Description
static JsonrpcRequestMessage	fromJson(Object source) Reads an instance from specified source.
@NotBlank String	getMethod() Returns current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_METHOD property.
<T> List<T>	getParamsAsArray(Class<T> elementClass) Returns current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property as a list of specified element type.
<T> T	getParamsAsObject(Class<T> objectClass) Returns current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property as an instance of specified object type.
boolean	hasParams() Indicates this message has a value for JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property.
default @AssertFalse boolean	isMethodReservedForRpcInternal() Indicates that current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_METHOD property is considered to be reserved for rpc-internal.
default boolean	isNotification() Indicates whether this message is a notification.
@AssertTrue boolean	isParamsContextuallyValid() Indicate whether current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property is contextually valid.
static JsonrpcRequestMessage	newInstance() Creates a new instance.
void	setMethod(String method) Replaces current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_METHOD property with specified value.
void	setParamsAsArray(List<?> params) Replaces current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property with specified value.
void	setParamsAsObject(Object params) Replaces current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property with specified object.
default String	toJson() Returns a JSON representation of this message.
default void	toJson(Object target) Writes this message to specified target.

Methods inherited from interface com.github.jinahya.jsonrpc.bind.v2.JsonrpcMessage

getIdAsInteger, getIdAsLong, getIdAsNumber, getIdAsString, getJsonrpc, hasId, isIdContextuallyValid, setIdAsInteger, setIdAsLong, setIdAsNumber, setIdAsString, setJsonrpc

Methods inherited from interface com.github.jinahya.jsonrpc.bind.v2.JsonrpcObject

isContextuallyValid

Method Detail

newInstance

static JsonrpcRequestMessage newInstance()

Creates a new instance.

Returns:

a new instance.

fromJson

static JsonrpcRequestMessage fromJson(Object source)

Reads an instance from specified source.

Parameters:

source - the source from which the new instance is read.

Returns:

a new instance read from source.

toJson

default void toJson(Object target)

Writes this message to specified target.

Parameters:

target - the target to which this message is written.

toJson

default String toJson()

Returns a JSON representation of this message.

Returns:

a JSON representation of this message.

isNotification

default boolean isNotification()

Indicates whether this message is a notification.

A Notification is a Request object without an "id" member. A Request object that is a Notification signifies the Client's lack of interest in the corresponding Response object, and as such no Response object needs to be returned to the client. The Server MUST NOT reply to a Notification, including those that are within a batch request.
Notifications are not confirmable by definition, since they do not have a Response object to be returned. As such, the Client would not be aware of any errors (like e.g. "Invalid params","Internal error").

Returns:

true if this message is a notification; false otherwise.

Implementation Requirements:

Default implementation returns !hasId();

getMethod

@NotBlank
@NotBlank String getMethod()

Returns current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_METHOD property.

Returns:

current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_METHOD property.

setMethod

void setMethod(String method)

Replaces current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_METHOD property with specified value.

Parameters:

method - new value for JsonrpcRequestMessageConstants.PROPERTY_NAME_METHOD property.

isMethodReservedForRpcInternal

@AssertFalse
default @AssertFalse boolean isMethodReservedForRpcInternal()

Indicates that current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_METHOD property is considered to be reserved for rpc-internal.

Returns:

true if value of JsonrpcRequestMessageConstants.PROPERTY_NAME_METHOD property is considered to be reserved for rpc-internal; false otherwise.

hasParams

boolean hasParams()

Indicates this message has a value for JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property.

Returns:

true if this message has a value for JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property; false otherwise.

Implementation Requirements:

Then this method returns false, any getParamsAs...() method should return null.

isParamsContextuallyValid

@AssertTrue
@AssertTrue boolean isParamsContextuallyValid()

Indicate whether current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property is contextually valid.

Returns:

true if current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property is contextually valid; false otherwise.

API Note:

It's considered to be contextually valid when hasParams() returns false.

getParamsAsArray

<T> List<T> getParamsAsArray(Class<T> elementClass)

Returns current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property as a list of specified element type.

Type Parameters:

T - element type parameter

Parameters:

elementClass - the element type.

Returns:

a list of elementClass; null when hasParams() method returns false.

setParamsAsArray

void setParamsAsArray(List<?> params)

Replaces current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property with specified value.

Parameters:

params - new value for JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property.

getParamsAsObject

<T> T getParamsAsObject(Class<T> objectClass)

Returns current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property as an instance of specified object type.

Type Parameters:

T - object type parameter

Parameters:

objectClass - the object type.

Returns:

an instance of objectClass; null when hasParams() method returns false.

setParamsAsObject

void setParamsAsObject(Object params)

Replaces current value of JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property with specified object.

Parameters:

params - new value for JsonrpcRequestMessageConstants.PROPERTY_NAME_PARAMS property.