Package com.linecorp.armeria.server

Class ContextPathAnnotatedServiceConfigSetters

java.lang.Object

com.linecorp.armeria.server.ContextPathAnnotatedServiceConfigSetters

@UnstableApi
public final class ContextPathAnnotatedServiceConfigSetters
extends Object

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

Method Summary

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

Registers the given service and returns the parent object.

Parameters:

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

pathPrefix

public ContextPathAnnotatedServiceConfigSetters pathPrefix(String pathPrefix)

exceptionHandlers

public ContextPathAnnotatedServiceConfigSetters exceptionHandlers(ExceptionHandlerFunction... exceptionHandlerFunctions)

exceptionHandlers

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

responseConverters

public ContextPathAnnotatedServiceConfigSetters responseConverters(ResponseConverterFunction... responseConverterFunctions)

responseConverters

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

requestConverters

public ContextPathAnnotatedServiceConfigSetters requestConverters(RequestConverterFunction... requestConverterFunctions)

requestConverters

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

useBlockingTaskExecutor

public ContextPathAnnotatedServiceConfigSetters useBlockingTaskExecutor(boolean useBlockingTaskExecutor)

queryDelimiter

@UnstableApi
public ContextPathAnnotatedServiceConfigSetters 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"

decorator

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

decorators

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

decorators

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

requestTimeout

public ContextPathAnnotatedServiceConfigSetters requestTimeout(Duration requestTimeout)

requestTimeoutMillis

public ContextPathAnnotatedServiceConfigSetters requestTimeoutMillis(long requestTimeoutMillis)

maxRequestLength

public ContextPathAnnotatedServiceConfigSetters maxRequestLength(long maxRequestLength)

verboseResponses

public ContextPathAnnotatedServiceConfigSetters verboseResponses(boolean verboseResponses)

accessLogFormat

public ContextPathAnnotatedServiceConfigSetters accessLogFormat(String accessLogFormat)

accessLogWriter

public ContextPathAnnotatedServiceConfigSetters accessLogWriter(AccessLogWriter accessLogWriter,
 boolean shutdownOnStop)

defaultServiceName

public ContextPathAnnotatedServiceConfigSetters defaultServiceName(String defaultServiceName)

defaultServiceNaming

public ContextPathAnnotatedServiceConfigSetters defaultServiceNaming(ServiceNaming defaultServiceNaming)

defaultLogName

public ContextPathAnnotatedServiceConfigSetters defaultLogName(String defaultLogName)

blockingTaskExecutor

public ContextPathAnnotatedServiceConfigSetters blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor,
 boolean shutdownOnStop)

blockingTaskExecutor

public ContextPathAnnotatedServiceConfigSetters blockingTaskExecutor(BlockingTaskExecutor blockingTaskExecutor,
 boolean shutdownOnStop)

blockingTaskExecutor

public ContextPathAnnotatedServiceConfigSetters blockingTaskExecutor(int numThreads)

successFunction

public ContextPathAnnotatedServiceConfigSetters successFunction(SuccessFunction successFunction)

requestAutoAbortDelay

public ContextPathAnnotatedServiceConfigSetters requestAutoAbortDelay(Duration delay)

requestAutoAbortDelayMillis

public ContextPathAnnotatedServiceConfigSetters requestAutoAbortDelayMillis(long delayMillis)

multipartUploadsLocation

public ContextPathAnnotatedServiceConfigSetters multipartUploadsLocation(Path multipartUploadsLocation)

multipartRemovalStrategy

@UnstableApi
public ContextPathAnnotatedServiceConfigSetters multipartRemovalStrategy(MultipartRemovalStrategy removalStrategy)

serviceWorkerGroup

public ContextPathAnnotatedServiceConfigSetters serviceWorkerGroup(EventLoopGroup serviceWorkerGroup,
 boolean shutdownOnStop)

serviceWorkerGroup

public ContextPathAnnotatedServiceConfigSetters serviceWorkerGroup(int numThreads)

requestIdGenerator

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

addHeader

public ContextPathAnnotatedServiceConfigSetters addHeader(CharSequence name,
 Object value)

addHeaders

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

setHeader

public ContextPathAnnotatedServiceConfigSetters setHeader(CharSequence name,
 Object value)

setHeaders

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

errorHandler

public ContextPathAnnotatedServiceConfigSetters errorHandler(ServiceErrorHandler serviceErrorHandler)

contextHook

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

decorator

default ContextPathAnnotatedServiceConfigSetters decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction)

Decorates an HttpService with the specified decorator.

Parameters:

decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpServices