Interface JsonRpcClientRequest

All Superinterfaces:

ClientRequest<JsonRpcClientRequest>

public interface JsonRpcClientRequest
extends ClientRequest<JsonRpcClientRequest>

A representation of JSON-RPC client request.

Nested Class Summary

Nested classes/interfaces inherited from interface ClientRequest

ClientRequest.OutputStreamHandler

Modifier and Type	Interface	Description
static interface	ClientRequest.OutputStreamHandler	Handle output stream.

Method Summary

Modifier and Type	Method	Description
default JsonRpcClientRequest	addParam(int value)	Add an array param value of type int to this request.
JsonRpcClientRequest	addParam(JsonValue value)	Add an array param value on this request.
default JsonRpcClientRequest	addParam(String value)	Add an array param value of type string to this request.
JsonRpcClientBatchRequest	addToBatch()	Add this request to the current batch.
JsonObject	asJsonObject()	Get a complete representation of this request as a JSON object.
default JsonRpcClientRequest	param(String name, int value)	Set a named param of type int on this request.
JsonRpcClientRequest	param(String name, JsonValue value)	Set a named param on this request.
default JsonRpcClientRequest	param(String name, String value)	Set a named param of type string on this request.
default JsonRpcClientRequest	rpcId(int value)	Set an int JSON-RPC ID on this request.
JsonRpcClientRequest	rpcId(JsonValue value)	Set a JSON-RPC ID on this request.
default JsonRpcClientRequest	rpcId(String value)	Set a string JSON-RPC ID on this request.
JsonRpcClientRequest	rpcMethod(String rpcMethod)	Set a JSON-RPC method on this request.
JsonRpcClientResponse	submit()	Submit this request to the server and get a response.

Methods inherited from interface ClientRequest

accept, accept, address, connection, contentType, followRedirects, followRedirects, fragment, fragment, header, header, header, headers, headers, headers, keepAlive, maxRedirects, maxRedirects, outputStream, outputStream, path, pathParam, property, proxy, queryParam, readContinueTimeout, readTimeout, request, request, request, requestEntity, requestEntity, resolvedUri, sendExpectContinue, skipUriEncoding, sni, sni, submit, submit, submit, tls, uri, uri, uri

Modifier and Type	Method	Description
default JsonRpcClientRequest	accept(MediaType... acceptedTypes)	Accepted media types.
default JsonRpcClientRequest	accept(HttpMediaType... accepted)	Accepted media types.
default JsonRpcClientRequest	address(SocketAddress socketAddress)	Socket address to use.
JsonRpcClientRequest	connection(ClientConnection connection)	This method is for explicit connection use by this request.
default JsonRpcClientRequest	contentType(MediaType contentType)	Sets the content type of the request.
boolean	followRedirects()	Whether to follow redirects.
JsonRpcClientRequest	followRedirects(boolean followRedirects)	Whether to follow redirects.
JsonRpcClientRequest	fragment(UriFragment fragment)	Set fragment of the URI.
default JsonRpcClientRequest	fragment(String fragment)	Set fragment of the URI.
JsonRpcClientRequest	header(Header header)	Set an HTTP header.
default JsonRpcClientRequest	header(HeaderName name, String... values)	Set an HTTP header.
default JsonRpcClientRequest	header(HeaderName name, List<String> values)	Set an HTTP header with multiple values.
ClientRequestHeaders	headers()	Get a (mutable) instance of outgoing headers.
JsonRpcClientRequest	headers(Headers headers)	Configure headers.
JsonRpcClientRequest	headers(Consumer<ClientRequestHeaders> headersConsumer)	Update headers.
JsonRpcClientRequest	keepAlive(boolean keepAlive)	Whether to use keep alive with this request.
int	maxRedirects()	Maximal number of redirects to follow.
JsonRpcClientRequest	maxRedirects(int maxRedirects)	Max number of the followed redirects.
HttpClientResponse	outputStream(ClientRequest.OutputStreamHandler outputStreamConsumer)	Handle output stream and submit the request.
default <T> ClientResponseTyped<T>	outputStream(ClientRequest.OutputStreamHandler outputStreamConsumer, Class<T> requestedType)	Handle output stream and request a specific type.
default JsonRpcClientRequest	path(String uri)	Configure path to call.
JsonRpcClientRequest	pathParam(String name, String value)	Replace a placeholder in URI with an actual value.
JsonRpcClientRequest	property(String propertyName, String propertyValue)	Add a property to be used by this request.
JsonRpcClientRequest	proxy(Proxy proxy)	Proxy configuration for this specific request.
JsonRpcClientRequest	queryParam(String name, String... values)	Add query parameter.
JsonRpcClientRequest	readContinueTimeout(Duration readContinueTimeout)	Read 100-Continue timeout for this request.
JsonRpcClientRequest	readTimeout(Duration readTimeout)	Read timeout for this request.
default HttpClientResponse	request()	Request without an entity.
default <E> ClientResponseTyped<E>	request(GenericType<E> type)	Request without sending an entity.
default <E> ClientResponseTyped<E>	request(Class<E> type)	Request without sending an entity.
default <E> E	requestEntity(GenericType<E> type)	Request entity without sending a request entity, asking for entity only.
default <E> E	requestEntity(Class<E> type)	Request entity without sending a request entity, asking for entity only.
UriInfo	resolvedUri()	Resolved URI that will be used to invoke this request.
JsonRpcClientRequest	sendExpectContinue(boolean sendExpectContinue)	Whether Expect 100-Continue header is sent to verify server availability before sending an entity.
JsonRpcClientRequest	skipUriEncoding(boolean skip)	Disable uri encoding.
default JsonRpcClientRequest	sni(SniConfig sni)	Configure client-side TLS SNI for this request.
default JsonRpcClientRequest	sni(Consumer<SniConfig.Builder> sni)	Configure client-side TLS SNI for this request.
HttpClientResponse	submit(Object entity)	Submit an entity.
default <E> ClientResponseTyped<E>	submit(Object entity, GenericType<E> requestedType)	Submit an entity and request a specific type.
default <E> ClientResponseTyped<E>	submit(Object entity, Class<E> requestedType)	Submit an entity and request a specific type.
JsonRpcClientRequest	tls(Tls tls)	TLS configuration for this specific request.
JsonRpcClientRequest	uri(ClientUri uri)	Configure request URI.
default JsonRpcClientRequest	uri(String uri)	Configure URI.
JsonRpcClientRequest	uri(URI uri)	Configure URI.

