Package com.linecorp.armeria.server

Interface RoutingContext

public interface RoutingContext

Holds the parameters which are required to find a service available to handle the request.

Method Summary

Modifier and Type	Method	Description
List<MediaType>	acceptTypes()	Returns a list of MediaTypes that are specified in HttpHeaderNames.ACCEPT in the order of client-side preferences.
@Nullable MediaType	contentType()	Returns MediaType specified by 'Content-Type' header of the request.
@Nullable HttpStatusException	deferredStatusException()	Returns a deferred HttpStatusException which was previously set via deferStatusException(HttpStatusException).
void	deferStatusException(HttpStatusException cause)	Defers throwing an HttpStatusException until reaching the end of the service list.
boolean	hasResult()	Returns true if a routing result is set.
RequestHeaders	headers()	Returns the RequestHeaders retrieved from the request.
String	hostname()	Returns the virtual host name of the request.
boolean	isCorsPreflight()	Deprecated. Use status() and RoutingStatus.CORS_PREFLIGHT.
HttpMethod	method()	Returns HttpMethod of the request.
default RoutingContext	overridePath(String path)	Deprecated. Use withPath(String).
QueryParams	params()	Returns the query parameters retrieved from the request path.
default String	path()	Returns the absolute path retrieved from the request, as defined in RFC3986.
default @Nullable String	query()	Returns the query retrieved from the request, as defined in RFC3986.
RequestTarget	requestTarget()	Returns the RequestTarget of the request.
default boolean	requiresMatchingHeadersPredicates()	Returns true if this context requires matching the predicates for HTTP headers.
default boolean	requiresMatchingParamsPredicates()	Returns true if this context requires matching the predicates for query parameters.
Routed<ServiceConfig>	result()	Returns the routing result of this RoutingContext.
void	setResult(Routed<ServiceConfig> result)	Sets the routing result to this RoutingContext.
RoutingStatus	status()	Returns the RoutingStatus of the request.
VirtualHost	virtualHost()	Returns the VirtualHost instance which belongs to this RoutingContext.
default RoutingContext	withMethod(HttpMethod method)	Returns a wrapped RoutingContext which holds the specified HttpMethod.
default RoutingContext	withPath(String path)	(Advanced users only) Returns a wrapped RoutingContext which holds the specified path.

Method Details

virtualHost

VirtualHost virtualHost()

Returns the VirtualHost instance which belongs to this RoutingContext.

hostname

String hostname()

Returns the virtual host name of the request.

method

HttpMethod method()

Returns HttpMethod of the request.

withMethod

@UnstableApi
default RoutingContext withMethod(HttpMethod method)

Returns a wrapped RoutingContext which holds the specified HttpMethod.

requestTarget

RequestTarget requestTarget()

Returns the RequestTarget of the request. The form of the returned RequestTarget is never RequestTargetForm.ABSOLUTE, which means it is always RequestTargetForm.ORIGIN or RequestTargetForm.ASTERISK.

path

default String path()

Returns the absolute path retrieved from the request, as defined in RFC3986.

query

@Nullable
default @Nullable String query()

Returns the query retrieved from the request, as defined in RFC3986.

params

QueryParams params()

Returns the query parameters retrieved from the request path.

contentType

@Nullable
@Nullable MediaType contentType()

Returns MediaType specified by 'Content-Type' header of the request.

acceptTypes

List<MediaType> acceptTypes()

Returns a list of MediaTypes that are specified in HttpHeaderNames.ACCEPT in the order of client-side preferences. If the client does not send the header, this will contain only MediaType.ANY_TYPE.

headers

RequestHeaders headers()

Returns the RequestHeaders retrieved from the request.

status

@UnstableApi
RoutingStatus status()

Returns the RoutingStatus of the request.

deferStatusException

void deferStatusException(HttpStatusException cause)

Defers throwing an HttpStatusException until reaching the end of the service list.

deferredStatusException

@Nullable
@Nullable HttpStatusException deferredStatusException()

Returns a deferred HttpStatusException which was previously set via deferStatusException(HttpStatusException).

withPath

default RoutingContext withPath(String path)

(Advanced users only) Returns a wrapped RoutingContext which holds the specified path. It is usually used to find an HttpService with a prefix-stripped path. Note that specifying a malformed or relative path will lead to unspecified behavior.

overridePath

@Deprecated
default RoutingContext overridePath(String path)

Deprecated.

Use withPath(String).

Returns a wrapped RoutingContext which holds the specified path. It is usually used to find an HttpService with a prefix-stripped path.

isCorsPreflight

@Deprecated
boolean isCorsPreflight()

Deprecated.

Use status() and RoutingStatus.CORS_PREFLIGHT.

Returns true if this context is for a CORS preflight request.

requiresMatchingParamsPredicates

default boolean requiresMatchingParamsPredicates()

Returns true if this context requires matching the predicates for query parameters.

See Also:

• RouteBuilder.matchesParams(Iterable)

requiresMatchingHeadersPredicates

default boolean requiresMatchingHeadersPredicates()

Returns true if this context requires matching the predicates for HTTP headers.

See Also:

• RouteBuilder.matchesHeaders(Iterable)

hasResult

@UnstableApi
boolean hasResult()

Returns true if a routing result is set.

setResult

@UnstableApi
void setResult(Routed<ServiceConfig> result)

Sets the routing result to this RoutingContext.

Note that the result is automatically set when this RoutingContext finds a matched ServiceConfig from a Router. Don't set a result manually unless you really intend it.

Throws:

IllegalStateException - if a Routed is set already.

result

@UnstableApi
Routed<ServiceConfig> result()

Returns the routing result of this RoutingContext.

Throws:

IllegalStateException - if the result has not resolved yet.