Package com.linecorp.armeria.server

Class VirtualHostContextPathServiceBindingBuilder

java.lang.Object

com.linecorp.armeria.server.VirtualHostContextPathServiceBindingBuilder

@UnstableApi
public final class VirtualHostContextPathServiceBindingBuilder
extends Object

A builder class for binding an HttpService fluently. This class can be instantiated through VirtualHostBuilder.contextPath(String...).

Call build(HttpService) to build the HttpService and return to the VirtualHostBuilder.

 Server.builder()
       .virtualHost("foo.com")
       .contextPath("/v3")
       .route()
       .get("/service2")
       .build(service2); // served under "/v3/service2"
 

Method Summary

Modifier and Type	Method	Description
VirtualHostContextPathServiceBindingBuilder	accessLogFormat(String accessLogFormat)
VirtualHostContextPathServiceBindingBuilder	accessLogWriter(AccessLogWriter accessLogWriter, boolean shutdownOnStop)
VirtualHostContextPathServiceBindingBuilder	addHeader(CharSequence name, Object value)
VirtualHostContextPathServiceBindingBuilder	addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> defaultHeaders)
VirtualHostContextPathServiceBindingBuilder	addRoute(Route route)	Specifies an additional Route that should be matched.
VirtualHostContextPathServiceBindingBuilder	blockingTaskExecutor(int numThreads)
VirtualHostContextPathServiceBindingBuilder	blockingTaskExecutor(BlockingTaskExecutor blockingTaskExecutor, boolean shutdownOnStop)
VirtualHostContextPathServiceBindingBuilder	blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor, boolean shutdownOnStop)
VirtualHostContextPathServicesBuilder	build(HttpService service)	Sets the HttpService and returns the object that this builder was created from.
VirtualHostContextPathServiceBindingBuilder	connect(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.CONNECT requests.
VirtualHostContextPathServiceBindingBuilder	consumes(MediaType... consumeTypes)	Sets MediaTypes that an HttpService will consume.
VirtualHostContextPathServiceBindingBuilder	consumes(Iterable<MediaType> consumeTypes)	Sets MediaTypes that an HttpService will consume.
VirtualHostContextPathServiceBindingBuilder	contextHook(Supplier<? extends AutoCloseable> contextHook)
default VirtualHostContextPathServiceBindingBuilder	decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Decorates an HttpService with the specified decorator.
VirtualHostContextPathServiceBindingBuilder	decorator(Function<? super HttpService,? extends HttpService> decorator)
VirtualHostContextPathServiceBindingBuilder	decorators(Iterable<? extends Function<? super HttpService,? extends HttpService>> decorators)
VirtualHostContextPathServiceBindingBuilder	decorators(Function<? super HttpService,? extends HttpService>... decorators)
VirtualHostContextPathServiceBindingBuilder	defaultLogName(String defaultLogName)
VirtualHostContextPathServiceBindingBuilder	defaultServiceName(String defaultServiceName)
VirtualHostContextPathServiceBindingBuilder	defaultServiceNaming(ServiceNaming defaultServiceNaming)
VirtualHostContextPathServiceBindingBuilder	delete(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.DELETE requests.
VirtualHostContextPathServiceBindingBuilder	errorHandler(ServiceErrorHandler serviceErrorHandler)
VirtualHostContextPathServiceBindingBuilder	exclude(Route excludedRoute)	Adds a Route that is supposed to be excluded from the Routes built by this AbstractBindingBuilder.
VirtualHostContextPathServiceBindingBuilder	exclude(String pathPattern)	Adds a pathPattern that is supposed to be excluded from the Routes built by this AbstractBindingBuilder.
VirtualHostContextPathServiceBindingBuilder	get(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.GET requests.
VirtualHostContextPathServiceBindingBuilder	head(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.HEAD requests.
VirtualHostContextPathServiceBindingBuilder	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.
VirtualHostContextPathServiceBindingBuilder	matchesHeaders(Iterable<String> headerPredicates)	Sets the Route to accept a request if it matches all the specified predicates for HttpHeaders.
VirtualHostContextPathServiceBindingBuilder	matchesHeaders(String... headerPredicates)	Sets the Route to accept a request if it matches all the specified predicates for HttpHeaders.
VirtualHostContextPathServiceBindingBuilder	matchesParams(Iterable<String> paramPredicates)	Sets the Route to accept a request if it matches all the specified predicates for HTTP parameters.
VirtualHostContextPathServiceBindingBuilder	matchesParams(String... paramPredicates)	Sets the Route to accept a request if it matches all the specified predicates for HTTP parameters.
VirtualHostContextPathServiceBindingBuilder	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.
VirtualHostContextPathServiceBindingBuilder	maxRequestLength(long maxRequestLength)
VirtualHostContextPathServiceBindingBuilder	methods(HttpMethod... methods)	Sets the HttpMethods that an HttpService will support.
VirtualHostContextPathServiceBindingBuilder	methods(Iterable<HttpMethod> methods)	Sets the HttpMethods that an HttpService will support.
VirtualHostContextPathServiceBindingBuilder	multipartRemovalStrategy(MultipartRemovalStrategy removalStrategy)
VirtualHostContextPathServiceBindingBuilder	multipartUploadsLocation(Path multipartUploadsLocation)
VirtualHostContextPathServiceBindingBuilder	options(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.OPTIONS requests.
VirtualHostContextPathServiceBindingBuilder	patch(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.PATCH requests.
VirtualHostContextPathServiceBindingBuilder	path(String pathPattern)	Sets the path pattern that an HttpService will be bound to.
VirtualHostContextPathServiceBindingBuilder	pathPrefix(String prefix)	Sets the specified prefix which is a directory that an HttpService will be bound under.
VirtualHostContextPathServiceBindingBuilder	post(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.POST requests.
VirtualHostContextPathServiceBindingBuilder	produces(MediaType... produceTypes)	Sets MediaTypes that an HttpService will produce to be used in content negotiation.
VirtualHostContextPathServiceBindingBuilder	produces(Iterable<MediaType> produceTypes)	Sets MediaTypes that an HttpService will produce to be used in content negotiation.
VirtualHostContextPathServiceBindingBuilder	put(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.PUT requests.
VirtualHostContextPathServiceBindingBuilder	requestAutoAbortDelay(Duration delay)
VirtualHostContextPathServiceBindingBuilder	requestAutoAbortDelayMillis(long delayMillis)
VirtualHostContextPathServiceBindingBuilder	requestIdGenerator(Function<? super RoutingContext,? extends RequestId> requestIdGenerator)
VirtualHostContextPathServiceBindingBuilder	requestTimeout(Duration requestTimeout)
VirtualHostContextPathServiceBindingBuilder	requestTimeoutMillis(long requestTimeoutMillis)
VirtualHostContextPathServiceBindingBuilder	serviceWorkerGroup(int numThreads)
VirtualHostContextPathServiceBindingBuilder	serviceWorkerGroup(EventLoopGroup serviceWorkerGroup, boolean shutdownOnStop)
VirtualHostContextPathServiceBindingBuilder	setHeader(CharSequence name, Object value)
VirtualHostContextPathServiceBindingBuilder	setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> defaultHeaders)
VirtualHostContextPathServiceBindingBuilder	successFunction(SuccessFunction successFunction)
VirtualHostContextPathServiceBindingBuilder	trace(String pathPattern)	Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.TRACE requests.
VirtualHostContextPathServiceBindingBuilder	verboseResponses(boolean verboseResponses)

Methods inherited from class java.lang.Object

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

Method Details

build

public VirtualHostContextPathServicesBuilder build(HttpService service)

Sets the HttpService and returns the object that this builder was created from.

requestTimeout

public VirtualHostContextPathServiceBindingBuilder requestTimeout(Duration requestTimeout)

requestTimeoutMillis

public VirtualHostContextPathServiceBindingBuilder requestTimeoutMillis(long requestTimeoutMillis)

maxRequestLength

public VirtualHostContextPathServiceBindingBuilder maxRequestLength(long maxRequestLength)

verboseResponses

public VirtualHostContextPathServiceBindingBuilder verboseResponses(boolean verboseResponses)

accessLogFormat

public VirtualHostContextPathServiceBindingBuilder accessLogFormat(String accessLogFormat)

accessLogWriter

public VirtualHostContextPathServiceBindingBuilder accessLogWriter(AccessLogWriter accessLogWriter,
 boolean shutdownOnStop)

decorator

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

decorators

public VirtualHostContextPathServiceBindingBuilder decorators(Function<? super HttpService,? extends HttpService>... decorators)

decorators

public VirtualHostContextPathServiceBindingBuilder decorators(Iterable<? extends Function<? super HttpService,? extends HttpService>> decorators)

defaultServiceName

public VirtualHostContextPathServiceBindingBuilder defaultServiceName(String defaultServiceName)

defaultServiceNaming

public VirtualHostContextPathServiceBindingBuilder defaultServiceNaming(ServiceNaming defaultServiceNaming)

defaultLogName

public VirtualHostContextPathServiceBindingBuilder defaultLogName(String defaultLogName)

blockingTaskExecutor

public VirtualHostContextPathServiceBindingBuilder blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor,
 boolean shutdownOnStop)

blockingTaskExecutor

public VirtualHostContextPathServiceBindingBuilder blockingTaskExecutor(BlockingTaskExecutor blockingTaskExecutor,
 boolean shutdownOnStop)

blockingTaskExecutor

public VirtualHostContextPathServiceBindingBuilder blockingTaskExecutor(int numThreads)

successFunction

public VirtualHostContextPathServiceBindingBuilder successFunction(SuccessFunction successFunction)

requestAutoAbortDelay

public VirtualHostContextPathServiceBindingBuilder requestAutoAbortDelay(Duration delay)

requestAutoAbortDelayMillis

public VirtualHostContextPathServiceBindingBuilder requestAutoAbortDelayMillis(long delayMillis)

multipartUploadsLocation

public VirtualHostContextPathServiceBindingBuilder multipartUploadsLocation(Path multipartUploadsLocation)

multipartRemovalStrategy

public VirtualHostContextPathServiceBindingBuilder multipartRemovalStrategy(MultipartRemovalStrategy removalStrategy)

serviceWorkerGroup

public VirtualHostContextPathServiceBindingBuilder serviceWorkerGroup(EventLoopGroup serviceWorkerGroup,
 boolean shutdownOnStop)

serviceWorkerGroup

public VirtualHostContextPathServiceBindingBuilder serviceWorkerGroup(int numThreads)

requestIdGenerator

public VirtualHostContextPathServiceBindingBuilder requestIdGenerator(Function<? super RoutingContext,? extends RequestId> requestIdGenerator)

addHeader

public VirtualHostContextPathServiceBindingBuilder addHeader(CharSequence name,
 Object value)

addHeaders

public VirtualHostContextPathServiceBindingBuilder addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> defaultHeaders)

setHeader

public VirtualHostContextPathServiceBindingBuilder setHeader(CharSequence name,
 Object value)

setHeaders

public VirtualHostContextPathServiceBindingBuilder setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> defaultHeaders)

errorHandler

public VirtualHostContextPathServiceBindingBuilder errorHandler(ServiceErrorHandler serviceErrorHandler)

contextHook

public VirtualHostContextPathServiceBindingBuilder contextHook(Supplier<? extends AutoCloseable> contextHook)

decorator

default VirtualHostContextPathServiceBindingBuilder decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction)

Decorates an HttpService with the specified decorator.

Parameters:

decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpServices

path

public VirtualHostContextPathServiceBindingBuilder 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.

Throws:

IllegalArgumentException - if the specified path pattern is invalid

pathPrefix

public VirtualHostContextPathServiceBindingBuilder 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").

Throws:

IllegalArgumentException - if the specified path pattern is invalid

get

public VirtualHostContextPathServiceBindingBuilder 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.

Throws:

IllegalArgumentException - if the specified path pattern is invalid

post

public VirtualHostContextPathServiceBindingBuilder 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.

Throws:

IllegalArgumentException - if the specified path pattern is invalid

put

public VirtualHostContextPathServiceBindingBuilder 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.

Throws:

IllegalArgumentException - if the specified path pattern is invalid

patch

public VirtualHostContextPathServiceBindingBuilder 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.

Throws:

IllegalArgumentException - if the specified path pattern is invalid

delete

public VirtualHostContextPathServiceBindingBuilder 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.

Throws:

IllegalArgumentException - if the specified path pattern is invalid

options

public VirtualHostContextPathServiceBindingBuilder 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.

Throws:

IllegalArgumentException - if the specified path pattern is invalid

head

public VirtualHostContextPathServiceBindingBuilder 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.

Throws:

IllegalArgumentException - if the specified path pattern is invalid

trace

public VirtualHostContextPathServiceBindingBuilder 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.

Throws:

IllegalArgumentException - if the specified path pattern is invalid

connect

public VirtualHostContextPathServiceBindingBuilder 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.

Throws:

IllegalArgumentException - if the specified path pattern is invalid

methods

public VirtualHostContextPathServiceBindingBuilder 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 VirtualHostContextPathServiceBindingBuilder 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 VirtualHostContextPathServiceBindingBuilder consumes(MediaType... consumeTypes)

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

consumes

public VirtualHostContextPathServiceBindingBuilder consumes(Iterable<MediaType> consumeTypes)

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

produces

public VirtualHostContextPathServiceBindingBuilder produces(MediaType... produceTypes)

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

produces

public VirtualHostContextPathServiceBindingBuilder 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 VirtualHostContextPathServiceBindingBuilder 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 VirtualHostContextPathServiceBindingBuilder 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 VirtualHostContextPathServiceBindingBuilder 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 VirtualHostContextPathServiceBindingBuilder 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 VirtualHostContextPathServiceBindingBuilder 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 VirtualHostContextPathServiceBindingBuilder 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 VirtualHostContextPathServiceBindingBuilder addRoute(Route route)

Specifies an additional Route that should be matched.

exclude

public VirtualHostContextPathServiceBindingBuilder 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 VirtualHostContextPathServiceBindingBuilder exclude(Route excludedRoute)

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