Package com.linecorp.armeria.server

Class ServiceConfig

java.lang.Object

com.linecorp.armeria.server.ServiceConfig

public final class ServiceConfig
extends Object

An HttpService configuration.

See Also:

• ServerConfig.serviceConfigs()
• VirtualHost.serviceConfigs()

Method Summary

Modifier and Type	Method	Description
AccessLogWriter	accessLogWriter()	Returns the access log writer.
BlockingTaskExecutor	blockingTaskExecutor()	Returns the BlockingTaskExecutor dedicated to the execution of blocking tasks or invocations within this route.
Supplier<AutoCloseable>	contextHook()	Returns the Supplier which provides an AutoCloseable and will be called whenever this RequestContext is popped from the RequestContextStorage.
HttpHeaders	defaultHeaders()	Returns the default headers for an HttpResponse served by the service().
@Nullable String	defaultLogName()	Returns the default value of the RequestOnlyLog.name() property which is used when no name was set via RequestLogBuilder.name(String, String).
@Nullable String	defaultServiceName()	Deprecated. Use defaultServiceNaming() instead.
ServiceNaming	defaultServiceNaming()	Returns a default naming rule for the name of services.
Route	mappedRoute()	Returns the Route whose prefix is removed when an HttpServiceWithRoutes is added via ServerBuilder.serviceUnder(String, HttpService).
long	maxRequestLength()	Returns the maximum allowed length of the content decoded at the session layer.
Path	multipartUploadsLocation()	Returns the Path that is used to store uploaded file through multipart/form-data.
long	requestAutoAbortDelayMillis()	Returns the amount of time to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.
Function<RoutingContext,RequestId>	requestIdGenerator()	Returns the Function that generates a RequestId.
long	requestTimeoutMillis()	Returns the timeout of a request.
Route	route()	Returns the Route of the service().
Server	server()	Returns the Server the service() belongs to.
HttpService	service()	Returns the HttpService.
EventLoopGroup	serviceWorkerGroup()	Returns the EventLoopGroup dedicated to the execution of services' methods.
boolean	shutdownAccessLogWriterOnStop()	Deprecated. This method is not used anymore.
boolean	shutdownBlockingTaskExecutorOnStop()	Deprecated. This method is not used anymore.
SuccessFunction	successFunction()	Returns the SuccessFunction that determines whether a request was handled successfully or not.
String	toString()
Set<TransientServiceOption>	transientServiceOptions()	Returns the Set of TransientServiceOptions that are enabled for the service().
boolean	verboseResponses()	Returns whether the verbose response mode is enabled.
VirtualHost	virtualHost()	Returns the VirtualHost the service() belongs to.

Methods inherited from class java.lang.Object

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

Method Details

virtualHost

public VirtualHost virtualHost()

Returns the VirtualHost the service() belongs to.

server

public Server server()

Returns the Server the service() belongs to.

route

public Route route()

Returns the Route of the service().

mappedRoute

public Route mappedRoute()

Returns the Route whose prefix is removed when an HttpServiceWithRoutes is added via ServerBuilder.serviceUnder(String, HttpService). For example, in the following code, the path of the mappedRoute() will be ("/bar") whereas the path of the route() will be ("/foo/bar"):

 > 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());
 >     }
 > };
 >
 > Server.builder()
 >       .serviceUnder("/foo", serviceWithRoutes)
 >       .build();
 

If the service is not an HttpServiceWithRoutes, the Route is the same as route().

service

public HttpService service()

Returns the HttpService.

defaultServiceName

@Nullable
@Deprecated
public @Nullable String defaultServiceName()

Deprecated.

Use defaultServiceNaming() instead.

Returns the default value of the RequestOnlyLog.serviceName() property which is used when no service name was set via RequestLogBuilder.name(String, String). If null, one of the following values will be used instead:

• gRPC - a service name (e.g, com.foo.GrpcService)
• Thrift - a service type (e.g, com.foo.ThriftService$AsyncIface or com.foo.ThriftService$Iface)
• HttpService and annotated service - an innermost class name

