Package com.linecorp.armeria.server

Class VirtualHostContextPathAnnotatedServiceConfigSetters

java.lang.Object

com.linecorp.armeria.server.VirtualHostContextPathAnnotatedServiceConfigSetters

@UnstableApi
public final class VirtualHostContextPathAnnotatedServiceConfigSetters
extends Object

A VirtualHostContextPathAnnotatedServiceConfigSetters builder which configures an AnnotatedService under a set of context paths.

Method Summary

Modifier and Type	Method	Description
VirtualHostContextPathAnnotatedServiceConfigSetters	accessLogFormat(String accessLogFormat)
VirtualHostContextPathAnnotatedServiceConfigSetters	accessLogWriter(AccessLogWriter accessLogWriter, boolean shutdownOnStop)
VirtualHostContextPathAnnotatedServiceConfigSetters	addHeader(CharSequence name, Object value)
VirtualHostContextPathAnnotatedServiceConfigSetters	addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> defaultHeaders)
VirtualHostContextPathAnnotatedServiceConfigSetters	blockingTaskExecutor(int numThreads)
VirtualHostContextPathAnnotatedServiceConfigSetters	blockingTaskExecutor(BlockingTaskExecutor blockingTaskExecutor, boolean shutdownOnStop)
VirtualHostContextPathAnnotatedServiceConfigSetters	blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor, boolean shutdownOnStop)
VirtualHostContextPathServicesBuilder	build(Object service)	Registers the given service to VirtualHostContextPathServicesBuilder and returns the parent object.
com.linecorp.armeria.server.AbstractAnnotatedServiceConfigSetters	contextHook(Supplier<? extends AutoCloseable> contextHook)
VirtualHostContextPathAnnotatedServiceConfigSetters	decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction)
VirtualHostContextPathAnnotatedServiceConfigSetters	decorator(Function<? super HttpService,? extends HttpService> decorator)
VirtualHostContextPathAnnotatedServiceConfigSetters	decorators(Iterable<? extends Function<? super HttpService,? extends HttpService>> decorators)
final VirtualHostContextPathAnnotatedServiceConfigSetters	decorators(Function<? super HttpService,? extends HttpService>... decorators)
VirtualHostContextPathAnnotatedServiceConfigSetters	defaultLogName(String defaultLogName)
VirtualHostContextPathAnnotatedServiceConfigSetters	defaultServiceName(String defaultServiceName)
VirtualHostContextPathAnnotatedServiceConfigSetters	defaultServiceNaming(ServiceNaming defaultServiceNaming)
VirtualHostContextPathAnnotatedServiceConfigSetters	errorHandler(ServiceErrorHandler serviceErrorHandler)
VirtualHostContextPathAnnotatedServiceConfigSetters	exceptionHandlers(ExceptionHandlerFunction... exceptionHandlerFunctions)
VirtualHostContextPathAnnotatedServiceConfigSetters	exceptionHandlers(Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions)
VirtualHostContextPathAnnotatedServiceConfigSetters	maxRequestLength(long maxRequestLength)
VirtualHostContextPathAnnotatedServiceConfigSetters	multipartUploadsLocation(Path multipartUploadsLocation)
VirtualHostContextPathAnnotatedServiceConfigSetters	pathPrefix(String pathPrefix)
VirtualHostContextPathAnnotatedServiceConfigSetters	queryDelimiter(String delimiter)	Sets the delimiter for a query parameter value.
VirtualHostContextPathAnnotatedServiceConfigSetters	requestAutoAbortDelay(Duration delay)
VirtualHostContextPathAnnotatedServiceConfigSetters	requestAutoAbortDelayMillis(long delayMillis)
VirtualHostContextPathAnnotatedServiceConfigSetters	requestConverters(RequestConverterFunction... requestConverterFunctions)
VirtualHostContextPathAnnotatedServiceConfigSetters	requestConverters(Iterable<? extends RequestConverterFunction> requestConverterFunctions)
VirtualHostContextPathAnnotatedServiceConfigSetters	requestIdGenerator(Function<? super RoutingContext,? extends RequestId> requestIdGenerator)
VirtualHostContextPathAnnotatedServiceConfigSetters	requestTimeout(Duration requestTimeout)
VirtualHostContextPathAnnotatedServiceConfigSetters	requestTimeoutMillis(long requestTimeoutMillis)
VirtualHostContextPathAnnotatedServiceConfigSetters	responseConverters(ResponseConverterFunction... responseConverterFunctions)
VirtualHostContextPathAnnotatedServiceConfigSetters	responseConverters(Iterable<? extends ResponseConverterFunction> responseConverterFunctions)
VirtualHostContextPathAnnotatedServiceConfigSetters	serviceWorkerGroup(int numThreads)
VirtualHostContextPathAnnotatedServiceConfigSetters	serviceWorkerGroup(EventLoopGroup serviceWorkerGroup, boolean shutdownOnStop)
VirtualHostContextPathAnnotatedServiceConfigSetters	setHeader(CharSequence name, Object value)
VirtualHostContextPathAnnotatedServiceConfigSetters	setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> defaultHeaders)
VirtualHostContextPathAnnotatedServiceConfigSetters	successFunction(SuccessFunction successFunction)
VirtualHostContextPathAnnotatedServiceConfigSetters	useBlockingTaskExecutor(boolean useBlockingTaskExecutor)
VirtualHostContextPathAnnotatedServiceConfigSetters	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(Object service)

Registers the given service to VirtualHostContextPathServicesBuilder and returns the parent object.

Parameters:

service - annotated service object to handle incoming requests matching path prefix, which can be configured through AnnotatedServiceBindingBuilder.pathPrefix(String). If path prefix is not set then this service is registered to handle requests matching /

pathPrefix

public VirtualHostContextPathAnnotatedServiceConfigSetters pathPrefix(String pathPrefix)

exceptionHandlers

public VirtualHostContextPathAnnotatedServiceConfigSetters exceptionHandlers(ExceptionHandlerFunction... exceptionHandlerFunctions)

exceptionHandlers

public VirtualHostContextPathAnnotatedServiceConfigSetters exceptionHandlers(Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions)

responseConverters

public VirtualHostContextPathAnnotatedServiceConfigSetters responseConverters(ResponseConverterFunction... responseConverterFunctions)

responseConverters

public VirtualHostContextPathAnnotatedServiceConfigSetters responseConverters(Iterable<? extends ResponseConverterFunction> responseConverterFunctions)

requestConverters

public VirtualHostContextPathAnnotatedServiceConfigSetters requestConverters(RequestConverterFunction... requestConverterFunctions)

requestConverters

public VirtualHostContextPathAnnotatedServiceConfigSetters requestConverters(Iterable<? extends RequestConverterFunction> requestConverterFunctions)

useBlockingTaskExecutor

public VirtualHostContextPathAnnotatedServiceConfigSetters useBlockingTaskExecutor(boolean useBlockingTaskExecutor)

queryDelimiter

public VirtualHostContextPathAnnotatedServiceConfigSetters queryDelimiter(String delimiter)

Sets the delimiter for a query parameter value. Multiple values delimited by the specified delimiter will be automatically split into a list of values.

It is disabled by default.

Note that this delimiter works only when the resolve target class type is collection and the number of values of the query parameter is one. For example with the query delimiter ",":

• ?query=a,b,c will be resolved to "a", "b" and "c"
• ?query=a,b,c&query=d,e,f will be resolved to "a,b,c" and "d,e,f"

requestTimeout

public VirtualHostContextPathAnnotatedServiceConfigSetters requestTimeout(Duration requestTimeout)

requestTimeoutMillis

public VirtualHostContextPathAnnotatedServiceConfigSetters requestTimeoutMillis(long requestTimeoutMillis)

maxRequestLength

public VirtualHostContextPathAnnotatedServiceConfigSetters maxRequestLength(long maxRequestLength)

verboseResponses

public VirtualHostContextPathAnnotatedServiceConfigSetters verboseResponses(boolean verboseResponses)

accessLogFormat

public VirtualHostContextPathAnnotatedServiceConfigSetters accessLogFormat(String accessLogFormat)

accessLogWriter

public VirtualHostContextPathAnnotatedServiceConfigSetters accessLogWriter(AccessLogWriter accessLogWriter,
 boolean shutdownOnStop)

decorator

public VirtualHostContextPathAnnotatedServiceConfigSetters decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction)

decorator

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

decorators

@SafeVarargs
public final VirtualHostContextPathAnnotatedServiceConfigSetters decorators(Function<? super HttpService,? extends HttpService>... decorators)

decorators

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

defaultServiceName

public VirtualHostContextPathAnnotatedServiceConfigSetters defaultServiceName(String defaultServiceName)

defaultServiceNaming

public VirtualHostContextPathAnnotatedServiceConfigSetters defaultServiceNaming(ServiceNaming defaultServiceNaming)

defaultLogName

public VirtualHostContextPathAnnotatedServiceConfigSetters defaultLogName(String defaultLogName)

blockingTaskExecutor

public VirtualHostContextPathAnnotatedServiceConfigSetters blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor,
 boolean shutdownOnStop)

blockingTaskExecutor

public VirtualHostContextPathAnnotatedServiceConfigSetters blockingTaskExecutor(BlockingTaskExecutor blockingTaskExecutor,
 boolean shutdownOnStop)

blockingTaskExecutor

public VirtualHostContextPathAnnotatedServiceConfigSetters blockingTaskExecutor(int numThreads)

successFunction

public VirtualHostContextPathAnnotatedServiceConfigSetters successFunction(SuccessFunction successFunction)

requestAutoAbortDelay

public VirtualHostContextPathAnnotatedServiceConfigSetters requestAutoAbortDelay(Duration delay)

requestAutoAbortDelayMillis

public VirtualHostContextPathAnnotatedServiceConfigSetters requestAutoAbortDelayMillis(long delayMillis)

serviceWorkerGroup

public VirtualHostContextPathAnnotatedServiceConfigSetters serviceWorkerGroup(EventLoopGroup serviceWorkerGroup,
 boolean shutdownOnStop)

serviceWorkerGroup

public VirtualHostContextPathAnnotatedServiceConfigSetters serviceWorkerGroup(int numThreads)

multipartUploadsLocation

public VirtualHostContextPathAnnotatedServiceConfigSetters multipartUploadsLocation(Path multipartUploadsLocation)

requestIdGenerator

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

addHeader

public VirtualHostContextPathAnnotatedServiceConfigSetters addHeader(CharSequence name,
 Object value)

addHeaders

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

setHeader

public VirtualHostContextPathAnnotatedServiceConfigSetters setHeader(CharSequence name,
 Object value)

setHeaders

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

errorHandler

public VirtualHostContextPathAnnotatedServiceConfigSetters errorHandler(ServiceErrorHandler serviceErrorHandler)

contextHook

public com.linecorp.armeria.server.AbstractAnnotatedServiceConfigSetters contextHook(Supplier<? extends AutoCloseable> contextHook)