Package com.linecorp.armeria.server

Class ContextPathDecoratingBindingBuilder

java.lang.Object

com.linecorp.armeria.server.ContextPathDecoratingBindingBuilder

@UnstableApi
public final class ContextPathDecoratingBindingBuilder
extends Object

A builder class for binding a decorator with Route fluently under a set of context paths.

Call build(Function) or build(DecoratingHttpServiceFunction) to build the decorator.

 Server.builder()
       .contextPath("/v1", "/v2")
       .routeDecorator()
       .pathPrefix("/api")
       .path("/decorated")
       .build(myDecorator) // decorator under /v1/api/decorated, /v2/api/decorated
 

Method Summary

Modifier and Type	Method	Description
ContextPathDecoratingBindingBuilder	addRoute(Route route)	Specifies an additional Route that should be matched.
ContextPathServicesBuilder	build(DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Sets the DecoratingHttpServiceFunction and returns the ContextPathServicesBuilder that this ContextPathDecoratingBindingBuilder was created from.
ContextPathServicesBuilder	build(Function<? super HttpService,? extends HttpService> decorator)	Sets the decorator and returns the ContextPathServicesBuilder that this ContextPathDecoratingBindingBuilder was created from.
ContextPathDecoratingBindingBuilder	connect(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.CONNECT requests.
ContextPathDecoratingBindingBuilder	consumes(MediaType... consumeTypes)	Sets MediaTypes that an HttpService will consume.
ContextPathDecoratingBindingBuilder	consumes(Iterable<MediaType> consumeTypes)	Sets MediaTypes that an HttpService will consume.
ContextPathDecoratingBindingBuilder	delete(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.DELETE requests.
ContextPathDecoratingBindingBuilder	exclude(Route excludedRoute)	Adds a Route that is supposed to be excluded from the Routes built by this AbstractBindingBuilder.
ContextPathDecoratingBindingBuilder	exclude(String pathPattern)	Adds a pathPattern that is supposed to be excluded from the Routes built by this AbstractBindingBuilder.
ContextPathDecoratingBindingBuilder	get(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.GET requests.
ContextPathDecoratingBindingBuilder	head(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.HEAD requests.
ContextPathDecoratingBindingBuilder	matchesHeaders(CharSequence headerName, Predicate<? super String> valuePredicate)	Sets the Route to accept a request when the specified valuePredicate evaluates true with the value of the specified headerName header.
ContextPathDecoratingBindingBuilder	matchesHeaders(Iterable<String> headerPredicates)	Sets the Route to accept a request if it matches all the specified predicates for HttpHeaders.
ContextPathDecoratingBindingBuilder	matchesHeaders(String... headerPredicates)	Sets the Route to accept a request if it matches all the specified predicates for HttpHeaders.
ContextPathDecoratingBindingBuilder	matchesParams(Iterable<String> paramPredicates)	Sets the Route to accept a request if it matches all the specified predicates for HTTP parameters.
ContextPathDecoratingBindingBuilder	matchesParams(String... paramPredicates)	Sets the Route to accept a request if it matches all the specified predicates for HTTP parameters.
ContextPathDecoratingBindingBuilder	matchesParams(String paramName, Predicate<? super String> valuePredicate)	Sets the Route to accept a request when the specified valuePredicate evaluates true with the value of the specified paramName parameter.
ContextPathDecoratingBindingBuilder	methods(HttpMethod... methods)	Sets the HttpMethods that an HttpService will support.
ContextPathDecoratingBindingBuilder	methods(Iterable<HttpMethod> methods)	Sets the HttpMethods that an HttpService will support.
ContextPathDecoratingBindingBuilder	options(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.OPTIONS requests.
ContextPathDecoratingBindingBuilder	patch(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.PATCH requests.
ContextPathDecoratingBindingBuilder	path(String pathPattern)	Sets the path pattern that an HttpService will be bound to.
ContextPathDecoratingBindingBuilder	pathPrefix(String prefix)	Sets the specified prefix which is a directory that an HttpService will be bound under.
ContextPathDecoratingBindingBuilder	post(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.POST requests.
ContextPathDecoratingBindingBuilder	produces(MediaType... produceTypes)	Sets MediaTypes that an HttpService will produce to be used in content negotiation.
ContextPathDecoratingBindingBuilder	produces(Iterable<MediaType> produceTypes)	Sets MediaTypes that an HttpService will produce to be used in content negotiation.
ContextPathDecoratingBindingBuilder	put(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.PUT requests.
ContextPathDecoratingBindingBuilder	trace(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.TRACE requests.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

path

public ContextPathDecoratingBindingBuilder path(String pathPattern)

Sets the path pattern that an HttpService will be bound to. Please refer to the Path patterns in order to learn how to specify a path pattern.

pathPrefix

public ContextPathDecoratingBindingBuilder pathPrefix(String prefix)

Sets the specified prefix which is a directory that an HttpService will be bound under. pathPrefix("/my/path") is identical to path("prefix:/my/path").

get

public ContextPathDecoratingBindingBuilder get(String pathPattern)

Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.GET requests. Please refer to the Path patterns in order to learn how to specify a path pattern.

post

public ContextPathDecoratingBindingBuilder post(String pathPattern)

Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.POST requests. Please refer to the Path patterns in order to learn how to specify a path pattern.

put

public ContextPathDecoratingBindingBuilder put(String pathPattern)

Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.PUT requests. Please refer to the Path patterns in order to learn how to specify a path pattern.

patch

public ContextPathDecoratingBindingBuilder patch(String pathPattern)

Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.PATCH requests. Please refer to the Path patterns in order to learn how to specify a path pattern.

delete

public ContextPathDecoratingBindingBuilder delete(String pathPattern)

Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.DELETE requests. Please refer to the Path patterns in order to learn how to specify a path pattern.

options

public ContextPathDecoratingBindingBuilder options(String pathPattern)

Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.OPTIONS requests. Please refer to the Path patterns in order to learn how to specify a path pattern.

head

public ContextPathDecoratingBindingBuilder head(String pathPattern)

Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.HEAD requests. Please refer to the Path patterns in order to learn how to specify a path pattern.

trace

public ContextPathDecoratingBindingBuilder trace(String pathPattern)

Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.TRACE requests. Please refer to the Path patterns in order to learn how to specify a path pattern.

connect

public ContextPathDecoratingBindingBuilder connect(String pathPattern)

Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.CONNECT requests. Please refer to the Path patterns in order to learn how to specify a path pattern.

methods

public ContextPathDecoratingBindingBuilder methods(HttpMethod... methods)

Sets the HttpMethods that an HttpService will support. If not set, HttpMethod.knownMethods()s are set.

See Also:

• path(String)
• pathPrefix(String)

methods

public ContextPathDecoratingBindingBuilder methods(Iterable<HttpMethod> methods)

Sets the HttpMethods that an HttpService will support. If not set, HttpMethod.knownMethods()s are set.

See Also:

• path(String)
• pathPrefix(String)

consumes

public ContextPathDecoratingBindingBuilder consumes(MediaType... consumeTypes)

Sets MediaTypes that an HttpService will consume. If not set, the HttpService will accept all media types.

consumes

public ContextPathDecoratingBindingBuilder consumes(Iterable<MediaType> consumeTypes)

Sets MediaTypes that an HttpService will consume. If not set, the HttpService will accept all media types.

produces

public ContextPathDecoratingBindingBuilder produces(MediaType... produceTypes)

Sets MediaTypes that an HttpService will produce to be used in content negotiation. See Accept header for more information.

produces

public ContextPathDecoratingBindingBuilder produces(Iterable<MediaType> produceTypes)

Sets MediaTypes that an HttpService will produce to be used in content negotiation. See Accept header for more information.

matchesParams

public ContextPathDecoratingBindingBuilder matchesParams(String... paramPredicates)

Sets the Route to accept a request if it matches all the specified predicates for HTTP parameters. The predicate can be one of the following forms:

• some-param=some-value which means that the request must have a some-param=some-value parameter
• some-param!=some-value which means that the request must not have a some-param=some-value parameter
• some-param which means that the request must contain a some-param parameter
• !some-param which means that the request must not contain a some-param parameter

Note that these predicates can be evaluated only with the query string of the request URI. Also note that each predicate will be evaluated with the decoded value of HTTP parameters, so do not use percent-encoded value in the predicate.

See Also:

• MatchesParam

matchesParams

public ContextPathDecoratingBindingBuilder matchesParams(Iterable<String> paramPredicates)

Sets the Route to accept a request if it matches all the specified predicates for HTTP parameters. The predicate can be one of the following forms:

• some-param=some-value which means that the request must have a some-param=some-value parameter
• some-param!=some-value which means that the request must not have a some-param=some-value parameter
• some-param which means that the request must contain a some-param parameter
• !some-param which means that the request must not contain a some-param parameter

Note that these predicates can be evaluated only with the query string of the request URI. Also note that each predicate will be evaluated with the decoded value of HTTP parameters, so do not use percent-encoded value in the predicate.

See Also:

• MatchesParam

matchesParams

public ContextPathDecoratingBindingBuilder matchesParams(String paramName,
 Predicate<? super String> valuePredicate)

Sets the Route to accept a request when the specified valuePredicate evaluates true with the value of the specified paramName parameter.

matchesHeaders

public ContextPathDecoratingBindingBuilder matchesHeaders(String... headerPredicates)

Sets the Route to accept a request if it matches all the specified predicates for HttpHeaders. The predicate can be one of the following forms:

• some-header=some-value which means that the request must have a some-header: some-value header
• some-header!=some-value which means that the request must not have a some-header: some-value header
• some-header which means that the request must contain a some-header header
• !some-header which means that the request must not contain a some-header header

See Also:

• MatchesHeader

matchesHeaders

public ContextPathDecoratingBindingBuilder matchesHeaders(Iterable<String> headerPredicates)

Sets the Route to accept a request if it matches all the specified predicates for HttpHeaders. The predicate can be one of the following forms:

• some-header=some-value which means that the request must have a some-header: some-value header
• some-header!=some-value which means that the request must not have a some-header: some-value an header
• some-header which means that the request must contain a some-header header
• !some-header which means that the request must not contain a some-header header

See Also:

• MatchesHeader

matchesHeaders

public ContextPathDecoratingBindingBuilder matchesHeaders(CharSequence headerName,
 Predicate<? super String> valuePredicate)

Sets the Route to accept a request when the specified valuePredicate evaluates true with the value of the specified headerName header.

addRoute

public ContextPathDecoratingBindingBuilder addRoute(Route route)

Specifies an additional Route that should be matched.

exclude

public ContextPathDecoratingBindingBuilder exclude(String pathPattern)

Adds a pathPattern that is supposed to be excluded from the Routes built by this AbstractBindingBuilder. Please refer to Path patterns to learn more about path pattern syntax.

exclude

public ContextPathDecoratingBindingBuilder exclude(Route excludedRoute)

Adds a Route that is supposed to be excluded from the Routes built by this AbstractBindingBuilder.

build

public ContextPathServicesBuilder build(Function<? super HttpService,? extends HttpService> decorator)

Sets the decorator and returns the ContextPathServicesBuilder that this ContextPathDecoratingBindingBuilder was created from.

Parameters:

decorator - the Function that decorates HttpService

build

public ContextPathServicesBuilder build(DecoratingHttpServiceFunction decoratingHttpServiceFunction)

Sets the DecoratingHttpServiceFunction and returns the ContextPathServicesBuilder that this ContextPathDecoratingBindingBuilder was created from.

Parameters:

decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpService