Package com.linecorp.armeria.server

Class VirtualHostBuilder

java.lang.Object

com.linecorp.armeria.server.VirtualHostBuilder

All Implemented Interfaces:

TlsSetters

public final class VirtualHostBuilder
extends Object
implements TlsSetters

Builds a new VirtualHost.

This class can only be instantiated through the ServerBuilder.defaultVirtualHost() or ServerBuilder.virtualHost(String) method of the ServerBuilder.

Call and() method and return to ServerBuilder.

See Also:

• ServerBuilder
• Route

Method Summary

Modifier and Type	Method	Description
VirtualHostBuilder	accessLogger(String loggerName)	Sets the Logger named loggerName of this VirtualHost, which is used for writing access logs.
VirtualHostBuilder	accessLogger(Function<? super VirtualHost,? extends Logger> mapper)	Sets the access logger mapper of this VirtualHost.
VirtualHostBuilder	accessLogger(Logger logger)	Sets the Logger of this VirtualHost, which is used for writing access logs.
VirtualHostBuilder	accessLogWriter(AccessLogWriter accessLogWriter, boolean shutdownOnStop)	Sets the access log writer of this VirtualHost.
VirtualHostBuilder	addHeader(CharSequence name, Object value)	Adds the default HTTP header for an HttpResponse served by this VirtualHost.
VirtualHostBuilder	addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> defaultHeaders)	Adds the default HTTP headers for an HttpResponse served by this VirtualHost.
ServerBuilder	and()	Returns the parent ServerBuilder.
VirtualHostAnnotatedServiceBindingBuilder	annotatedService()	Returns a new instance of VirtualHostAnnotatedServiceBindingBuilder to build an annotated service fluently.
VirtualHostBuilder	annotatedService(Object service)	Binds the specified annotated service object under the path prefix "/".
VirtualHostBuilder	annotatedService(Object service, Object... exceptionHandlersAndConverters)	Binds the specified annotated service object under the path prefix "/".
VirtualHostBuilder	annotatedService(Object service, Function<? super HttpService,? extends HttpService> decorator, Object... exceptionHandlersAndConverters)	Binds the specified annotated service object under the path prefix "/".
VirtualHostBuilder	annotatedService(String pathPrefix, Object service)	Binds the specified annotated service object under the specified path prefix.
VirtualHostBuilder	annotatedService(String pathPrefix, Object service, Iterable<?> exceptionHandlersAndConverters)	Binds the specified annotated service object under the specified path prefix.
VirtualHostBuilder	annotatedService(String pathPrefix, Object service, Object... exceptionHandlersAndConverters)	Binds the specified annotated service object under the specified path prefix.
VirtualHostBuilder	annotatedService(String pathPrefix, Object service, Function<? super HttpService,? extends HttpService> decorator, Iterable<?> exceptionHandlersAndConverters)	Binds the specified annotated service object under the specified path prefix.
VirtualHostBuilder	annotatedService(String pathPrefix, Object service, Function<? super HttpService,? extends HttpService> decorator, Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions, Iterable<? extends RequestConverterFunction> requestConverterFunctions, Iterable<? extends ResponseConverterFunction> responseConverterFunctions)	Binds the specified annotated service object under the specified path prefix.
VirtualHostBuilder	annotatedService(String pathPrefix, Object service, Function<? super HttpService,? extends HttpService> decorator, Object... exceptionHandlersAndConverters)	Binds the specified annotated service object under the specified path prefix.
VirtualHostBuilder	annotatedServiceExtensions(Iterable<? extends RequestConverterFunction> requestConverterFunctions, Iterable<? extends ResponseConverterFunction> responseConverterFunctions, Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions)	Sets the RequestConverterFunctions, ResponseConverterFunction and ExceptionHandlerFunctions for creating an AnnotatedServiceExtensions.
VirtualHostBuilder	baseContextPath(String baseContextPath)	Sets the base context path for this VirtualHost.
VirtualHostBuilder	blockingTaskExecutor(int numThreads)	Uses a newly created BlockingTaskExecutor with the specified number of threads dedicated to the execution of blocking tasks or invocations.
VirtualHostBuilder	blockingTaskExecutor(BlockingTaskExecutor blockingTaskExecutor, boolean shutdownOnStop)	Sets the BlockingTaskExecutor dedicated to the execution of blocking tasks or invocations.
VirtualHostBuilder	blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor, boolean shutdownOnStop)	Sets the ScheduledExecutorService dedicated to the execution of blocking tasks or invocations.
VirtualHostBuilder	contextHook(Supplier<? extends AutoCloseable> contextHook)	Sets the AutoCloseable which will be called whenever this RequestContext is popped from the RequestContextStorage.
VirtualHostContextPathServicesBuilder	contextPath(Iterable<String> contextPaths)	Returns a VirtualHostContextPathServicesBuilder which binds HttpServices under the specified context paths.
VirtualHostContextPathServicesBuilder	contextPath(String... contextPaths)	Returns a VirtualHostContextPathServicesBuilder which binds HttpServices under the specified context paths.
VirtualHostBuilder	decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Decorates all HttpServices with the specified DecoratingHttpServiceFunction.
VirtualHostBuilder	decorator(Route route, DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Decorates HttpServices whose Route matches the specified Route.
VirtualHostBuilder	decorator(Route route, Function<? super HttpService,? extends HttpService> decorator)	Decorates HttpServices whose Route matches the specified Route.
VirtualHostBuilder	decorator(String pathPattern, DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Decorates HttpServices whose Route matches the specified pathPattern.
VirtualHostBuilder	decorator(String pathPattern, Function<? super HttpService,? extends HttpService> decorator)	Decorates HttpServices whose Route matches the specified pathPattern.
VirtualHostBuilder	decorator(Function<? super HttpService,? extends HttpService> decorator)	Decorates all HttpServices with the specified decorator.
VirtualHostBuilder	decoratorUnder(String prefix, DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Decorates HttpServices under the specified directory.
VirtualHostBuilder	decoratorUnder(String prefix, Function<? super HttpService,? extends HttpService> decorator)	Decorates HttpServices under the specified directory.
VirtualHostBuilder	defaultHostname(String defaultHostname)	Sets the default hostname of this VirtualHost.
VirtualHostBuilder	defaultLogName(String defaultLogName)	Sets the default value of the RequestOnlyLog.name() property which is used when no name was set via RequestLogBuilder.name(String, String).
VirtualHostBuilder	defaultServiceNaming(ServiceNaming defaultServiceNaming)	Sets the default naming rule for the name of services.
VirtualHostBuilder	errorHandler(ServiceErrorHandler errorHandler)	Adds the ServiceErrorHandler that handles exceptions thrown in this virtual host.
VirtualHostBuilder	hostnamePattern(String hostnamePattern)	Deprecated. prefer specifying the hostnamePattern using ServerBuilder.virtualHost(String) or ServerBuilder.withVirtualHost(String, Consumer)
VirtualHostBuilder	maxRequestLength(long maxRequestLength)	Sets the maximum allowed length of the content decoded at the session layer.
VirtualHostBuilder	multipartRemovalStrategy(MultipartRemovalStrategy removalStrategy)	Sets the MultipartRemovalStrategy that determines when to remove temporary files created for multipart requests.
VirtualHostBuilder	multipartUploadsLocation(Path multipartUploadsLocation)	Sets the Path for storing the files uploaded from multipart/form-data requests.
VirtualHostBuilder	rejectedRouteHandler(RejectedRouteHandler handler)	Sets the RejectedRouteHandler which will be invoked when an attempt to bind an HttpService at a certain Route is rejected.
VirtualHostBuilder	requestAutoAbortDelay(Duration delay)	Sets the amount of time to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.
VirtualHostBuilder	requestAutoAbortDelayMillis(long delayMillis)	Sets the amount of time in millis to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.
VirtualHostBuilder	requestIdGenerator(Function<? super RoutingContext,? extends RequestId> requestIdGenerator)	Sets the Function which generates a RequestId.
VirtualHostBuilder	requestTimeout(Duration requestTimeout)	Sets the timeout of a request.
VirtualHostBuilder	requestTimeoutMillis(long requestTimeoutMillis)	Sets the timeout of a request in milliseconds.
VirtualHostServiceBindingBuilder	route()	Returns a ServiceBindingBuilder which is for binding an HttpService fluently.
VirtualHostDecoratingServiceBindingBuilder	routeDecorator()	Returns a VirtualHostDecoratingServiceBindingBuilder which is for binding a decorator fluently.
VirtualHostBuilder	service(HttpServiceWithRoutes serviceWithRoutes, Iterable<? extends Function<? super HttpService,? extends HttpService>> decorators)	Decorates and binds the specified HttpServiceWithRoutes at multiple Routes.
final VirtualHostBuilder	service(HttpServiceWithRoutes serviceWithRoutes, Function<? super HttpService,? extends HttpService>... decorators)	Decorates and binds the specified HttpServiceWithRoutes at multiple Routes.
VirtualHostBuilder	service(Route route, HttpService service)	Binds the specified HttpService at the specified Route.
VirtualHostBuilder	service(String pathPattern, HttpService service)	Binds the specified HttpService at the specified path pattern. e.g.
VirtualHostBuilder	serviceUnder(String pathPrefix, HttpService service)	Binds the specified HttpService under the specified directory.
VirtualHostBuilder	serviceWorkerGroup(int numThreads)	Uses a newly created EventLoopGroup with the specified number of threads dedicated to the execution of services' methods.
VirtualHostBuilder	serviceWorkerGroup(EventLoopGroup serviceWorkerGroup, boolean shutdownOnStop)	Sets the EventLoopGroup dedicated to the execution of services' methods.
VirtualHostBuilder	setHeader(CharSequence name, Object value)	Sets the default HTTP header for an HttpResponse served by this VirtualHost.
VirtualHostBuilder	setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> defaultHeaders)	Sets the default HTTP headers for an HttpResponse served by this VirtualHost.
VirtualHostBuilder	successFunction(SuccessFunction successFunction)	Sets the SuccessFunction to define successful responses.
VirtualHostBuilder	tls(File keyCertChainFile, File keyFile)	Configures SSL or TLS with the specified keyCertChainFile and cleartext keyFile.
VirtualHostBuilder	tls(File keyCertChainFile, File keyFile, @Nullable String keyPassword)	Configures SSL or TLS with the specified keyCertChainFile, keyFile and keyPassword.
VirtualHostBuilder	tls(InputStream keyCertChainInputStream, InputStream keyInputStream)	Configures SSL or TLS with the specified keyCertChainInputStream and cleartext keyInputStream.
VirtualHostBuilder	tls(InputStream keyCertChainInputStream, InputStream keyInputStream, @Nullable String keyPassword)	Configures SSL or TLS of this with the specified keyCertChainInputStream, keyInputStream and keyPassword.
VirtualHostBuilder	tls(PrivateKey key, @Nullable String keyPassword, Iterable<? extends X509Certificate> keyCertChain)	Configures SSL or TLS with the specified PrivateKey, keyPassword and X509Certificate chain.
VirtualHostBuilder	tls(PrivateKey key, @Nullable String keyPassword, X509Certificate... keyCertChain)	Configures SSL or TLS with the specified PrivateKey, keyPassword and X509Certificate chain.
VirtualHostBuilder	tls(PrivateKey key, Iterable<? extends X509Certificate> keyCertChain)	Configures SSL or TLS with the specified cleartext PrivateKey and X509Certificate chain.
VirtualHostBuilder	tls(PrivateKey key, X509Certificate... keyCertChain)	Configures SSL or TLS with the specified cleartext PrivateKey and X509Certificate chain.
VirtualHostBuilder	tls(KeyManagerFactory keyManagerFactory)	Configures SSL or TLS with the specified KeyManagerFactory.
VirtualHostBuilder	tlsAllowUnsafeCiphers()	Deprecated. It's not recommended to enable this option.
VirtualHostBuilder	tlsAllowUnsafeCiphers(boolean tlsAllowUnsafeCiphers)	Deprecated. It's not recommended to enable this option.
VirtualHostBuilder	tlsCustomizer(Consumer<? super SslContextBuilder> tlsCustomizer)	Adds the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
VirtualHostBuilder	tlsEngineType(TlsEngineType tlsEngineType)	The TlsEngineType that will be used for processing TLS connections.
VirtualHostBuilder	tlsSelfSigned()	Configures SSL or TLS of this VirtualHost with an auto-generated self-signed certificate.
VirtualHostBuilder	tlsSelfSigned(boolean tlsSelfSigned)	Configures SSL or TLS of this VirtualHost with an auto-generated self-signed certificate.
VirtualHostBuilder	verboseResponses(boolean verboseResponses)	Sets whether the verbose response mode is enabled.
VirtualHostBuilder	withRoute(Consumer<? super VirtualHostServiceBindingBuilder> customizer)	Configures an HttpService of the VirtualHost with the customizer.

Methods inherited from class java.lang.Object

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

Method Details

and

public ServerBuilder and()

Returns the parent ServerBuilder.

Returns:

serverBuilder the parent ServerBuilder.

defaultHostname

public VirtualHostBuilder defaultHostname(String defaultHostname)

Sets the default hostname of this VirtualHost.

baseContextPath

public VirtualHostBuilder baseContextPath(String baseContextPath)

Sets the base context path for this VirtualHost. Services and decorators added to this VirtualHost will be prefixed by the specified baseContextPath.

hostnamePattern

@Deprecated
public VirtualHostBuilder hostnamePattern(String hostnamePattern)

Deprecated.

prefer specifying the hostnamePattern using ServerBuilder.virtualHost(String) or ServerBuilder.withVirtualHost(String, Consumer)

Sets the hostname pattern of this VirtualHost. If the hostname pattern contains a port number such *.example.com:8080, the returned virtual host will be bound to the 8080 port. Otherwise, the virtual host will allow all active ports.

Throws:

UnsupportedOperationException - if this is the default VirtualHostBuilder

tls

public VirtualHostBuilder tls(File keyCertChainFile,
 File keyFile)

Description copied from interface: TlsSetters

Configures SSL or TLS with the specified keyCertChainFile and cleartext keyFile.

Specified by:

tls in interface TlsSetters

tls

public VirtualHostBuilder tls(File keyCertChainFile,
 File keyFile,
 @Nullable
 @Nullable String keyPassword)

Description copied from interface: TlsSetters

Configures SSL or TLS with the specified keyCertChainFile, keyFile and keyPassword.

Specified by:

tls in interface TlsSetters

tls

public VirtualHostBuilder tls(InputStream keyCertChainInputStream,
 InputStream keyInputStream)

Description copied from interface: TlsSetters

Configures SSL or TLS with the specified keyCertChainInputStream and cleartext keyInputStream.

Specified by:

tls in interface TlsSetters

tls

public VirtualHostBuilder tls(InputStream keyCertChainInputStream,
 InputStream keyInputStream,
 @Nullable
 @Nullable String keyPassword)

Description copied from interface: TlsSetters

Configures SSL or TLS of this with the specified keyCertChainInputStream, keyInputStream and keyPassword.

Specified by:

tls in interface TlsSetters

tls

public VirtualHostBuilder tls(PrivateKey key,
 X509Certificate... keyCertChain)

Description copied from interface: TlsSetters

Configures SSL or TLS with the specified cleartext PrivateKey and X509Certificate chain.

Specified by:

tls in interface TlsSetters

tls

public VirtualHostBuilder tls(PrivateKey key,
 Iterable<? extends X509Certificate> keyCertChain)

Description copied from interface: TlsSetters

Configures SSL or TLS with the specified cleartext PrivateKey and X509Certificate chain.

Specified by:

tls in interface TlsSetters

tls

public VirtualHostBuilder tls(PrivateKey key,
 @Nullable
 @Nullable String keyPassword,
 X509Certificate... keyCertChain)

Description copied from interface: TlsSetters

Configures SSL or TLS with the specified PrivateKey, keyPassword and X509Certificate chain.

Specified by:

tls in interface TlsSetters

tls

public VirtualHostBuilder tls(PrivateKey key,
 @Nullable
 @Nullable String keyPassword,
 Iterable<? extends X509Certificate> keyCertChain)

Description copied from interface: TlsSetters

Configures SSL or TLS with the specified PrivateKey, keyPassword and X509Certificate chain.

Specified by:

tls in interface TlsSetters

tls

public VirtualHostBuilder tls(KeyManagerFactory keyManagerFactory)

Description copied from interface: TlsSetters

Configures SSL or TLS with the specified KeyManagerFactory.

Specified by:

tls in interface TlsSetters

tlsSelfSigned

public VirtualHostBuilder tlsSelfSigned()

Configures SSL or TLS of this VirtualHost with an auto-generated self-signed certificate. Note: You should never use this in production but only for a testing purpose.

See Also:

• tlsCustomizer(Consumer)

tlsSelfSigned

public VirtualHostBuilder tlsSelfSigned(boolean tlsSelfSigned)

Configures SSL or TLS of this VirtualHost with an auto-generated self-signed certificate. Note: You should never use this in production but only for a testing purpose.

See Also:

• tlsCustomizer(Consumer)

tlsCustomizer

public VirtualHostBuilder tlsCustomizer(Consumer<? super SslContextBuilder> tlsCustomizer)

Description copied from interface: TlsSetters

Adds the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.

Specified by:

tlsCustomizer in interface TlsSetters

tlsAllowUnsafeCiphers

@Deprecated
public VirtualHostBuilder tlsAllowUnsafeCiphers()

Deprecated.

It's not recommended to enable this option. Use it only when you have no other way to communicate with an insecure peer than this.

Allows the bad cipher suites listed in RFC7540 for TLS handshake.

Note that enabling this option increases the security risk of your connection. Use it only when you must communicate with a legacy system that does not support secure cipher suites. See Section 9.2.2, RFC7540 for more information. This option is disabled by default.

tlsAllowUnsafeCiphers

@Deprecated
public VirtualHostBuilder tlsAllowUnsafeCiphers(boolean tlsAllowUnsafeCiphers)

Deprecated.

It's not recommended to enable this option. Use it only when you have no other way to communicate with an insecure peer than this.

Allows the bad cipher suites listed in RFC7540 for TLS handshake.

Note that enabling this option increases the security risk of your connection. Use it only when you must communicate with a legacy system that does not support secure cipher suites. See Section 9.2.2, RFC7540 for more information. This option is disabled by default.

Parameters:

tlsAllowUnsafeCiphers - Whether to allow the unsafe ciphers

tlsEngineType

@UnstableApi
public VirtualHostBuilder tlsEngineType(TlsEngineType tlsEngineType)

The TlsEngineType that will be used for processing TLS connections.

contextPath

@UnstableApi
public VirtualHostContextPathServicesBuilder contextPath(String... contextPaths)

Returns a VirtualHostContextPathServicesBuilder which binds HttpServices under the specified context paths.

See Also:

• VirtualHostContextPathServicesBuilder

contextPath

@UnstableApi
public VirtualHostContextPathServicesBuilder contextPath(Iterable<String> contextPaths)

Returns a VirtualHostContextPathServicesBuilder which binds HttpServices under the specified context paths.

See Also:

• VirtualHostContextPathServicesBuilder

withRoute

public VirtualHostBuilder withRoute(Consumer<? super VirtualHostServiceBindingBuilder> customizer)

Configures an HttpService of the VirtualHost with the customizer.

route

public VirtualHostServiceBindingBuilder route()

Returns a ServiceBindingBuilder which is for binding an HttpService fluently.

routeDecorator

public VirtualHostDecoratingServiceBindingBuilder routeDecorator()

Returns a VirtualHostDecoratingServiceBindingBuilder which is for binding a decorator fluently. The specified decorator(s) is/are executed in reverse order of the insertion.

serviceUnder

public VirtualHostBuilder serviceUnder(String pathPrefix,
 HttpService service)

Binds the specified HttpService under the specified directory. If the specified HttpService is an HttpServiceWithRoutes, the pathPrefix is added to each Route of ServiceWithRoutes.routes(). For example, the serviceWithRoutes in the following code will be bound to ("/foo/bar") and ("/foo/baz"):

 > HttpServiceWithRoutes serviceWithRoutes = new HttpServiceWithRoutes() {
 >     @Override
 >     public HttpResponse serve(ServiceRequestContext ctx, HttpRequest req) { ... }
 >
 >     @Override
 >     public Set<Route> routes() {
 >         return Set.of(Route.builder().path("/bar").build(),
 >                       Route.builder().path("/baz").build());
 >     }
 > };
 >
 > Server.builder()
 >       .serviceUnder("/foo", serviceWithRoutes)
 >       .build();
 

service

public VirtualHostBuilder service(String pathPattern,
 HttpService service)

Binds the specified HttpService at the specified path pattern. e.g.

• /login (no path parameters)
• /users/{userId} (curly-brace style)
• /list/:productType/by/:ordering (colon style)
• exact:/foo/bar (exact match)
• prefix:/files (prefix match)
• glob:/~*/downloads/** (glob pattern)
• regex:^/files/(?<filePath>.*)$ (regular expression)

Throws:

IllegalArgumentException - if the specified path pattern is invalid

service

public VirtualHostBuilder service(Route route,
 HttpService service)

Binds the specified HttpService at the specified Route.

service

public VirtualHostBuilder service(HttpServiceWithRoutes serviceWithRoutes,
 Iterable<? extends Function<? super HttpService,? extends HttpService>> decorators)

Decorates and binds the specified HttpServiceWithRoutes at multiple Routes.

Parameters:

serviceWithRoutes - the HttpServiceWithRoutes.

decorators - the decorator functions, which will be applied in the order specified.

service

@SafeVarargs
public final VirtualHostBuilder service(HttpServiceWithRoutes serviceWithRoutes,
 Function<? super HttpService,? extends HttpService>... decorators)

Decorates and binds the specified HttpServiceWithRoutes at multiple Routes.

Parameters:

serviceWithRoutes - the HttpServiceWithRoutes.

decorators - the decorator functions, which will be applied in the order specified.

annotatedService

public VirtualHostBuilder annotatedService(Object service)

Binds the specified annotated service object under the path prefix "/".

annotatedService

public VirtualHostBuilder annotatedService(Object service,
 Object... exceptionHandlersAndConverters)

Binds the specified annotated service object under the path prefix "/".

Parameters:

exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions

annotatedService

public VirtualHostBuilder annotatedService(Object service,
 Function<? super HttpService,? extends HttpService> decorator,
 Object... exceptionHandlersAndConverters)

Binds the specified annotated service object under the path prefix "/".

Parameters:

exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions

annotatedService

public VirtualHostBuilder annotatedService(String pathPrefix,
 Object service)

Binds the specified annotated service object under the specified path prefix.

annotatedService

public VirtualHostBuilder annotatedService(String pathPrefix,
 Object service,
 Object... exceptionHandlersAndConverters)

Binds the specified annotated service object under the specified path prefix.

Parameters:

exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions

annotatedService

public VirtualHostBuilder annotatedService(String pathPrefix,
 Object service,
 Iterable<?> exceptionHandlersAndConverters)

Binds the specified annotated service object under the specified path prefix.

Parameters:

exceptionHandlersAndConverters - the ExceptionHandlerFunction, RequestConverterFunction and/or ResponseConverterFunction

annotatedService

public VirtualHostBuilder annotatedService(String pathPrefix,
 Object service,
 Function<? super HttpService,? extends HttpService> decorator,
 Object... exceptionHandlersAndConverters)

Binds the specified annotated service object under the specified path prefix.

Parameters:

exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions

annotatedService

public VirtualHostBuilder annotatedService(String pathPrefix,
 Object service,
 Function<? super HttpService,? extends HttpService> decorator,
 Iterable<?> exceptionHandlersAndConverters)

Binds the specified annotated service object under the specified path prefix.

Parameters:

exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions

annotatedService

public VirtualHostBuilder annotatedService(String pathPrefix,
 Object service,
 Function<? super HttpService,? extends HttpService> decorator,
 Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions,
 Iterable<? extends RequestConverterFunction> requestConverterFunctions,
 Iterable<? extends ResponseConverterFunction> responseConverterFunctions)

Binds the specified annotated service object under the specified path prefix.

Parameters:

exceptionHandlerFunctions - the ExceptionHandlerFunctions

requestConverterFunctions - the RequestConverterFunctions

responseConverterFunctions - the ResponseConverterFunctions

annotatedService

public VirtualHostAnnotatedServiceBindingBuilder annotatedService()

Returns a new instance of VirtualHostAnnotatedServiceBindingBuilder to build an annotated service fluently.

decorator

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

Decorates all HttpServices with the specified decorator. The specified decorator(s) is/are executed in reverse order of the insertion.

Parameters:

decorator - the Function that decorates HttpServices

decorator

public VirtualHostBuilder decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction)

Decorates all HttpServices with the specified DecoratingHttpServiceFunction. The specified decorator(s) is/are executed in reverse order of the insertion.

Parameters:

decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpServices

decorator

public VirtualHostBuilder decorator(String pathPattern,
 DecoratingHttpServiceFunction decoratingHttpServiceFunction)

Decorates HttpServices whose Route matches the specified pathPattern. The specified decorator(s) is/are executed in reverse order of the insertion.

Parameters:

decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpServices

decorator

public VirtualHostBuilder decorator(String pathPattern,
 Function<? super HttpService,? extends HttpService> decorator)

Decorates HttpServices whose Route matches the specified pathPattern. The specified decorator(s) is/are executed in reverse order of the insertion.

decorator

public VirtualHostBuilder decorator(Route route,
 Function<? super HttpService,? extends HttpService> decorator)

Decorates HttpServices whose Route matches the specified Route. The specified decorator(s) is/are executed in reverse order of the insertion.

Parameters:

route - the route being decorated

decorator - the Function that decorates HttpService

decorator

public VirtualHostBuilder decorator(Route route,
 DecoratingHttpServiceFunction decoratingHttpServiceFunction)

Decorates HttpServices whose Route matches the specified Route. The specified decorator(s) is/are executed in reverse order of the insertion.

Parameters:

route - the route being decorated

decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpServices

decoratorUnder

public VirtualHostBuilder decoratorUnder(String prefix,
 Function<? super HttpService,? extends HttpService> decorator)

Decorates HttpServices under the specified directory. The specified decorator(s) is/are executed in reverse order of the insertion.

decoratorUnder

public VirtualHostBuilder decoratorUnder(String prefix,
 DecoratingHttpServiceFunction decoratingHttpServiceFunction)

Decorates HttpServices under the specified directory. The specified decorator(s) is/are executed in reverse order of the insertion.

Parameters:

decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpServices

accessLogger

public VirtualHostBuilder accessLogger(Function<? super VirtualHost,? extends Logger> mapper)

Sets the access logger mapper of this VirtualHost.

accessLogger

public VirtualHostBuilder accessLogger(Logger logger)

Sets the Logger of this VirtualHost, which is used for writing access logs.

accessLogger

public VirtualHostBuilder accessLogger(String loggerName)

Sets the Logger named loggerName of this VirtualHost, which is used for writing access logs.

errorHandler

public VirtualHostBuilder errorHandler(ServiceErrorHandler errorHandler)

Adds the ServiceErrorHandler that handles exceptions thrown in this virtual host. If multiple handlers are added, the latter is composed with the former using ServiceErrorHandler.orElse(ServiceErrorHandler).

rejectedRouteHandler

public VirtualHostBuilder rejectedRouteHandler(RejectedRouteHandler handler)

Sets the RejectedRouteHandler which will be invoked when an attempt to bind an HttpService at a certain Route is rejected. If not set, the RejectedRouteHandler set via ServerBuilder.rejectedRouteHandler(RejectedRouteHandler) is used.

addHeader

@UnstableApi
public VirtualHostBuilder addHeader(CharSequence name,
 Object value)

Adds the default HTTP header for an HttpResponse served by this VirtualHost.

Note that the default header could be overridden if the same HttpHeaderNames are defined in one of the followings:

• ServiceRequestContext.additionalResponseHeaders()
• The ResponseHeaders of the HttpResponse
• ServiceConfigSetters.addHeader(CharSequence, Object) or ServiceConfigSetters.addHeader(CharSequence, Object)

addHeaders

@UnstableApi
public VirtualHostBuilder addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> defaultHeaders)

Adds the default HTTP headers for an HttpResponse served by this VirtualHost.

Note that the default headers could be overridden if the same HttpHeaderNames are defined in one of the followings:

• ServiceRequestContext.additionalResponseHeaders()
• The ResponseHeaders of the HttpResponse
• ServiceConfigSetters.addHeaders(Iterable) or ServiceConfigSetters.addHeaders(Iterable)

setHeader

@UnstableApi
public VirtualHostBuilder setHeader(CharSequence name,
 Object value)

Sets the default HTTP header for an HttpResponse served by this VirtualHost.

Note that the default header could be overridden if the same HttpHeaderNames are defined in one of the followings:

• ServiceRequestContext.additionalResponseHeaders()
• The ResponseHeaders of the HttpResponse
• ServiceConfigSetters.setHeader(CharSequence, Object) or ServiceConfigSetters.setHeader(CharSequence, Object)

setHeaders

@UnstableApi
public VirtualHostBuilder setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> defaultHeaders)

Sets the default HTTP headers for an HttpResponse served by this VirtualHost.

Note that the default headers could be overridden if the same HttpHeaderNames are defined in one of the followings:

• ServiceRequestContext.additionalResponseHeaders()
• The ResponseHeaders of the HttpResponse
• ServiceConfigSetters.setHeaders(Iterable) or ServiceConfigSetters.setHeaders(Iterable)

requestTimeout

public VirtualHostBuilder requestTimeout(Duration requestTimeout)

Sets the timeout of a request. If not set, the value set via ServerBuilder.requestTimeoutMillis(long) is used.

Parameters:

requestTimeout - the timeout. 0 disables the timeout.

defaultServiceNaming

public VirtualHostBuilder defaultServiceNaming(ServiceNaming defaultServiceNaming)

Sets the default naming rule for the name of services. If not set, the value set via ServerBuilder.defaultServiceNaming(ServiceNaming) is used.

defaultLogName

public VirtualHostBuilder defaultLogName(String defaultLogName)

Sets the default value of the RequestOnlyLog.name() property which is used when no name was set via RequestLogBuilder.name(String, String).

Parameters:

defaultLogName - the default log name.

requestTimeoutMillis

public VirtualHostBuilder requestTimeoutMillis(long requestTimeoutMillis)

Sets the timeout of a request in milliseconds. If not set, the value set via ServerBuilder.requestTimeoutMillis(long) is used.

Parameters:

requestTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.

maxRequestLength

public VirtualHostBuilder maxRequestLength(long maxRequestLength)

Sets the maximum allowed length of the content decoded at the session layer. e.g. the content length of an HTTP request. If not set, the value set via ServerBuilder.maxRequestLength(long) is used.

Parameters:

maxRequestLength - the maximum allowed length. 0 disables the length limit.

verboseResponses

public VirtualHostBuilder verboseResponses(boolean verboseResponses)

Sets whether the verbose response mode is enabled. When enabled, the server responses will contain the exception type and its full stack trace, which may be useful for debugging while potentially insecure. When disabled, the server responses will not expose such server-side details to the client. If not set, the value set via ServerBuilder.verboseResponses(boolean) is used.

accessLogWriter

public VirtualHostBuilder accessLogWriter(AccessLogWriter accessLogWriter,
 boolean shutdownOnStop)

Sets the access log writer of this VirtualHost. If not set, the AccessLogWriter set via ServerBuilder.accessLogWriter(AccessLogWriter, boolean) is used.

Parameters:

shutdownOnStop - whether to shut down the AccessLogWriter when the Server stops

blockingTaskExecutor

public VirtualHostBuilder blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor,
 boolean shutdownOnStop)

Sets the ScheduledExecutorService dedicated to the execution of blocking tasks or invocations. If not set, the common pool is used.

Parameters:

shutdownOnStop - whether to shut down the ScheduledExecutorService when the Server stops

blockingTaskExecutor

public VirtualHostBuilder blockingTaskExecutor(BlockingTaskExecutor blockingTaskExecutor,
 boolean shutdownOnStop)

Sets the BlockingTaskExecutor dedicated to the execution of blocking tasks or invocations. If not set, the common pool is used.

Parameters:

shutdownOnStop - whether to shut down the BlockingTaskExecutor when the Server stops

blockingTaskExecutor

public VirtualHostBuilder blockingTaskExecutor(int numThreads)

Uses a newly created BlockingTaskExecutor with the specified number of threads dedicated to the execution of blocking tasks or invocations. The worker EventLoopGroup will be shut down when the Server stops.

Parameters:

numThreads - the number of threads in the executor

successFunction

@UnstableApi
public VirtualHostBuilder successFunction(SuccessFunction successFunction)

Sets the SuccessFunction to define successful responses. MetricCollectingService and LoggingService use this function.

requestAutoAbortDelay

@UnstableApi
public VirtualHostBuilder requestAutoAbortDelay(Duration delay)

Sets the amount of time to wait before aborting an HttpRequest when its corresponding HttpResponse is complete. This may be useful when you want to receive additional data even after closing the response. Specify Duration.ZERO to abort the HttpRequest immediately. Any negative value will not abort the request automatically. There is no delay by default.

requestAutoAbortDelayMillis

@UnstableApi
public VirtualHostBuilder requestAutoAbortDelayMillis(long delayMillis)

Sets the amount of time in millis to wait before aborting an HttpRequest when its corresponding HttpResponse is complete. This may be useful when you want to receive additional data even after closing the response. Specify 0 to abort the HttpRequest immediately. Any negative value will not abort the request automatically. There is no delay by default.

multipartUploadsLocation

public VirtualHostBuilder multipartUploadsLocation(Path multipartUploadsLocation)

Sets the Path for storing the files uploaded from multipart/form-data requests.

Parameters:

multipartUploadsLocation - the path of the directory which stores the files.

multipartRemovalStrategy

@UnstableApi
public VirtualHostBuilder multipartRemovalStrategy(MultipartRemovalStrategy removalStrategy)

Sets the MultipartRemovalStrategy that determines when to remove temporary files created for multipart requests. If not set, MultipartRemovalStrategy.ON_RESPONSE_COMPLETION is used by default.

requestIdGenerator

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

Sets the Function which generates a RequestId. If not set, the value set via ServerBuilder.requestIdGenerator(Function) is used.

Parameters:

requestIdGenerator - the Function which generates a RequestId

See Also:

• RequestContext.id()

serviceWorkerGroup

@UnstableApi
public VirtualHostBuilder serviceWorkerGroup(EventLoopGroup serviceWorkerGroup,
 boolean shutdownOnStop)

Sets the EventLoopGroup dedicated to the execution of services' methods. If not set, the work group of the belonging channel is used.

Parameters:

shutdownOnStop - whether to shut down the EventLoopGroup when the Server stops

serviceWorkerGroup

@UnstableApi
public VirtualHostBuilder serviceWorkerGroup(int numThreads)

Uses a newly created EventLoopGroup with the specified number of threads dedicated to the execution of services' methods. The worker EventLoopGroup will be shut down when the Server stops.

Parameters:

numThreads - the number of threads in the executor

annotatedServiceExtensions

public VirtualHostBuilder annotatedServiceExtensions(Iterable<? extends RequestConverterFunction> requestConverterFunctions,
 Iterable<? extends ResponseConverterFunction> responseConverterFunctions,
 Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions)

Sets the RequestConverterFunctions, ResponseConverterFunction and ExceptionHandlerFunctions for creating an AnnotatedServiceExtensions.

Parameters:

requestConverterFunctions - the RequestConverterFunctions

responseConverterFunctions - the ResponseConverterFunctions

exceptionHandlerFunctions - the ExceptionHandlerFunctions

contextHook

@UnstableApi
public VirtualHostBuilder contextHook(Supplier<? extends AutoCloseable> contextHook)

Sets the AutoCloseable which will be called whenever this RequestContext is popped from the RequestContextStorage.

Parameters:

contextHook - the Supplier that provides the AutoCloseable