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 Services and their PathMappings

See Also:

VirtualHostBuilder

Method Summary

Modifier and Type	Method and Description
String	defaultHostname() Returns the default hostname of this virtual host.
PathMapped<ServiceConfig>	findServiceConfig(PathMappingContext mappingCtx) Finds the Service whose Router matches the PathMappingContext.
String	hostnamePattern() Returns the hostname pattern of this virtual host, as defined in the section 3.1 of RFC2818.
MediaTypeSet	producibleMediaTypes() Returns MediaTypeSet that consists of media types producible by this virtual host.
Server	server() Returns the Server where this VirtualHost belongs to.
List<ServiceConfig>	serviceConfigs() Returns the information about the Services bound to this virtual host.
SslContext	sslContext() Returns the SslContext of this virtual host.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

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 Services bound to this virtual host.

producibleMediaTypes

public MediaTypeSet producibleMediaTypes()

Returns MediaTypeSet that consists of media types producible by this virtual host.

findServiceConfig

public PathMapped<ServiceConfig> findServiceConfig(PathMappingContext mappingCtx)

Finds the Service whose Router matches the PathMappingContext.

Parameters:

mappingCtx - a context to find the Service.

Returns:

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

toString

public String toString()

Overrides:

toString in class Object