com.linecorp.armeria.server

Class VirtualHostBuilder

java.lang.Object

com.linecorp.armeria.server.VirtualHostBuilder

public class VirtualHostBuilder
extends Object

Builds a new VirtualHost.

Example

 VirtualHostBuilder vhb = new VirtualHostBuilder("*.example.com");
 vhb.service("/foo", new FooService())
    .serviceUnder("/bar/", new BarService())
    .service(PathMapping.ofRegex("^/baz/.*", new BazService());

 VirtualHost vh = vhb.build();
 

See Also:

PathMapping

Constructor Summary

Constructors

Constructor and Description
VirtualHostBuilder() Creates a new VirtualHostBuilder whose hostname pattern is "*" (match-all).
VirtualHostBuilder(String hostnamePattern) Creates a new VirtualHostBuilder with the specified hostname pattern.
VirtualHostBuilder(String defaultHostname, String hostnamePattern) Creates a new VirtualHostBuilder with the default host name and the specified hostname pattern.

Method Summary

Modifier and Type	Method and Description
B	annotatedService(Object service) Binds the specified annotated service object under the path prefix "/".
B	annotatedService(Object service, Function<Service<HttpRequest,HttpResponse>,? extends Service<HttpRequest,HttpResponse>> decorator, Object... exceptionHandlersAndConverters) Binds the specified annotated service object under the path prefix "/".
B	annotatedService(Object service, Object... exceptionHandlersAndConverters) Binds the specified annotated service object under the path prefix "/".
B	annotatedService(String pathPrefix, Object service) Binds the specified annotated service object under the specified path prefix.
B	annotatedService(String pathPrefix, Object service, Function<Service<HttpRequest,HttpResponse>,? extends Service<HttpRequest,HttpResponse>> decorator, Iterable<?> exceptionHandlersAndConverters) Binds the specified annotated service object under the specified path prefix.
B	annotatedService(String pathPrefix, Object service, Function<Service<HttpRequest,HttpResponse>,? extends Service<HttpRequest,HttpResponse>> decorator, Object... exceptionHandlersAndConverters) Binds the specified annotated service object under the specified path prefix.
B	annotatedService(String pathPrefix, Object service, Object... exceptionHandlersAndConverters) Binds the specified annotated service object under the specified path prefix.
VirtualHost	build() Returns a newly-created VirtualHost based on the properties of this builder and the services added to this builder.
<T extends Service<HttpRequest,HttpResponse>,R extends Service<HttpRequest,HttpResponse>> B	decorator(Function<T,R> decorator) Decorates all Services with the specified decorator.
B	service(PathMapping pathMapping, Service<HttpRequest,HttpResponse> service) Binds the specified Service at the specified PathMapping.
B	service(PathMapping pathMapping, Service<HttpRequest,HttpResponse> service, String loggerName) Deprecated. Use a logging framework integration such as RequestContextExportingAppender in armeria-logback.
B	service(String pathPattern, Service<HttpRequest,HttpResponse> service) Binds the specified Service at the specified path pattern. e.g.
<T extends ServiceWithPathMappings<HttpRequest,HttpResponse>> B	service(T serviceWithPathMappings) Binds the specified ServiceWithPathMappings at multiple PathMappings.
<T extends ServiceWithPathMappings<HttpRequest,HttpResponse>,R extends Service<HttpRequest,HttpResponse>> B	service(T serviceWithPathMappings, Function<T,R> decorator) Decorates and binds the specified ServiceWithPathMappings at multiple PathMappings.
B	serviceAt(String pathPattern, Service<HttpRequest,HttpResponse> service) Deprecated. Use service(String, Service) instead.
B	serviceUnder(String pathPrefix, Service<HttpRequest,HttpResponse> service) Binds the specified Service under the specified directory.
B	sslContext(SessionProtocol protocol, File keyCertChainFile, File keyFile) Deprecated. Use tls(File, File).
B	sslContext(SessionProtocol protocol, File keyCertChainFile, File keyFile, String keyPassword) Deprecated. Use tls(File, File, String).
B	sslContext(SslContext sslContext) Deprecated. Use tls(SslContext).
B	tls(File keyCertChainFile, File keyFile) Configures SSL or TLS of this VirtualHost with the specified keyCertChainFile and cleartext keyFile.
B	tls(File keyCertChainFile, File keyFile, String keyPassword) Configures SSL or TLS of this VirtualHost with the specified keyCertChainFile, keyFile and keyPassword.
B	tls(SslContext sslContext) Configures SSL or TLS of this VirtualHost with the specified SslContext.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualHostBuilder

public VirtualHostBuilder()

Creates a new VirtualHostBuilder whose hostname pattern is "*" (match-all).

VirtualHostBuilder

public VirtualHostBuilder(String hostnamePattern)

Creates a new VirtualHostBuilder with the specified hostname pattern.

VirtualHostBuilder

public VirtualHostBuilder(String defaultHostname,
                          String hostnamePattern)

Creates a new VirtualHostBuilder with the default host name and the specified hostname pattern.

Method Detail

build

public VirtualHost build()

Returns a newly-created VirtualHost based on the properties of this builder and the services added to this builder.

tls

public B tls(SslContext sslContext)

Configures SSL or TLS of this VirtualHost with the specified SslContext.

tls

public B tls(File keyCertChainFile,
             File keyFile)
      throws SSLException

Configures SSL or TLS of this VirtualHost with the specified keyCertChainFile and cleartext keyFile.

Throws:

SSLException

tls

public B tls(File keyCertChainFile,
             File keyFile,
             @Nullable
             String keyPassword)
      throws SSLException

Configures SSL or TLS of this VirtualHost with the specified keyCertChainFile, keyFile and keyPassword.

Throws:

SSLException

sslContext

@Deprecated
public B sslContext(SslContext sslContext)

Deprecated. Use tls(SslContext).

Sets the SslContext of this VirtualHost.

sslContext

@Deprecated
public B sslContext(SessionProtocol protocol,
                                File keyCertChainFile,
                                File keyFile)
                         throws SSLException

Deprecated. Use tls(File, File).

Sets the SslContext of this VirtualHost from the specified SessionProtocol, keyCertChainFile and cleartext keyFile.

Throws:

SSLException

sslContext

@Deprecated
public B sslContext(SessionProtocol protocol,
                                File keyCertChainFile,
                                File keyFile,
                                @Nullable
                                String keyPassword)
                         throws SSLException

Deprecated. Use tls(File, File, String).

Sets the SslContext of this VirtualHost from the specified SessionProtocol, keyCertChainFile, keyFile and keyPassword.

Throws:

SSLException

serviceAt

@Deprecated
public B serviceAt(String pathPattern,
                               Service<HttpRequest,HttpResponse> service)

Deprecated. Use service(String, Service) instead.

Binds the specified Service at the specified path pattern.

serviceUnder

public B serviceUnder(String pathPrefix,
                      Service<HttpRequest,HttpResponse> service)

Binds the specified Service under the specified directory.

service

public B service(String pathPattern,
                 Service<HttpRequest,HttpResponse> service)

Binds the specified Service at the specified path pattern. e.g.

• /login (no path parameters)
• /users/{userId} (curly-brace style)
• /list/:productType/by/:ordering (colon style)
• exact:/foo/bar (exact match)
• prefix:/files (prefix match)
• glob:/~*/downloads/** (glob pattern)
• regex:^/files/(?<filePath>.*)$ (regular expression)

Throws:

IllegalArgumentException - if the specified path pattern is invalid

service

public B service(PathMapping pathMapping,
                 Service<HttpRequest,HttpResponse> service)

Binds the specified Service at the specified PathMapping.

service

@Deprecated
public B service(PathMapping pathMapping,
                             Service<HttpRequest,HttpResponse> service,
                             String loggerName)

Deprecated. Use a logging framework integration such as RequestContextExportingAppender in armeria-logback.

Binds the specified Service at the specified PathMapping.

service

public <T extends ServiceWithPathMappings<HttpRequest,HttpResponse>> B service(T serviceWithPathMappings)

Binds the specified ServiceWithPathMappings at multiple PathMappings.

service

public <T extends ServiceWithPathMappings<HttpRequest,HttpResponse>,R extends Service<HttpRequest,HttpResponse>> B service(T serviceWithPathMappings,
                                                                                                                           Function<T,R> decorator)

Decorates and binds the specified ServiceWithPathMappings at multiple PathMappings.

annotatedService

public B annotatedService(Object service)

Binds the specified annotated service object under the path prefix "/".

annotatedService

public B annotatedService(Object service,
                          Object... exceptionHandlersAndConverters)

Binds the specified annotated service object under the path prefix "/".

Parameters:

exceptionHandlersAndConverters - instances of ExceptionHandlerFunction, RequestConverterFunction and/or ResponseConverterFunction

annotatedService

public B annotatedService(Object service,
                          Function<Service<HttpRequest,HttpResponse>,? extends Service<HttpRequest,HttpResponse>> decorator,
                          Object... exceptionHandlersAndConverters)

Binds the specified annotated service object under the path prefix "/".

Parameters:

exceptionHandlersAndConverters - instances of ExceptionHandlerFunction, RequestConverterFunction and/or ResponseConverterFunction

annotatedService

public B annotatedService(String pathPrefix,
                          Object service)

Binds the specified annotated service object under the specified path prefix.

annotatedService

public B annotatedService(String pathPrefix,
                          Object service,
                          Object... exceptionHandlersAndConverters)

Binds the specified annotated service object under the specified path prefix.

Parameters:

exceptionHandlersAndConverters - instances of ExceptionHandlerFunction, RequestConverterFunction and/or ResponseConverterFunction

annotatedService

public B annotatedService(String pathPrefix,
                          Object service,
                          Function<Service<HttpRequest,HttpResponse>,? extends Service<HttpRequest,HttpResponse>> decorator,
                          Object... exceptionHandlersAndConverters)

Binds the specified annotated service object under the specified path prefix.

Parameters:

exceptionHandlersAndConverters - instances of ExceptionHandlerFunction, RequestConverterFunction and/or ResponseConverterFunction

annotatedService

public B annotatedService(String pathPrefix,
                          Object service,
                          Function<Service<HttpRequest,HttpResponse>,? extends Service<HttpRequest,HttpResponse>> decorator,
                          Iterable<?> exceptionHandlersAndConverters)

Binds the specified annotated service object under the specified path prefix.

Parameters:

exceptionHandlersAndConverters - an iterable object of ExceptionHandlerFunction, RequestConverterFunction and/or ResponseConverterFunction

decorator

public <T extends Service<HttpRequest,HttpResponse>,R extends Service<HttpRequest,HttpResponse>> B decorator(Function<T,R> decorator)

Decorates all Services with the specified decorator.

Type Parameters:

T - the type of the Service being decorated

R - the type of the Service decorator will produce

Parameters:

decorator - the Function that decorates a Service

toString

public String toString()

Overrides:

toString in class Object