Interface RoutingRequest

All Superinterfaces:

HttpRequest, ServerRequest

public interface RoutingRequest
extends ServerRequest

Routing request.

Method Summary

Modifier and Type	Method	Description
default RoutingRequest	matchingPattern(String matchingPattern)	Update the pattern used to match this request.
default RoutingRequest	matchingPattern(Supplier<Optional<String>> matchingPattern)	Update the pattern used to match this request using a supplier.
RoutingRequest	path(RoutedPath routedPath)	Update path of this request.
RoutingRequest	prologue(HttpPrologue newPrologue)	Update prologue of this request.

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

path

RoutingRequest path(RoutedPath routedPath)

Update path of this request. For internal use only to Helidon.

Parameters:

routedPath - routed path, that provides matched path parameters from path pattern

Returns:

this instance

prologue

RoutingRequest prologue(HttpPrologue newPrologue)

Update prologue of this request. For internal use only to Helidon.

Parameters:

newPrologue - new prologue to use (on rerouting)

Returns:

this instance

matchingPattern

default RoutingRequest matchingPattern(String matchingPattern)

Update the pattern used to match this request. Such as "/foo/{bar}". For internal use only to Helidon.

Parameters:

matchingPattern - the matching pattern, or null to clear it

Returns:

this instance

matchingPattern

default RoutingRequest matchingPattern(Supplier<Optional<String>> matchingPattern)

Update the pattern used to match this request using a supplier. The supplier is invoked at most once, when the matching pattern is first requested. For internal use only to Helidon.

Parameters:

matchingPattern - matching pattern supplier, returning an empty optional if no pattern is available

Returns:

this instance