Package 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	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	Description
B	accessLogger(String loggerName)	Sets the Logger named loggerName of this VirtualHost, which is used for writing access logs.
B	accessLogger(Function<VirtualHost,Logger> mapper)	Sets the access logger mapper of this VirtualHost.
B	accessLogger(Logger logger)	Sets the Logger of this VirtualHost, which is used for writing access logs.
B	annotatedService(Object service)	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(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(String pathPrefix, Object service)	Binds the specified annotated service object under the specified path prefix.
B	annotatedService(String pathPrefix, Object service, Iterable<?> 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.
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.
VirtualHost	build()	Returns a newly-created VirtualHost based on the properties of this builder and the services added to this builder.
B	contentPreview(int length)	Sets the ContentPreviewerFactory creating a ContentPreviewer which produces the preview with the maxmium length limit for a request and a response of this VirtualHost.
B	contentPreview(int length, Charset defaultCharset)	Sets the ContentPreviewerFactory creating a ContentPreviewer which produces the preview with the maxmium length limit for a request and a response of this VirtualHost.
B	contentPreviewerFactory(ContentPreviewerFactory factory)	Sets the ContentPreviewerFactory for a request and a response of this VirtualHost.
<T extends Service<HttpRequest,HttpResponse>,R extends Service<HttpRequest,HttpResponse>> B	decorator(Function<T,R> decorator)	Decorates all Services with the specified decorator.
B	requestContentPreviewerFactory(ContentPreviewerFactory factory)	Sets the ContentPreviewerFactory for a request of this VirtualHost.
B	responseContentPreviewerFactory(ContentPreviewerFactory factory)	Sets the ContentPreviewerFactory for a response of this VirtualHost.
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<? super 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(SslContext sslContext)	Configures SSL or TLS of this VirtualHost with the specified 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	tlsSelfSigned()	Configures SSL or TLS of this VirtualHost with an auto-generated self-signed certificate.
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

tlsSelfSigned

public B tlsSelfSigned()
                throws SSLException,
                       CertificateException

Configures SSL or TLS of this VirtualHost with an auto-generated self-signed certificate. Note: You should never use this in production but only for a testing purpose.

Throws:

CertificateException - if failed to generate a self-signed certificate

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<? super 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,
                          Iterable<?> exceptionHandlersAndConverters)

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

Parameters:

exceptionHandlersAndConverters - an iterable object 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

accessLogger

public B accessLogger(Function<VirtualHost,Logger> mapper)

Sets the access logger mapper of this VirtualHost. When build() is called, this VirtualHost gets Logger via the mapper for writing access logs.

accessLogger

public B accessLogger(Logger logger)

Sets the Logger of this VirtualHost, which is used for writing access logs.

accessLogger

public B accessLogger(String loggerName)

Sets the Logger named loggerName of this VirtualHost, which is used for writing access logs.

requestContentPreviewerFactory

public B requestContentPreviewerFactory(ContentPreviewerFactory factory)

Sets the ContentPreviewerFactory for a request of this VirtualHost.

responseContentPreviewerFactory

public B responseContentPreviewerFactory(ContentPreviewerFactory factory)

Sets the ContentPreviewerFactory for a response of this VirtualHost.

contentPreviewerFactory

public B contentPreviewerFactory(ContentPreviewerFactory factory)

Sets the ContentPreviewerFactory for a request and a response of this VirtualHost.

contentPreview

public B contentPreview(int length,
                        Charset defaultCharset)

Sets the ContentPreviewerFactory creating a ContentPreviewer which produces the preview with the maxmium length limit for a request and a response of this VirtualHost. The previewer is enabled only if the content type of a request/response meets any of the following cases.

• when it matches text/* or application/x-www-form-urlencoded
• when its charset has been specified
• when its subtype is "xml" or "json"
• when its subtype ends with "+xml" or "+json"

Parameters:

length - the maximum length of the preview.

defaultCharset - the default charset for a request/response with unspecified charset in "Content-Type" header.

contentPreview

public B contentPreview(int length)

Sets the ContentPreviewerFactory creating a ContentPreviewer which produces the preview with the maxmium length limit for a request and a response of this VirtualHost. The previewer is enabled only if the content type of a request/response meets any of the following cases.

• when it matches text/* or application/x-www-form-urlencoded
• when its charset has been specified
• when its subtype is "xml" or "json"
• when its subtype ends with "+xml" or "+json"

Parameters:

length - the maximum length of the preview.

toString

public String toString()

Overrides:

toString in class Object