Interface JsonRpcResponse

All Superinterfaces:

ServerResponse

public interface JsonRpcResponse
extends ServerResponse

A representation of a JSON-RPC response.

Method Summary

Modifier and Type	Method	Description
JsonObject	asJsonObject()	Get a complete response as a JSON object.
Optional<JsonRpcError>	error()	Get an error set on this response.
JsonRpcResponse	error(int code, String message)	Set a JSON-RPC error on this response with a code and a message.
JsonRpcResponse	error(int code, String message, JsonValue data)	Set a JSON-RPC error on this response with a code, a message and some associated data.
Optional<JsonValue>	result()	Get the result set on this response.
JsonRpcResponse	result(JsonValue result)	Set a result for this response as a JSON value.
JsonRpcResponse	result(Object object)	Set a result from an object that can be mapped to a JSON object by Helidon JSON binding.
Optional<JsonValue>	rpcId()	Get the JSON-RPC ID set on this response.
default JsonRpcResponse	rpcId(int rpcId)	Set a JSON-RPC ID for this response as an int.
JsonRpcResponse	rpcId(JsonValue rpcId)	Set a JSON-RPC ID for this response.
default JsonRpcResponse	rpcId(String rpcId)	Set a JSON-RPC ID for this response as a string.
void	send()	Send this response over the wire to the client.
Status	status()	Get the status set on this response.
JsonRpcResponse	status(int status)	Set an HTTP status for the underlying response.
default JsonRpcResponse	status(Status status)	Set an HTTP status for the underlying response.

Methods inherited from interface ServerResponse

automaticContentEncoding, beforeSend, beforeTrailers, bytesWritten, contentEncoder, contentLength, header, header, header, headers, isResponseHandled, isSent, next, outputStream, reroute, reroute, send, send, send, send, sink, streamFilter, streamResult, trailers, whenSent

Modifier and Type	Method	Description
default ServerResponse	automaticContentEncoding(boolean enabled)	Configure whether the WebServer response layer may automatically encode the response entity using the listener content encoding context.
default ServerResponse	beforeSend(Runnable listener)	Executed right before the first byte is written to the socket (including response status and headers).
default ServerResponse	beforeTrailers(Consumer<ServerResponseTrailers> beforeTrailers)	Callback to update any last minute trailers before they are written to the output stream.
long	bytesWritten()	Number of bytes written to response.
default ServerResponse	contentEncoder(ContentEncoder encoder)	Configure an explicit response content encoder.
default void	contentLength(long length)	Configure a content length header for this response.
ServerResponse	header(Header header)	Set header with a value.
default ServerResponse	header(HeaderName name, String... values)	Set a header.
default ServerResponse	header(String name, String... values)	Not optimized method for setting a header.
ServerResponseHeaders	headers()	Response headers (mutable).
default boolean	isResponseHandled()	Whether this response has already been handled by the application.
boolean	isSent()	Whether this response has been sent.
ServerResponse	next()	Continue processing with the next route (and if none found, return a Status.NOT_FOUND_404).
OutputStream	outputStream()	Alternative way to send an entity, using an output stream.
ServerResponse	reroute(String newPath)	Re-route using a different path.
ServerResponse	reroute(String path, UriQuery query)	Re-route using a different path and query.
void	send(byte[] bytes)	Send a byte array response.
default void	send(byte[] bytes, int position, int length)	Send a byte array response.
void	send(Object entity)	Send an entity, a MediaContext will be used to serialize the entity.
default void	send(Optional<?> entity)	Send an entity if present, throw NotFoundException if empty.
default <T extends Sink<?>> T	sink(GenericType<T> sinkType)	Returns a sink from this response based on the sink type.
void	streamFilter(UnaryOperator<OutputStream> filterFunction)	Configure a custom output stream to wrap the output stream of the response.
void	streamResult(String result)	Description of the result of output stream processing.
ServerResponseTrailers	trailers()	Response trailers (mutable).
ServerResponse	whenSent(Runnable listener)	Completed when last byte is buffered for socket write.

Method Details

rpcId

JsonRpcResponse rpcId(JsonValue rpcId)

Set a JSON-RPC ID for this response.

Parameters:

rpcId - the ID

Returns:

this response

rpcId

default JsonRpcResponse rpcId(int rpcId)

Set a JSON-RPC ID for this response as an int.

Parameters:

rpcId - the ID

Returns:

this response

rpcId

default JsonRpcResponse rpcId(String rpcId)

Set a JSON-RPC ID for this response as a string.

Parameters:

rpcId - the ID

Returns:

this response

result

JsonRpcResponse result(JsonValue result)

Set a result for this response as a JSON value.

Parameters:

result - the result

Returns:

this response

See Also:

• error()

result

JsonRpcResponse result(Object object)

Set a result from an object that can be mapped to a JSON object by Helidon JSON binding.

Custom Java types passed to this method should be annotated with io.helidon.json.binding.Json.Entity.

Parameters:

object - the object

Returns:

this response

Throws:

JsonBindingException - if an error occurs during mapping

See Also:

• error()

error

JsonRpcResponse error(int code,
 String message)

Set a JSON-RPC error on this response with a code and a message.

Parameters:

code - the error code

message - the error message

Returns:

this response

See Also:

• result()

error

JsonRpcResponse error(int code,
 String message,
 JsonValue data)

Set a JSON-RPC error on this response with a code, a message and some associated data.

Parameters:

code - the error code

message - the error message

data - the data

Returns:

this response

See Also:

• result()

status

JsonRpcResponse status(int status)

Set an HTTP status for the underlying response. Normally this will be set by Helidon, but this method allows to override the default values. The default value is Status.OK_200_CODE.

Specified by:

status in interface ServerResponse

Parameters:

status - the status

Returns:

this response

status

default JsonRpcResponse status(Status status)

Set an HTTP status for the underlying response. Normally this will be set by Helidon, but this method allows to override the default values. The default value is Status.OK_200.

Specified by:

status in interface ServerResponse

Parameters:

status - the status

Returns:

this response

rpcId

Optional<JsonValue> rpcId()

Get the JSON-RPC ID set on this response.

Returns:

the ID

result

Optional<JsonValue> result()

Get the result set on this response.

Returns:

the result as a JSON value

error

Optional<JsonRpcError> error()

Get an error set on this response.

Returns:

the error

status

Status status()

Get the status set on this response.

Specified by:

status in interface ServerResponse

Returns:

the status

send

void send()

Send this response over the wire to the client. This method blocks until the response is delivered.

Specified by:

send in interface ServerResponse

asJsonObject

JsonObject asJsonObject()

Get a complete response as a JSON object.

Returns:

a JSON object that represents the response