Package com.linecorp.armeria.server

Interface Route

public interface Route

Route maps from an incoming HTTP request to an HttpService based on its path, method, content type and accepted types.

Method Summary

Modifier and Type	Method	Description
default RoutingResult	apply(RoutingContext routingCtx)	Deprecated. Use apply(RoutingContext, boolean).
RoutingResult	apply(RoutingContext routingCtx, boolean isRouteDecorator)	Matches the specified RoutingContext and extracts the path parameters from it if exists.
static RouteBuilder	builder()	Returns a new builder.
int	complexity()	Returns the complexity of this Route.
Set<MediaType>	consumes()	Returns the Set of MediaTypes that this Route consumes.
List<Route>	excludedRoutes()	Returns the Routes that are supposed to be excluded from this Route.
boolean	isFallback()	Returns whether this Route is a fallback, which is matched only when no configured Route was matched.
Set<HttpMethod>	methods()	Returns the Set of non-empty HttpMethods that this Route supports.
static Route	ofCatchAll()	Returns the catch-all Route which matches every request.
Set<String>	paramNames()	Returns the names of the path parameters extracted by this mapping.
List<String>	paths()	Returns the list of paths that this Route has.
RoutePathType	pathType()	Returns the type of the path which was specified when this is created.
String	patternString()	Returns the path pattern of this Route.
Set<MediaType>	produces()	Returns the Set of MediaTypes that this Route produces.
RouteBuilder	toBuilder()	Returns a new RouteBuilder with the values of this Route instance.
Route	withPrefix(String prefix)	Returns a newly-created Route which adds the specified prefix to this Route.

Method Details

ofCatchAll

static Route ofCatchAll()

Returns the catch-all Route which matches every request.

builder

static RouteBuilder builder()

Returns a new builder.

apply

@Deprecated
default RoutingResult apply(RoutingContext routingCtx)

Deprecated.

Use apply(RoutingContext, boolean).

Matches the specified RoutingContext and extracts the path parameters from it if exists.

Parameters:

routingCtx - a context to find the HttpService

Returns:

a non-empty RoutingResult if the path, method, contentType and acceptTypes and HTTP headers and query parameters matches the equivalent conditions in Route. RoutingResult.empty() otherwise.

See Also:

• RouteBuilder.methods(Iterable)
• RouteBuilder.consumes(Iterable)
• RouteBuilder.produces(Iterable)
• RouteBuilder.matchesHeaders(Iterable)
• RouteBuilder.matchesParams(Iterable)

apply

RoutingResult apply(RoutingContext routingCtx,
 boolean isRouteDecorator)

Matches the specified RoutingContext and extracts the path parameters from it if exists.

Parameters:

routingCtx - a context to find the HttpService

isRouteDecorator - true if this method is called for route decorators. false if this method is called for services. If true, an HttpStatusException will not be deferred and preflight request will not be handled by this Route.

Returns:

a non-empty RoutingResult if the path, method, contentType and acceptTypes and HTTP headers and query parameters matches the equivalent conditions in Route. RoutingResult.empty() otherwise.

See Also:

• RouteBuilder.methods(Iterable)
• RouteBuilder.consumes(Iterable)
• RouteBuilder.produces(Iterable)
• RouteBuilder.matchesHeaders(Iterable)
• RouteBuilder.matchesParams(Iterable)

paramNames

Set<String> paramNames()

Returns the names of the path parameters extracted by this mapping.

patternString

String patternString()

Returns the path pattern of this Route. The returned path pattern is different according to the value of pathType().

• EXACT: "/foo" or "/foo/bar"
• PREFIX: "/foo/*"
• PARAMETERIZED: "/foo/:bar" or "/foo/:bar/:qux
• REGEX may have a glob pattern or a regular expression:
  • "/**/foo" if the Route was created using RouteBuilder.glob(String)
  • "^/(?(.+)/)?foo$" if the Route was created using RouteBuilder.regex(String)
• REGEX_WITH_PREFIX may have a glob pattern or a regular expression with a prefix:
  • "/foo/bar/**" if the Route was created using RouteBuilder.path("/foo/", "glob:/bar/**")
  • "/foo/(bar|baz)" if the Route was created using RouteBuilder.path("/foo/", "regex:/(bar|baz)")

pathType

RoutePathType pathType()

Returns the type of the path which was specified when this is created.

paths

List<String> paths()

Returns the list of paths that this Route has. The paths are different according to the value of pathType(). If the path type has a trie path, this method will return a two-element list whose first element is the path that represents the type and the second element is the trie path. RoutePathType.EXACT, RoutePathType.PREFIX and RoutePathType.PARAMETERIZED have the trie path.

• EXACT: [ "/foo", "/foo" ] (The trie path is the same.)
• PREFIX: [ "/foo/", "/foo/*" ]
• PARAMETERIZED: [ "/foo/:", "/foo/:" ] (The trie path is the same.)

RoutePathType.REGEX may have one or two paths. If the Route was created from a glob pattern, it will have two paths where the first one is the regular expression and the second one is the glob pattern, e.g. [ "^/(?(.+)/)?foo$", "/**/foo" ]. If not created from a glob pattern, it will have only one path, which is the regular expression, e.g, [ "^/(?<foo>.*)$" ]

RoutePathType.REGEX_WITH_PREFIX has two paths. The first one is the regex and the second one is the path. e.g, [ "^/(?<foo>.*)$", "/bar/" ]

complexity

int complexity()

Returns the complexity of this Route. A higher complexity indicates more expensive computation for route matching, usually due to additional number of checks.

methods

Set<HttpMethod> methods()

Returns the Set of non-empty HttpMethods that this Route supports.

consumes

Set<MediaType> consumes()

Returns the Set of MediaTypes that this Route consumes.

produces

Set<MediaType> produces()

Returns the Set of MediaTypes that this Route produces.

isFallback

boolean isFallback()

Returns whether this Route is a fallback, which is matched only when no configured Route was matched.

excludedRoutes

List<Route> excludedRoutes()

Returns the Routes that are supposed to be excluded from this Route.

toBuilder

RouteBuilder toBuilder()

Returns a new RouteBuilder with the values of this Route instance.

withPrefix

Route withPrefix(String prefix)

Returns a newly-created Route which adds the specified prefix to this Route. These are examples of created Routes when the prefix is /api/v1:

• /login -> /api/v1/login
• /users/{userId} -> /api/v1/users/{userId}
• prefix:/files -> prefix:/api/v1/files (prefix match)
• regex:^/files/(?<filePath>.*)$ -> regex:^/api/v1/files/(?<filePath>.*)$ (regular expression)