defaultServiceNaming

public ServiceNaming defaultServiceNaming()

Returns a default naming rule for the name of services.

See Also:

• VirtualHost.defaultServiceNaming()

defaultLogName

@Nullable
public @Nullable String defaultLogName()

Returns the default value of the RequestOnlyLog.name() property which is used when no name was set via RequestLogBuilder.name(String, String). If null, one of the following values will be used instead:

• gRPC - A capitalized method name defined in io.grpc.MethodDescriptor (e.g, GetItems)
• Thrift and annotated service - a method name (e.g, getItems)
• HttpService - an HTTP method name

requestTimeoutMillis

public long requestTimeoutMillis()

Returns the timeout of a request.

See Also:

• VirtualHost.requestTimeoutMillis()

maxRequestLength

public long maxRequestLength()

Returns the maximum allowed length of the content decoded at the session layer. e.g. the content length of an HTTP request.

See Also:

• VirtualHost.maxRequestLength()

verboseResponses

public boolean verboseResponses()

Returns whether the verbose response mode is enabled. When enabled, the service response will contain the exception type and its full stack trace, which may be useful for debugging while potentially insecure. When disabled, the service response will not expose such server-side details to the client.

See Also:

• VirtualHost.verboseResponses()

accessLogWriter

public AccessLogWriter accessLogWriter()

Returns the access log writer.

See Also:

• VirtualHost.accessLogWriter()

shutdownAccessLogWriterOnStop

@Deprecated
public boolean shutdownAccessLogWriterOnStop()

Deprecated.

This method is not used anymore. The AccessLogWriter is shut down if the shutdownOnStop of ServiceBindingBuilder.accessLogWriter(AccessLogWriter, boolean) is set to true.

Tells whether the AccessLogWriter is shut down when the Server stops.

transientServiceOptions

public Set<TransientServiceOption> transientServiceOptions()

Returns the Set of TransientServiceOptions that are enabled for the service(). This method always returns TransientServiceOption.allOf() for a non-TransientService because only a TransientService can opt in and out using TransientServiceBuilder.transientServiceOptions(TransientServiceOption...).

blockingTaskExecutor

public BlockingTaskExecutor blockingTaskExecutor()

Returns the BlockingTaskExecutor dedicated to the execution of blocking tasks or invocations within this route. Note that the BlockingTaskExecutor returned by this method does not set the ServiceRequestContext when executing a submitted task. Use ServiceRequestContext.blockingTaskExecutor() if possible.

shutdownBlockingTaskExecutorOnStop

@Deprecated
public boolean shutdownBlockingTaskExecutorOnStop()

Deprecated.

This method is not used anymore. The blockingTaskExecutor is shut down if the shutdownOnStop of ServiceBindingBuilder.blockingTaskExecutor(ScheduledExecutorService, boolean) is set to true.

Returns whether the blocking task Executor is shut down when the Server stops.

successFunction

public SuccessFunction successFunction()

Returns the SuccessFunction that determines whether a request was handled successfully or not.

requestAutoAbortDelayMillis

public long requestAutoAbortDelayMillis()

Returns the amount of time to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.

multipartUploadsLocation

public Path multipartUploadsLocation()

Returns the Path that is used to store uploaded file through multipart/form-data.

requestIdGenerator

public Function<RoutingContext,RequestId> requestIdGenerator()

Returns the Function that generates a RequestId.

contextHook

@UnstableApi
public Supplier<AutoCloseable> contextHook()

Returns the Supplier which provides an AutoCloseable and will be called whenever this RequestContext is popped from the RequestContextStorage.

serviceWorkerGroup

@UnstableApi
public EventLoopGroup serviceWorkerGroup()

Returns the EventLoopGroup dedicated to the execution of services' methods.

defaultHeaders

@UnstableApi
public HttpHeaders defaultHeaders()

Returns the default headers for an HttpResponse served by the service().

toString

public String toString()

Overrides:

toString in class Object