Package com.linecorp.armeria.server

Class ContextPathServiceBindingBuilder

java.lang.Object

com.linecorp.armeria.server.ContextPathServiceBindingBuilder

@UnstableApi
public final class ContextPathServiceBindingBuilder
extends Object

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

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

 Server.builder()
       .contextPath("/v1", "/v2")
       .route()
       .get("/service1")
       .build(service1) // served under "/v1/service1" and "/v2/service1"
 

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

requestTimeout

public ContextPathServiceBindingBuilder requestTimeout(Duration requestTimeout)

requestTimeoutMillis

public ContextPathServiceBindingBuilder requestTimeoutMillis(long requestTimeoutMillis)

maxRequestLength

public ContextPathServiceBindingBuilder maxRequestLength(long maxRequestLength)

verboseResponses

public ContextPathServiceBindingBuilder verboseResponses(boolean verboseResponses)

accessLogFormat

public ContextPathServiceBindingBuilder accessLogFormat(String accessLogFormat)

accessLogWriter

public ContextPathServiceBindingBuilder accessLogWriter(AccessLogWriter accessLogWriter,
 boolean shutdownOnStop)

decorator

public ContextPathServiceBindingBuilder decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction)

decorator

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

decorators

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

decorators

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

defaultServiceName

public ContextPathServiceBindingBuilder defaultServiceName(String defaultServiceName)

defaultServiceNaming

public ContextPathServiceBindingBuilder defaultServiceNaming(ServiceNaming defaultServiceNaming)

defaultLogName

public ContextPathServiceBindingBuilder defaultLogName(String defaultLogName)

blockingTaskExecutor

public ContextPathServiceBindingBuilder blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor,
 boolean shutdownOnStop)

blockingTaskExecutor

public ContextPathServiceBindingBuilder blockingTaskExecutor(BlockingTaskExecutor blockingTaskExecutor,
 boolean shutdownOnStop)

blockingTaskExecutor

public ContextPathServiceBindingBuilder blockingTaskExecutor(int numThreads)

successFunction

public ContextPathServiceBindingBuilder successFunction(SuccessFunction successFunction)

requestAutoAbortDelay

public ContextPathServiceBindingBuilder requestAutoAbortDelay(Duration delay)

requestAutoAbortDelayMillis

public ContextPathServiceBindingBuilder requestAutoAbortDelayMillis(long delayMillis)

multipartUploadsLocation

public ContextPathServiceBindingBuilder multipartUploadsLocation(Path multipartUploadsLocation)

requestIdGenerator

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

addHeader

public ContextPathServiceBindingBuilder addHeader(CharSequence name,
 Object value)

addHeaders

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

setHeader

public ContextPathServiceBindingBuilder setHeader(CharSequence name,
 Object value)

setHeaders

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

errorHandler

public ContextPathServiceBindingBuilder errorHandler(ServiceErrorHandler serviceErrorHandler)

path

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

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

consumes

public ContextPathServiceBindingBuilder consumes(Iterable<MediaType> consumeTypes)

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

produces

public ContextPathServiceBindingBuilder produces(MediaType... produceTypes)

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

produces

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

Specifies an additional Route that should be matched.

exclude

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

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

contextHook

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

build

public ContextPathServicesBuilder build(HttpService service)

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