VirtualHostServiceBindingBuilder (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.server.VirtualHostServiceBindingBuilder

public final class VirtualHostServiceBindingBuilder
extends Object

A builder class for binding an HttpService fluently. This class can be instantiated through VirtualHostBuilder.route(). You can also configure an HttpService using VirtualHostBuilder.withRoute(Consumer).

Call build(HttpService) to build the HttpService and return to the VirtualHostBuilder.


 ServerBuilder sb = Server.builder();
 sb.virtualHost("example.com")
   .route()                                      // Configure the first service in "example.com".
   .post("/foo/bar")
   .consumes(JSON, PLAIN_TEXT_UTF_8)
   .produces(JSON_UTF_8)
   .requestTimeoutMillis(5000)
   .maxRequestLength(8192)
   .verboseResponses(true)
   .build((ctx, req) -> HttpResponse.of(OK));    // Return to the VirtualHostBuilder.

 sb.virtualHost("example2.com")                  // Configure the second service "example2.com".
   .withRoute(builder -> builder.path("/baz")
                                .methods(HttpMethod.GET, HttpMethod.POST)
                                .build((ctx, req) -> HttpResponse.of(OK)));

See Also:: ServiceBindingBuilder

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`VirtualHostServiceBindingBuilder`	`accessLogFormat(String accessLogFormat)` Sets the format of this `HttpService`'s access log.
`VirtualHostServiceBindingBuilder`	`accessLogWriter(AccessLogWriter accessLogWriter, boolean shutdownOnStop)` Sets the access log writer of this `HttpService`.
`VirtualHostBuilder`	`build(HttpService service)` Sets the `HttpService` and returns the `VirtualHostBuilder` that this `VirtualHostServiceBindingBuilder` was created from.
`VirtualHostServiceBindingBuilder`	`connect(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.CONNECT` requests.
`VirtualHostServiceBindingBuilder`	`consumes(Iterable<MediaType> consumeTypes)` Sets `MediaType`s that an `HttpService` will consume.
`VirtualHostServiceBindingBuilder`	`consumes(MediaType... consumeTypes)` Sets `MediaType`s that an `HttpService` will consume.
`VirtualHostServiceBindingBuilder`	`decorator(Function<? super HttpService,? extends HttpService> decorator)` Decorates an `HttpService` with the specified `decorator`.
`VirtualHostServiceBindingBuilder`	`delete(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.DELETE` requests.
`VirtualHostServiceBindingBuilder`	`get(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.GET` requests.
`VirtualHostServiceBindingBuilder`	`head(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.HEAD` requests.
`com.linecorp.armeria.server.AbstractBindingBuilder`	`matchesHeaders(CharSequence headerName, Predicate<? super String> valuePredicate)` Sets the `Route` to accept a request when the specified `valuePredicate` evaluates `true` with the value of the specified `headerName` header.
`com.linecorp.armeria.server.AbstractBindingBuilder`	`matchesHeaders(Iterable<String> headerPredicates)` Sets the `Route` to accept a request if it matches all the specified predicates for `HttpHeaders`.
`com.linecorp.armeria.server.AbstractBindingBuilder`	`matchesHeaders(String... headerPredicates)` Sets the `Route` to accept a request if it matches all the specified predicates for `HttpHeaders`.
`com.linecorp.armeria.server.AbstractBindingBuilder`	`matchesParams(Iterable<String> paramPredicates)` Sets the `Route` to accept a request if it matches all the specified predicates for HTTP parameters.
`com.linecorp.armeria.server.AbstractBindingBuilder`	`matchesParams(String... paramPredicates)` Sets the `Route` to accept a request if it matches all the specified predicates for HTTP parameters.
`com.linecorp.armeria.server.AbstractBindingBuilder`	`matchesParams(String paramName, Predicate<? super String> valuePredicate)` Sets the `Route` to accept a request when the specified `valuePredicate` evaluates `true` with the value of the specified `paramName` parameter.
`VirtualHostServiceBindingBuilder`	`maxRequestLength(long maxRequestLength)` Sets the maximum allowed length of an HTTP request.
`VirtualHostServiceBindingBuilder`	`methods(HttpMethod... methods)` Sets the `HttpMethod`s that an `HttpService` will support.
`VirtualHostServiceBindingBuilder`	`methods(Iterable<HttpMethod> methods)` Sets the `HttpMethod`s that an `HttpService` will support.
`VirtualHostServiceBindingBuilder`	`options(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.OPTIONS` requests.
`VirtualHostServiceBindingBuilder`	`patch(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.PATCH` requests.
`VirtualHostServiceBindingBuilder`	`path(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to.
`VirtualHostServiceBindingBuilder`	`pathPrefix(String prefix)` Sets the specified prefix which is a directory that an `HttpService` will be bound under.
`VirtualHostServiceBindingBuilder`	`pathUnder(String prefix)` Deprecated.
`VirtualHostServiceBindingBuilder`	`post(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.POST` requests.
`VirtualHostServiceBindingBuilder`	`produces(Iterable<MediaType> produceTypes)` Sets `MediaType`s that an `HttpService` will produce to be used in content negotiation.
`VirtualHostServiceBindingBuilder`	`produces(MediaType... produceTypes)` Sets `MediaType`s that an `HttpService` will produce to be used in content negotiation.
`VirtualHostServiceBindingBuilder`	`put(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.PUT` requests.
`VirtualHostServiceBindingBuilder`	`requestTimeout(Duration requestTimeout)` Sets the timeout of an HTTP request.
`VirtualHostServiceBindingBuilder`	`requestTimeoutMillis(long requestTimeoutMillis)` Sets the timeout of an HTTP request in milliseconds.
`VirtualHostServiceBindingBuilder`	`trace(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.TRACE` requests.
`VirtualHostServiceBindingBuilder`	`verboseResponses(boolean verboseResponses)` Sets whether the verbose response mode is enabled.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - path
```
public VirtualHostServiceBindingBuilder path(String pathPattern)
```
    Sets the path pattern that an HttpService will be bound to. Please refer to the Path patterns in order to learn how to specify a path pattern.
  - pathUnder
```
@Deprecated
public VirtualHostServiceBindingBuilder pathUnder(String prefix)
```
    Deprecated.
    
    Sets the specified prefix which is a directory that an HttpService will be bound under. pathUnder("/my/path") is identical to path("prefix:/my/path").
  - pathPrefix
```
public VirtualHostServiceBindingBuilder pathPrefix(String prefix)
```
    Sets the specified prefix which is a directory that an HttpService will be bound under. pathPrefix("/my/path") is identical to path("prefix:/my/path").
  - methods
```
public VirtualHostServiceBindingBuilder methods(HttpMethod... methods)
```
    Sets the HttpMethods that an HttpService will support. If not set, HttpMethod.knownMethods()s are set.
    
    See Also:
    
    path(String), pathPrefix(String)
  - methods
```
public VirtualHostServiceBindingBuilder methods(Iterable<HttpMethod> methods)
```
    Sets the HttpMethods that an HttpService will support. If not set, HttpMethod.knownMethods()s are set.
    
    See Also:
    
    path(String), pathPrefix(String)
  - get
```
public VirtualHostServiceBindingBuilder get(String pathPattern)
```
    Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.GET requests. Please refer to the Path patterns in order to learn how to specify a path pattern.
  - post
```
public VirtualHostServiceBindingBuilder post(String pathPattern)
```
    Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.POST requests. Please refer to the Path patterns in order to learn how to specify a path pattern.
  - put
```
public VirtualHostServiceBindingBuilder put(String pathPattern)
```
    Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.PUT requests. Please refer to the Path patterns in order to learn how to specify a path pattern.
  - patch
```
public VirtualHostServiceBindingBuilder patch(String pathPattern)
```
    Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.PATCH requests. Please refer to the Path patterns in order to learn how to specify a path pattern.
  - delete
```
public VirtualHostServiceBindingBuilder delete(String pathPattern)
```
    Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.DELETE requests. Please refer to the Path patterns in order to learn how to specify a path pattern.
  - options
```
public VirtualHostServiceBindingBuilder options(String pathPattern)
```
    Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.OPTIONS requests. Please refer to the Path patterns in order to learn how to specify a path pattern.
  - head
```
public VirtualHostServiceBindingBuilder head(String pathPattern)
```
    Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.HEAD requests. Please refer to the Path patterns in order to learn how to specify a path pattern.
  - trace
```
public VirtualHostServiceBindingBuilder trace(String pathPattern)
```
    Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.TRACE requests. Please refer to the Path patterns in order to learn how to specify a path pattern.
  - connect
```
public VirtualHostServiceBindingBuilder connect(String pathPattern)
```
    Sets the path pattern that an HttpService will be bound to, only supporting HttpMethod.CONNECT requests. Please refer to the Path patterns in order to learn how to specify a path pattern.
  - consumes
```
public VirtualHostServiceBindingBuilder consumes(MediaType... consumeTypes)
```
    Sets MediaTypes that an HttpService will consume. If not set, the HttpService will accept all media types.
  - consumes
```
public VirtualHostServiceBindingBuilder consumes(Iterable<MediaType> consumeTypes)
```
    Sets MediaTypes that an HttpService will consume. If not set, the HttpService will accept all media types.
  - produces
```
public VirtualHostServiceBindingBuilder produces(MediaType... produceTypes)
```
    Sets MediaTypes that an HttpService will produce to be used in content negotiation. See Accept header for more information.
  - produces
```
public VirtualHostServiceBindingBuilder produces(Iterable<MediaType> produceTypes)
```
    Sets MediaTypes that an HttpService will produce to be used in content negotiation. See Accept header for more information.
  - requestTimeout
```
public VirtualHostServiceBindingBuilder requestTimeout(Duration requestTimeout)
```
    Sets the timeout of an HTTP request. If not set, the value set via VirtualHost.requestTimeoutMillis() is used.
    
    Parameters:
    
    requestTimeout - the timeout. 0 disables the timeout.
  - requestTimeoutMillis
```
public VirtualHostServiceBindingBuilder requestTimeoutMillis(long requestTimeoutMillis)
```
    Sets the timeout of an HTTP request in milliseconds. If not set, the value set via VirtualHost.requestTimeoutMillis() is used.
    
    Parameters:
    
    requestTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.
  - maxRequestLength
```
public VirtualHostServiceBindingBuilder maxRequestLength(long maxRequestLength)
```
    Sets the maximum allowed length of an HTTP request. If not set, the value set via VirtualHost.maxRequestLength() is used.
    
    Parameters:
    
    maxRequestLength - the maximum allowed length. 0 disables the length limit.
  - verboseResponses
```
public VirtualHostServiceBindingBuilder verboseResponses(boolean verboseResponses)
```
    Sets whether the verbose response mode is enabled. When enabled, the service response will contain the exception type and its full stack trace, which may be useful for debugging while potentially insecure. When disabled, the service response will not expose such server-side details to the client. If not set, the value set via VirtualHostBuilder.verboseResponses(boolean) is used.
  - accessLogFormat
```
public VirtualHostServiceBindingBuilder accessLogFormat(String accessLogFormat)
```
    Sets the format of this HttpService's access log. The specified accessLogFormat would be parsed by AccessLogWriter.custom(String).
  - accessLogWriter
```
public VirtualHostServiceBindingBuilder accessLogWriter(AccessLogWriter accessLogWriter,
                                                        boolean shutdownOnStop)
```
    Sets the access log writer of this HttpService. If not set, the AccessLogWriter set via VirtualHost.accessLogWriter() is used.
    
    shutdownOnStop - whether to shut down the AccessLogWriter when the Server stops
  - decorator
```
public VirtualHostServiceBindingBuilder decorator(Function<? super HttpService,? extends HttpService> decorator)
```
    Decorates an HttpService with the specified decorator.
    
    Parameters:
    
    decorator - the Function that decorates the HttpService
  - build
```
public VirtualHostBuilder build(HttpService service)
```
    Sets the HttpService and returns the VirtualHostBuilder that this VirtualHostServiceBindingBuilder was created from.
    
    Throws:
    
    IllegalStateException - if the path that the HttpService will be bound to is not specified
  - matchesParams
```
public com.linecorp.armeria.server.AbstractBindingBuilder matchesParams(String... paramPredicates)
```
    Sets the Route to accept a request if it matches all the specified predicates for HTTP parameters. The predicate can be one of the following forms:
    - some-param=some-value which means that the request must have a some-param=some-value parameter
    - some-param!=some-value which means that the request must not have a some-param=some-value parameter
    - some-param which means that the request must contain a some-param parameter
    - !some-param which means that the request must not contain a some-param parameter
    Note that these predicates can be evaluated only with the query string of the request URI. Also note that each predicate will be evaluated with the decoded value of HTTP parameters, so do not use percent-encoded value in the predicate.
    See Also:
    
    MatchesParam
  - matchesParams
```
public com.linecorp.armeria.server.AbstractBindingBuilder matchesParams(Iterable<String> paramPredicates)
```
    Sets the Route to accept a request if it matches all the specified predicates for HTTP parameters. The predicate can be one of the following forms:
    - some-param=some-value which means that the request must have a some-param=some-value parameter
    - some-param!=some-value which means that the request must not have a some-param=some-value parameter
    - some-param which means that the request must contain a some-param parameter
    - !some-param which means that the request must not contain a some-param parameter
    Note that these predicates can be evaluated only with the query string of the request URI. Also note that each predicate will be evaluated with the decoded value of HTTP parameters, so do not use percent-encoded value in the predicate.
    See Also:
    
    MatchesParam
  - matchesParams
```
public com.linecorp.armeria.server.AbstractBindingBuilder matchesParams(String paramName,
                                                                        Predicate<? super String> valuePredicate)
```
    Sets the Route to accept a request when the specified valuePredicate evaluates true with the value of the specified paramName parameter.
  - matchesHeaders
```
public com.linecorp.armeria.server.AbstractBindingBuilder matchesHeaders(String... headerPredicates)
```
    Sets the Route to accept a request if it matches all the specified predicates for HttpHeaders. The predicate can be one of the following forms:
    - some-header=some-value which means that the request must have a some-header: some-value header
    - some-header!=some-value which means that the request must not have a some-header: some-value header
    - some-header which means that the request must contain a some-header header
    - !some-header which means that the request must not contain a some-header header
    See Also:
    
    MatchesHeader
  - matchesHeaders
```
public com.linecorp.armeria.server.AbstractBindingBuilder matchesHeaders(Iterable<String> headerPredicates)
```
    Sets the Route to accept a request if it matches all the specified predicates for HttpHeaders. The predicate can be one of the following forms:
    - some-header=some-value which means that the request must have a some-header: some-value header
    - some-header!=some-value which means that the request must not have a some-header: some-value an header
    - some-header which means that the request must contain a some-header header
    - !some-header which means that the request must not contain a some-header header
    See Also:
    
    MatchesHeader
  - matchesHeaders
```
public com.linecorp.armeria.server.AbstractBindingBuilder matchesHeaders(CharSequence headerName,
                                                                         Predicate<? super String> valuePredicate)
```
    Sets the Route to accept a request when the specified valuePredicate evaluates true with the value of the specified headerName header.

Class VirtualHostServiceBindingBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

path

pathUnder

pathPrefix

methods

methods

get

post

put

patch

delete

options

head

trace

connect

consumes

consumes

produces

produces

requestTimeout

requestTimeoutMillis

maxRequestLength

verboseResponses

accessLogFormat

accessLogWriter

decorator

build

matchesParams

matchesParams

matchesParams

matchesHeaders

matchesHeaders

matchesHeaders