Package com.linecorp.armeria.server

Class VirtualHost

java.lang.Object

com.linecorp.armeria.server.VirtualHost

public final class VirtualHost
extends Object

A name-based virtual host. A VirtualHost contains the following information:

• the hostname pattern, as defined in the section 3.1 of RFC2818
• SslContext if TLS is enabled
• the list of available HttpServices and their Routes

See Also:

• VirtualHostBuilder

Method Summary

Modifier and Type	Method	Description
Logger	accessLogger()	Returns the Logger which is used for writing access logs of this virtual host.
AccessLogWriter	accessLogWriter()	Returns the access log writer.
BlockingTaskExecutor	blockingTaskExecutor()	Returns the blocking task executor.
String	defaultHostname()	Returns the default hostname of this virtual host.
String	defaultLogName()	Returns the default value of the RequestOnlyLog.name() property which is used when no name was set via RequestLogBuilder.name(String, String).
ServiceNaming	defaultServiceNaming()	Returns a default naming rule for the name of services.
Routed<ServiceConfig>	findServiceConfig(RoutingContext routingCtx)	Finds the HttpService whose Router matches the RoutingContext.
Routed<ServiceConfig>	findServiceConfig(RoutingContext routingCtx, boolean useFallbackService)	Finds the HttpService whose Router matches the RoutingContext.
String	hostnamePattern()	Returns the hostname pattern of this virtual host, as defined in the section 3.1 of RFC2818.
long	maxRequestLength()	Returns the maximum allowed length of the content decoded at the session layer.
MultipartRemovalStrategy	multipartRemovalStrategy()	Returns the MultipartRemovalStrategy that specifies when to remove the temporary files created for multipart requests.
Path	multipartUploadsLocation()	Returns the Path that is used to store the files uploaded through a multipart/form-data request.
int	port()	Returns the port of this virtual host.
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.
Server	server()	Returns the Server where this VirtualHost belongs to.
List<ServiceConfig>	serviceConfigs()	Returns the information about the HttpServices bound to this virtual host.
EventLoopGroup	serviceWorkerGroup()	Returns the service EventLoopGroup.
boolean	shutdownAccessLogWriterOnStop()	Deprecated. This method is not used anymore.
boolean	shutdownBlockingTaskExecutorOnStop()	Deprecated. This method is not used anymore.
@Nullable SslContext	sslContext()	Returns the SslContext of this virtual host.
SuccessFunction	successFunction()	Returns the SuccessFunction that determines whether a request was handled successfully or not.
@Nullable TlsEngineType	tlsEngineType()	Returns the TlsEngineType of this virtual host.
String	toString()
boolean	verboseResponses()	Returns whether the verbose response mode is enabled.

Methods inherited from class java.lang.Object

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

Method Details

server

public Server server()

Returns the Server where this VirtualHost belongs to.

defaultHostname

public String defaultHostname()

Returns the default hostname of this virtual host.

hostnamePattern

public String hostnamePattern()

Returns the hostname pattern of this virtual host, as defined in the section 3.1 of RFC2818.

port

public int port()

Returns the port of this virtual host. -1 means that no port number is specified.

sslContext

@Nullable
public @Nullable SslContext sslContext()

Returns the SslContext of this virtual host.

tlsEngineType

@Nullable
@UnstableApi
public @Nullable TlsEngineType tlsEngineType()

Returns the TlsEngineType of this virtual host.

serviceConfigs

public List<ServiceConfig> serviceConfigs()

Returns the information about the HttpServices bound to this virtual host.

accessLogger

public Logger accessLogger()

Returns the Logger which is used for writing access logs of this virtual host.

defaultServiceNaming

public ServiceNaming defaultServiceNaming()

Returns a default naming rule for the name of services.

See Also:

• ServiceConfig.defaultServiceNaming()

defaultLogName

public String defaultLogName()

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

requestTimeoutMillis

public long requestTimeoutMillis()

Returns the timeout of a request.

See Also:

• ServiceConfig.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:

• ServiceConfig.maxRequestLength()

verboseResponses

public boolean verboseResponses()

Returns 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.

See Also:

• ServiceConfig.verboseResponses()

accessLogWriter

public AccessLogWriter accessLogWriter()

Returns the access log writer.

See Also:

• ServiceConfig.accessLogWriter()

shutdownAccessLogWriterOnStop

@Deprecated
public boolean shutdownAccessLogWriterOnStop()

Deprecated.

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

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

blockingTaskExecutor

public BlockingTaskExecutor blockingTaskExecutor()

Returns the blocking task executor.

See Also:

• ServiceConfig.blockingTaskExecutor()

shutdownBlockingTaskExecutorOnStop

@Deprecated
public boolean shutdownBlockingTaskExecutorOnStop()

Deprecated.

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

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

serviceWorkerGroup

@UnstableApi
public EventLoopGroup serviceWorkerGroup()

Returns the service EventLoopGroup.

See Also:

• ServiceConfig.serviceWorkerGroup()

successFunction

public SuccessFunction successFunction()

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

requestIdGenerator

public Function<RoutingContext,RequestId> requestIdGenerator()

Returns the Function that generates a RequestId.

findServiceConfig

public Routed<ServiceConfig> findServiceConfig(RoutingContext routingCtx)

Finds the HttpService whose Router matches the RoutingContext.

Parameters:

routingCtx - a context to find the HttpService.

Returns:

the ServiceConfig wrapped by a Routed if there's a match. Routed.empty() if there's no match.

findServiceConfig

public Routed<ServiceConfig> findServiceConfig(RoutingContext routingCtx,
 boolean useFallbackService)

Finds the HttpService whose Router matches the RoutingContext.

Parameters:

routingCtx - a context to find the HttpService.

useFallbackService - whether to use the fallback HttpService when there is no match. If true, the returned Routed will always be present.

Returns:

the ServiceConfig wrapped by a Routed if there's a match. The fallback ServiceConfig wrapped by Routed if there's no match and useFallbackService is true. Routed.empty() if there's no match and useFallbackService is false.

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 the files uploaded through a multipart/form-data request.

multipartRemovalStrategy

@UnstableApi
public MultipartRemovalStrategy multipartRemovalStrategy()

Returns the MultipartRemovalStrategy that specifies when to remove the temporary files created for multipart requests.

toString

public String toString()

Overrides:

toString in class Object