Interface JsonRpcRequest

All Superinterfaces:

HttpRequest, ServerRequest

public interface JsonRpcRequest
extends ServerRequest

A representation of a JSON-RPC request.

Method Summary

Modifier and Type	Method	Description
JsonObject	asJsonObject()	Get a complete request as a JSON object.
JsonRpcParams	params()	The params associated with the request.
Optional<JsonValue>	rpcId()	The JSON-RPC request ID, if present.
String	rpcMethod()	The JSON-RPC request method name.
String	version()	The request version.

Methods inherited from interface HttpRequest

authority, header, headers, id, localPeer, prologue, query, remotePeer, requestedUri

Modifier and Type	Method	Description
String	authority()	The content of the HeaderNames.HOST header or authority pseudo header (HTTP/2).
void	header(Header header)	Replace (or set) a request header.
ServerRequestHeaders	headers()	Headers of the request.
int	id()	Request ID on this connection.
PeerInfo	localPeer()	Peer info of the local side.
HttpPrologue	prologue()	Prologue of the request.
UriQuery	query()	Query of the request.
PeerInfo	remotePeer()	Peer info of the remote peer.
UriInfo	requestedUri()	URI as requested by the originating client (to the best of our ability to compute it).

Methods inherited from interface ServerRequest

content, context, continueSent, isSecure, listenerContext, matchingPattern, path, proxyProtocolData, reset, security, serverSocketId, sniMatchedHost, sniRequestedHost, socketId, streamFilter

Modifier and Type	Method	Description
ReadableEntity	content()	Server request entity.
Context	context()	Context of this web server request, to set and get information.
boolean	continueSent()	Whether we have already sent the Status.CONTINUE_100 when expect continue is present.
boolean	isSecure()	Whether this request was over a secure protocol (TLS).
ListenerContext	listenerContext()	Listener context.
default Optional<String>	matchingPattern()	The pattern used to match this request.
RoutedPath	path()	Path of the request.
Optional<ProxyProtocolData>	proxyProtocolData()	Access proxy protocol data for the connection on which this request was sent.
void	reset()	Reset request related state on the connection if any.
HttpSecurity	security()	HTTP security associated with this listener, configured on routing.
String	serverSocketId()	Identification of the listener socket.
default Optional<String>	sniMatchedHost()	Configured virtual-host host that matched the TLS Server Name Indication (SNI) requested host.
default Optional<String>	sniRequestedHost()	Normalized DNS host name requested by the client using TLS Server Name Indication (SNI).
String	socketId()	Identification of the client/server connection socket.
void	streamFilter(UnaryOperator<InputStream> filterFunction)	Configure a custom input stream to wrap the input stream of the request.

Method Details

version

String version()

The request version. Always "2.0".

Returns:

the request version

rpcMethod

String rpcMethod()

The JSON-RPC request method name.

Returns:

the request method

rpcId

Optional<JsonValue> rpcId()

The JSON-RPC request ID, if present.

Returns:

an optional request ID

params

JsonRpcParams params()

The params associated with the request. If omitted in the request, then internally initialized using JsonObject.empty().

Returns:

the params

asJsonObject

JsonObject asJsonObject()

Get a complete request as a JSON object.

Returns:

a JSON object that represents the request