Method Details

rpcMethod

JsonRpcClientRequest rpcMethod(String rpcMethod)

Set a JSON-RPC method on this request. Normally this is done using either via JsonRpcClient or JsonRpcClientBatchRequest.

Parameters:

rpcMethod - the JSON-RPC method

Returns:

this request

See Also:

• JsonRpcClient.rpcMethod(String)
• JsonRpcClientBatchRequest.rpcMethod(String)

rpcId

JsonRpcClientRequest rpcId(JsonValue value)

Set a JSON-RPC ID on this request.

Parameters:

value - the ID as a JSON value

Returns:

this request

rpcId

default JsonRpcClientRequest rpcId(int value)

Set an int JSON-RPC ID on this request.

Parameters:

value - the ID as an int

Returns:

this request

rpcId

default JsonRpcClientRequest rpcId(String value)

Set a string JSON-RPC ID on this request.

Parameters:

value - the ID as a string

Returns:

this request

param

JsonRpcClientRequest param(String name,
 JsonValue value)

Set a named param on this request.

Parameters:

name - the name

value - the value as a JSON value

Returns:

this request

param

default JsonRpcClientRequest param(String name,
 String value)

Set a named param of type string on this request.

Parameters:

name - the name

value - the value as a string

Returns:

this request

param

default JsonRpcClientRequest param(String name,
 int value)

Set a named param of type int on this request.

Parameters:

name - the name

value - the value as an int

Returns:

this request

addParam

JsonRpcClientRequest addParam(JsonValue value)

Add an array param value on this request.

Parameters:

value - the value as JSON value

Returns:

this request

addParam

default JsonRpcClientRequest addParam(int value)

Add an array param value of type int to this request.

Parameters:

value - the value as int value

Returns:

this request

addParam

default JsonRpcClientRequest addParam(String value)

Add an array param value of type string to this request.

Parameters:

value - the value as a string

Returns:

this request

submit

JsonRpcClientResponse submit()

Submit this request to the server and get a response.

Returns:

a response

addToBatch

JsonRpcClientBatchRequest addToBatch()

Add this request to the current batch.

Returns:

the batch

Throws:

IllegalStateException - if not part of a batch

asJsonObject

JsonObject asJsonObject()

Get a complete representation of this request as a JSON object.

Returns:

this request as a JSON object