Package com.linecorp.armeria.server
Class DecoratingServiceBindingBuilder
java.lang.Object
com.linecorp.armeria.server.DecoratingServiceBindingBuilder
A builder class for binding a
decorator
with Route
fluently.
This class can be instantiated through ServerBuilder.routeDecorator()
.
Call build(Function)
or build(DecoratingHttpServiceFunction)
to build the decorator
and return to the ServerBuilder
.
ServerBuilder sb = Server.builder();
sb.routeDecorator() // Configure a decorator with route.
.pathPrefix("/api/users")
.build((delegate, ctx, req) -> {
if (!"bearer my_token".equals(req.headers().get(HttpHeaderNames.AUTHORIZATION))) {
return HttpResponse.of(HttpStatus.UNAUTHORIZED);
}
return delegate.serve(ctx, req);
}); // Return to the ServerBuilder.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies an additionalRoute
that should be matched.build
(DecoratingHttpServiceFunction decoratingHttpServiceFunction) Sets theDecoratingHttpServiceFunction
and returnsServerBuilder
that thisDecoratingServiceBindingBuilder
was created from.build
(Function<? super HttpService, ? extends HttpService> decorator) Sets thedecorator
and returnsServerBuilder
that thisDecoratingServiceBindingBuilder
was created from.Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.CONNECT
requests.SetsMediaType
s that anHttpService
will consume.SetsMediaType
s that anHttpService
will consume.Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.DELETE
requests.Adds apathPattern
that is supposed to be excluded from theRoute
s built by thisAbstractBindingBuilder
.Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.GET
requests.Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.HEAD
requests.matchesHeaders
(CharSequence headerName, Predicate<? super String> valuePredicate) Sets theRoute
to accept a request when the specifiedvaluePredicate
evaluatestrue
with the value of the specifiedheaderName
header.matchesHeaders
(Iterable<String> headerPredicates) Sets theRoute
to accept a request if it matches all the specified predicates forHttpHeaders
.matchesHeaders
(String... headerPredicates) Sets theRoute
to accept a request if it matches all the specified predicates forHttpHeaders
.matchesParams
(Iterable<String> paramPredicates) Sets theRoute
to accept a request if it matches all the specified predicates for HTTP parameters.matchesParams
(String... paramPredicates) Sets theRoute
to accept a request if it matches all the specified predicates for HTTP parameters.matchesParams
(String paramName, Predicate<? super String> valuePredicate) Sets theRoute
to accept a request when the specifiedvaluePredicate
evaluatestrue
with the value of the specifiedparamName
parameter.methods
(HttpMethod... methods) Sets theHttpMethod
s that anHttpService
will support.methods
(Iterable<HttpMethod> methods) Sets theHttpMethod
s that anHttpService
will support.Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.OPTIONS
requests.Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.PATCH
requests.Sets the path pattern that anHttpService
will be bound to.pathPrefix
(String prefix) Sets the specified prefix which is a directory that anHttpService
will be bound under.Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.POST
requests.SetsMediaType
s that anHttpService
will produce to be used in content negotiation.SetsMediaType
s that anHttpService
will produce to be used in content negotiation.Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.PUT
requests.Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.TRACE
requests.
-
Method Details
-
build
Sets thedecorator
and returnsServerBuilder
that thisDecoratingServiceBindingBuilder
was created from.- Parameters:
decorator
- theFunction
that decoratesHttpService
-
build
Sets theDecoratingHttpServiceFunction
and returnsServerBuilder
that thisDecoratingServiceBindingBuilder
was created from.- Parameters:
decoratingHttpServiceFunction
- theDecoratingHttpServiceFunction
that decoratesHttpService
-
path
Sets the path pattern that anHttpService
will be bound to. Please refer to the Path patterns in order to learn how to specify a path pattern.- Throws:
IllegalArgumentException
- if the specified path pattern is invalid
-
pathPrefix
Sets the specified prefix which is a directory that anHttpService
will be bound under.pathPrefix("/my/path")
is identical topath("prefix:/my/path")
.- Throws:
IllegalArgumentException
- if the specified path pattern is invalid
-
get
Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.GET
requests. Please refer to the Path patterns in order to learn how to specify a path pattern.- Throws:
IllegalArgumentException
- if the specified path pattern is invalid
-
post
Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.POST
requests. Please refer to the Path patterns in order to learn how to specify a path pattern.- Throws:
IllegalArgumentException
- if the specified path pattern is invalid
-
put
Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.PUT
requests. Please refer to the Path patterns in order to learn how to specify a path pattern.- Throws:
IllegalArgumentException
- if the specified path pattern is invalid
-
patch
Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.PATCH
requests. Please refer to the Path patterns in order to learn how to specify a path pattern.- Throws:
IllegalArgumentException
- if the specified path pattern is invalid
-
delete
Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.DELETE
requests. Please refer to the Path patterns in order to learn how to specify a path pattern.- Throws:
IllegalArgumentException
- if the specified path pattern is invalid
-
options
Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.OPTIONS
requests. Please refer to the Path patterns in order to learn how to specify a path pattern.- Throws:
IllegalArgumentException
- if the specified path pattern is invalid
-
head
Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.HEAD
requests. Please refer to the Path patterns in order to learn how to specify a path pattern.- Throws:
IllegalArgumentException
- if the specified path pattern is invalid
-
trace
Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.TRACE
requests. Please refer to the Path patterns in order to learn how to specify a path pattern.- Throws:
IllegalArgumentException
- if the specified path pattern is invalid
-
connect
Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.CONNECT
requests. Please refer to the Path patterns in order to learn how to specify a path pattern.- Throws:
IllegalArgumentException
- if the specified path pattern is invalid
-
methods
Sets theHttpMethod
s that anHttpService
will support. If not set,HttpMethod.knownMethods()
s are set.- See Also:
-
methods
Sets theHttpMethod
s that anHttpService
will support. If not set,HttpMethod.knownMethods()
s are set.- See Also:
-
consumes
SetsMediaType
s that anHttpService
will consume. If not set, theHttpService
will accept all media types. -
consumes
SetsMediaType
s that anHttpService
will consume. If not set, theHttpService
will accept all media types. -
produces
SetsMediaType
s that anHttpService
will produce to be used in content negotiation. See Accept header for more information. -
produces
SetsMediaType
s that anHttpService
will produce to be used in content negotiation. See Accept header for more information. -
matchesParams
Sets theRoute
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 asome-param=some-value
parametersome-param!=some-value
which means that the request must not have asome-param=some-value
parametersome-param
which means that the request must contain asome-param
parameter!some-param
which means that the request must not contain asome-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:
-
matchesParams
Sets theRoute
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 asome-param=some-value
parametersome-param!=some-value
which means that the request must not have asome-param=some-value
parametersome-param
which means that the request must contain asome-param
parameter!some-param
which means that the request must not contain asome-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:
-
matchesParams
public DecoratingServiceBindingBuilder matchesParams(String paramName, Predicate<? super String> valuePredicate) Sets theRoute
to accept a request when the specifiedvaluePredicate
evaluatestrue
with the value of the specifiedparamName
parameter. -
matchesHeaders
Sets theRoute
to accept a request if it matches all the specified predicates forHttpHeaders
. The predicate can be one of the following forms:some-header=some-value
which means that the request must have asome-header: some-value
headersome-header!=some-value
which means that the request must not have asome-header: some-value
headersome-header
which means that the request must contain asome-header
header!some-header
which means that the request must not contain asome-header
header
- See Also:
-
matchesHeaders
Sets theRoute
to accept a request if it matches all the specified predicates forHttpHeaders
. The predicate can be one of the following forms:some-header=some-value
which means that the request must have asome-header: some-value
headersome-header!=some-value
which means that the request must not have asome-header: some-value
an headersome-header
which means that the request must contain asome-header
header!some-header
which means that the request must not contain asome-header
header
- See Also:
-
matchesHeaders
public DecoratingServiceBindingBuilder matchesHeaders(CharSequence headerName, Predicate<? super String> valuePredicate) Sets theRoute
to accept a request when the specifiedvaluePredicate
evaluatestrue
with the value of the specifiedheaderName
header. -
addRoute
Specifies an additionalRoute
that should be matched. -
exclude
Adds apathPattern
that is supposed to be excluded from theRoute
s built by thisAbstractBindingBuilder
. Please refer to Path patterns to learn more about path pattern syntax. -
exclude
-