Package com.linecorp.armeria.server
Class VirtualHostServiceBindingBuilder
java.lang.Object
com.linecorp.armeria.server.VirtualHostServiceBindingBuilder
A builder class for binding an
HttpService
fluently. This class can be instantiated through
VirtualHostBuilder.route()
. You can also configure an HttpService
using
VirtualHostBuilder.withRoute(Consumer)
.
Call build(HttpService)
to build the HttpService
and return to the
VirtualHostBuilder
.
ServerBuilder sb = Server.builder();
sb.virtualHost("example.com")
.route() // Configure the first service in "example.com".
.post("/foo/bar")
.consumes(JSON, PLAIN_TEXT_UTF_8)
.produces(JSON_UTF_8)
.requestTimeoutMillis(5000)
.maxRequestLength(8192)
.verboseResponses(true)
.build((ctx, req) -> HttpResponse.of(OK)); // Return to the VirtualHostBuilder.
sb.virtualHost("example2.com") // Configure the second service "example2.com".
.withRoute(builder -> builder.path("/baz")
.methods(HttpMethod.GET, HttpMethod.POST)
.build((ctx, req) -> HttpResponse.of(OK)));
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionaccessLogFormat
(String accessLogFormat) accessLogWriter
(AccessLogWriter accessLogWriter, boolean shutdownOnStop) addHeader
(CharSequence name, Object value) addHeaders
(Iterable<? extends Map.Entry<? extends CharSequence, ?>> defaultHeaders) Specifies an additionalRoute
that should be matched.blockingTaskExecutor
(int numThreads) blockingTaskExecutor
(BlockingTaskExecutor blockingTaskExecutor, boolean shutdownOnStop) blockingTaskExecutor
(ScheduledExecutorService blockingTaskExecutor, boolean shutdownOnStop) build
(HttpService service) Sets theHttpService
and returns theVirtualHostBuilder
that thisVirtualHostServiceBindingBuilder
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.decorator
(DecoratingHttpServiceFunction decoratingHttpServiceFunction) decorator
(Function<? super HttpService, ? extends HttpService> decorator) decorators
(Iterable<? extends Function<? super HttpService, ? extends HttpService>> decorators) decorators
(Function<? super HttpService, ? extends HttpService>... decorators) defaultLogName
(String defaultLogName) defaultServiceName
(String defaultServiceName) defaultServiceNaming
(ServiceNaming defaultServiceNaming) Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.DELETE
requests.errorHandler
(ServiceErrorHandler serviceErrorHandler) 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.maxRequestLength
(long maxRequestLength) methods
(HttpMethod... methods) Sets theHttpMethod
s that anHttpService
will support.methods
(Iterable<HttpMethod> methods) Sets theHttpMethod
s that anHttpService
will support.multipartUploadsLocation
(Path multipartUploadsLocation) 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.requestAutoAbortDelay
(Duration delay) requestAutoAbortDelayMillis
(long delayMillis) requestIdGenerator
(Function<? super RoutingContext, ? extends RequestId> requestIdGenerator) requestTimeout
(Duration requestTimeout) requestTimeoutMillis
(long requestTimeoutMillis) setHeader
(CharSequence name, Object value) setHeaders
(Iterable<? extends Map.Entry<? extends CharSequence, ?>> defaultHeaders) successFunction
(SuccessFunction successFunction) Sets the path pattern that anHttpService
will be bound to, only supportingHttpMethod.TRACE
requests.verboseResponses
(boolean verboseResponses)
-
Method Details
-
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. -
pathPrefix
Sets the specified prefix which is a directory that anHttpService
will be bound under.pathPrefix("/my/path")
is identical topath("prefix:/my/path")
. -
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:
-
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. -
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. -
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. -
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. -
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. -
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. -
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. -
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. -
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. -
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 VirtualHostServiceBindingBuilder 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 VirtualHostServiceBindingBuilder 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
-
defaultServiceName
-
defaultServiceNaming
-
defaultLogName
-
requestTimeout
-
requestTimeoutMillis
-
maxRequestLength
-
verboseResponses
-
accessLogFormat
-
accessLogWriter
public VirtualHostServiceBindingBuilder accessLogWriter(AccessLogWriter accessLogWriter, boolean shutdownOnStop) -
decorator
public VirtualHostServiceBindingBuilder decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction) -
decorator
public VirtualHostServiceBindingBuilder decorator(Function<? super HttpService, ? extends HttpService> decorator) -
decorators
@SafeVarargs public final VirtualHostServiceBindingBuilder decorators(Function<? super HttpService, ? extends HttpService>... decorators) -
decorators
public VirtualHostServiceBindingBuilder decorators(Iterable<? extends Function<? super HttpService, ? extends HttpService>> decorators) -
blockingTaskExecutor
public VirtualHostServiceBindingBuilder blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor, boolean shutdownOnStop) -
blockingTaskExecutor
public VirtualHostServiceBindingBuilder blockingTaskExecutor(BlockingTaskExecutor blockingTaskExecutor, boolean shutdownOnStop) -
blockingTaskExecutor
-
successFunction
-
requestAutoAbortDelay
-
requestAutoAbortDelayMillis
-
multipartUploadsLocation
-
requestIdGenerator
public VirtualHostServiceBindingBuilder requestIdGenerator(Function<? super RoutingContext, ? extends RequestId> requestIdGenerator) -
addHeader
-
addHeaders
public VirtualHostServiceBindingBuilder addHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>> defaultHeaders) -
setHeader
-
setHeaders
public VirtualHostServiceBindingBuilder setHeaders(Iterable<? extends Map.Entry<? extends CharSequence, ?>> defaultHeaders) -
errorHandler
-
build
Sets theHttpService
and returns theVirtualHostBuilder
that thisVirtualHostServiceBindingBuilder
was created from.- Throws:
IllegalStateException
- if the path that theHttpService
will be bound to is not specified
-