ServiceBindingBuilder (filter-service-metrics 1.12 1.12 API)

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

public final class ServiceBindingBuilder
extends Object

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

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


 ServerBuilder sb = Server.builder();

 sb.route()                                      // Configure the first service.
   .post("/foo/bar")
   .consumes(JSON, PLAIN_TEXT_UTF_8)
   .produces(JSON_UTF_8)
   .requestTimeoutMillis(5000)
   .maxRequestLength(8192)
   .verboseResponses(true)
   .contentPreview(500)
   .build((ctx, req) -> HttpResponse.of(OK));    // Return to the ServerBuilder.

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

See Also:: VirtualHostServiceBindingBuilder

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ServiceBindingBuilder`	`accessLogFormat(String accessLogFormat)` Sets the format of this `HttpService`'s access log.
`ServiceBindingBuilder`	`accessLogWriter(AccessLogWriter accessLogWriter, boolean shutdownOnStop)` Sets the access log writer of this `HttpService`.
`ServerBuilder`	`build(HttpService service)` Sets the `HttpService` and returns the `ServerBuilder` that this `ServiceBindingBuilder` was created from.
`ServiceBindingBuilder`	`connect(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.CONNECT` requests.
`ServiceBindingBuilder`	`consumes(Iterable<MediaType> consumeTypes)` Sets `MediaType`s that an `HttpService` will consume.
`ServiceBindingBuilder`	`consumes(MediaType... consumeTypes)` Sets `MediaType`s that an `HttpService` will consume.
`ServiceBindingBuilder`	`contentPreview(int length)` Sets the `ContentPreviewerFactory` for creating a `ContentPreviewer` which produces the preview with the maximum `length` limit for an HTTP request/response of the `HttpService`.
`ServiceBindingBuilder`	`contentPreview(int length, Charset defaultCharset)` Sets the `ContentPreviewerFactory` for creating a `ContentPreviewer` which produces the preview with the maximum `length` limit for an HTTP request/response of an `HttpService`.
`ServiceBindingBuilder`	`contentPreviewerFactory(ContentPreviewerFactory factory)` Sets the `ContentPreviewerFactory` for an HTTP request/response of an `HttpService`.
`ServiceBindingBuilder`	`decorator(Function<? super HttpService,? extends HttpService> decorator)` Decorates an `HttpService` with the specified `decorator`.
`ServiceBindingBuilder`	`delete(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.DELETE` requests.
`ServiceBindingBuilder`	`get(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.GET` requests.
`ServiceBindingBuilder`	`head(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.HEAD` requests.
`ServiceBindingBuilder`	`maxRequestLength(long maxRequestLength)` Sets the maximum allowed length of an HTTP request.
`ServiceBindingBuilder`	`methods(HttpMethod... methods)` Sets the `HttpMethod`s that an `HttpService` will support.
`ServiceBindingBuilder`	`methods(Iterable<HttpMethod> methods)` Sets the `HttpMethod`s that an `HttpService` will support.
`ServiceBindingBuilder`	`options(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.OPTIONS` requests.
`ServiceBindingBuilder`	`patch(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.PATCH` requests.
`ServiceBindingBuilder`	`path(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to.
`ServiceBindingBuilder`	`pathPrefix(String prefix)` Sets the specified prefix which is a directory that an `HttpService` will be bound under.
`ServiceBindingBuilder`	`pathUnder(String prefix)` Deprecated. Use `pathPrefix(String)`.
`ServiceBindingBuilder`	`post(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.POST` requests.
`ServiceBindingBuilder`	`produces(Iterable<MediaType> produceTypes)` Sets `MediaType`s that an `HttpService` will produce to be used in content negotiation.
`ServiceBindingBuilder`	`produces(MediaType... produceTypes)` Sets `MediaType`s that an `HttpService` will produce to be used in content negotiation.
`ServiceBindingBuilder`	`put(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.PUT` requests.
`ServiceBindingBuilder`	`requestContentPreviewerFactory(ContentPreviewerFactory factory)` Sets the `ContentPreviewerFactory` for an HTTP request of an `HttpService`.
`ServiceBindingBuilder`	`requestTimeout(Duration requestTimeout)` Sets the timeout of an HTTP request.
`ServiceBindingBuilder`	`requestTimeoutMillis(long requestTimeoutMillis)` Sets the timeout of an HTTP request in milliseconds.
`ServiceBindingBuilder`	`responseContentPreviewerFactory(ContentPreviewerFactory factory)` Sets the `ContentPreviewerFactory` for an HTTP response of an `HttpService`.
`ServiceBindingBuilder`	`trace(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.TRACE` requests.
`ServiceBindingBuilder`	`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 ServiceBindingBuilder 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 ServiceBindingBuilder pathUnder(String prefix)
```
    Deprecated. Use pathPrefix(String).
    
    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 ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder consumes(MediaType... consumeTypes)
```
    Sets MediaTypes that an HttpService will consume. If not set, the HttpService will accept all media types.
  - consumes
```
public ServiceBindingBuilder consumes(Iterable<MediaType> consumeTypes)
```
    Sets MediaTypes that an HttpService will consume. If not set, the HttpService will accept all media types.
  - produces
```
public ServiceBindingBuilder produces(MediaType... produceTypes)
```
    Sets MediaTypes that an HttpService will produce to be used in content negotiation. See Accept header for more information.
  - produces
```
public ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder 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 ServiceBindingBuilder 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.
  - requestContentPreviewerFactory
```
public ServiceBindingBuilder requestContentPreviewerFactory(ContentPreviewerFactory factory)
```
    Sets the ContentPreviewerFactory for an HTTP request of an HttpService. If not set, the ContentPreviewerFactory set via VirtualHost.requestContentPreviewerFactory() is used.
  - responseContentPreviewerFactory
```
public ServiceBindingBuilder responseContentPreviewerFactory(ContentPreviewerFactory factory)
```
    Sets the ContentPreviewerFactory for an HTTP response of an HttpService. If not set, the ContentPreviewerFactory set via VirtualHost.responseContentPreviewerFactory() is used.
  - contentPreview
```
public ServiceBindingBuilder contentPreview(int length)
```
    Sets the ContentPreviewerFactory for creating a ContentPreviewer which produces the preview with the maximum length limit for an HTTP request/response of the HttpService. The previewer is enabled only if the content type of an HTTP request/response meets any of the following conditions:
    - 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.
  - contentPreview
```
public ServiceBindingBuilder contentPreview(int length,
                                            Charset defaultCharset)
```
    Sets the ContentPreviewerFactory for creating a ContentPreviewer which produces the preview with the maximum length limit for an HTTP request/response of an HttpService. The previewer is enabled only if the content type of an HTTP request/response meets any of the following conditions:
    - 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 used when a charset is not specified in the "content-type" header
  - contentPreviewerFactory
```
public ServiceBindingBuilder contentPreviewerFactory(ContentPreviewerFactory factory)
```
    Sets the ContentPreviewerFactory for an HTTP request/response of an HttpService.
  - accessLogFormat
```
public ServiceBindingBuilder accessLogFormat(String accessLogFormat)
```
    Sets the format of this HttpService's access log. The specified accessLogFormat would be parsed by AccessLogWriter.custom(String).
  - accessLogWriter
```
public ServiceBindingBuilder 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 ServiceBindingBuilder decorator(Function<? super HttpService,? extends HttpService> decorator)
```
    Decorates an HttpService with the specified decorator.
    
    Parameters:
    
    decorator - the Function that decorates the HttpService
  - build
```
public ServerBuilder build(HttpService service)
```
    Sets the HttpService and returns the ServerBuilder that this ServiceBindingBuilder was created from.
    
    Throws:
    
    IllegalStateException - if the path that the HttpService will be bound to is not specified

Class ServiceBindingBuilder

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

requestContentPreviewerFactory

responseContentPreviewerFactory

contentPreview

contentPreview

contentPreviewerFactory

accessLogFormat

accessLogWriter

decorator

build