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.
`String`	`defaultHostname()`	Returns the default hostname of this virtual host.
`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.
`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 `HttpService`s bound to this virtual host.
`boolean`	`shutdownAccessLogWriterOnStop()`	Tells whether the `AccessLogWriter` is shut down when the `Server` stops.
`SslContext`	`sslContext()`	Returns the `SslContext` 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.
- sslContext
  
  @Nullable public SslContext sslContext()
  
  Returns the SslContext 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.
- 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
  
  public boolean shutdownAccessLogWriterOnStop()
  
  Tells whether the AccessLogWriter is shut down when the Server stops.
  
  See Also:
  
  ServiceConfig.shutdownAccessLogWriterOnStop()
- 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. Routed.empty() if there's no match.
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object

Class VirtualHost

Method Summary

Methods inherited from class java.lang.Object

Method Details