VirtualHostAnnotatedServiceBindingBuilder (filter-service-metrics 1.13 1.13 API)

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

public final class VirtualHostAnnotatedServiceBindingBuilder
extends Object

A builder class for binding an HttpService to a virtual host fluently. This class can be instantiated through VirtualHostBuilder.annotatedService().

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


 ServerBuilder sb = Server.builder();
 sb.virtualHost("foo.com")                       // Return a new instance of {@link VirtualHostBuilder}
   .annotatedService()                           // Return a new instance of this class
   .requestTimeoutMillis(5000)
   .maxRequestLength(8192)
   .exceptionHandler((ctx, request, cause) -> HttpResponse.of(400))
   .pathPrefix("/foo")
   .verboseResponses(true)
   .build(new FooService())                      // Return to {@link VirtualHostBuilder}
   .and()                                        // Return to {@link ServerBuilder}
   .annotatedService(new MyDefaultHostService())
   .build();

See Also:: VirtualHostBuilder, AnnotatedServiceBindingBuilder

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`VirtualHostAnnotatedServiceBindingBuilder`	`accessLogFormat(String accessLogFormat)` Sets the format of this `HttpService`'s access log.
`VirtualHostAnnotatedServiceBindingBuilder`	`accessLogWriter(AccessLogWriter accessLogWriter, boolean shutdownOnStop)` Sets the access log writer of this `HttpService`.
`VirtualHostBuilder`	`build(Object service)` Registers the given service to the VirtualHostBuilder.
`VirtualHostAnnotatedServiceBindingBuilder`	`decorator(Function<? super HttpService,? extends HttpService> decorator)` Decorates an `HttpService` with the specified `decorator`.
`VirtualHostAnnotatedServiceBindingBuilder`	`exceptionHandler(ExceptionHandlerFunction exceptionHandlerFunction)` Deprecated. Use `exceptionHandlers(ExceptionHandlerFunction...)`.
`VirtualHostAnnotatedServiceBindingBuilder`	`exceptionHandlers(ExceptionHandlerFunction... exceptionHandlerFunctions)` Adds the given `ExceptionHandlerFunction`s to this `VirtualHostAnnotatedServiceBindingBuilder`.
`VirtualHostAnnotatedServiceBindingBuilder`	`exceptionHandlers(Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions)` Adds the given `ExceptionHandlerFunction`s to this `VirtualHostAnnotatedServiceBindingBuilder`.
`VirtualHostAnnotatedServiceBindingBuilder`	`maxRequestLength(long maxRequestLength)` Sets the maximum allowed length of an HTTP request.
`VirtualHostAnnotatedServiceBindingBuilder`	`pathPrefix(String pathPrefix)` Sets the path prefix to be used for this `VirtualHostAnnotatedServiceBindingBuilder`.
`VirtualHostAnnotatedServiceBindingBuilder`	`requestConverter(RequestConverterFunction requestConverterFunction)` Deprecated. Use `requestConverters(RequestConverterFunction...)`.
`VirtualHostAnnotatedServiceBindingBuilder`	`requestConverters(Iterable<? extends RequestConverterFunction> requestConverterFunctions)` Adds the given `RequestConverterFunction`s to this `VirtualHostAnnotatedServiceBindingBuilder`.
`VirtualHostAnnotatedServiceBindingBuilder`	`requestConverters(RequestConverterFunction... requestConverterFunctions)` Adds the given `RequestConverterFunction`s to this `VirtualHostAnnotatedServiceBindingBuilder`.
`VirtualHostAnnotatedServiceBindingBuilder`	`requestTimeout(Duration requestTimeout)` Sets the timeout of an HTTP request.
`VirtualHostAnnotatedServiceBindingBuilder`	`requestTimeoutMillis(long requestTimeoutMillis)` Sets the timeout of an HTTP request in milliseconds.
`VirtualHostAnnotatedServiceBindingBuilder`	`responseConverter(ResponseConverterFunction responseConverterFunction)` Deprecated. Use `responseConverters(ResponseConverterFunction...)`.
`VirtualHostAnnotatedServiceBindingBuilder`	`responseConverters(Iterable<? extends ResponseConverterFunction> responseConverterFunctions)` Adds the given `ResponseConverterFunction`s to this `VirtualHostAnnotatedServiceBindingBuilder`.
`VirtualHostAnnotatedServiceBindingBuilder`	`responseConverters(ResponseConverterFunction... responseConverterFunctions)` Adds the given `ResponseConverterFunction`s to this `VirtualHostAnnotatedServiceBindingBuilder`.
`VirtualHostAnnotatedServiceBindingBuilder`	`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
  - pathPrefix
```
public VirtualHostAnnotatedServiceBindingBuilder pathPrefix(String pathPrefix)
```
    Sets the path prefix to be used for this VirtualHostAnnotatedServiceBindingBuilder.
    
    Parameters:
    
    pathPrefix - string representing the path prefix.
  - exceptionHandler
```
@Deprecated
public VirtualHostAnnotatedServiceBindingBuilder exceptionHandler(ExceptionHandlerFunction exceptionHandlerFunction)
```
    Deprecated. Use exceptionHandlers(ExceptionHandlerFunction...).
    
    Adds the given ExceptionHandlerFunction to this VirtualHostAnnotatedServiceBindingBuilder.
  - exceptionHandlers
```
public VirtualHostAnnotatedServiceBindingBuilder exceptionHandlers(ExceptionHandlerFunction... exceptionHandlerFunctions)
```
    Adds the given ExceptionHandlerFunctions to this VirtualHostAnnotatedServiceBindingBuilder.
  - exceptionHandlers
```
public VirtualHostAnnotatedServiceBindingBuilder exceptionHandlers(Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions)
```
    Adds the given ExceptionHandlerFunctions to this VirtualHostAnnotatedServiceBindingBuilder.
  - responseConverter
```
@Deprecated
public VirtualHostAnnotatedServiceBindingBuilder responseConverter(ResponseConverterFunction responseConverterFunction)
```
    Deprecated. Use responseConverters(ResponseConverterFunction...).
    
    Adds the given ResponseConverterFunction to this VirtualHostAnnotatedServiceBindingBuilder.
  - responseConverters
```
public VirtualHostAnnotatedServiceBindingBuilder responseConverters(ResponseConverterFunction... responseConverterFunctions)
```
    Adds the given ResponseConverterFunctions to this VirtualHostAnnotatedServiceBindingBuilder.
  - responseConverters
```
public VirtualHostAnnotatedServiceBindingBuilder responseConverters(Iterable<? extends ResponseConverterFunction> responseConverterFunctions)
```
    Adds the given ResponseConverterFunctions to this VirtualHostAnnotatedServiceBindingBuilder.
  - requestConverter
```
@Deprecated
public VirtualHostAnnotatedServiceBindingBuilder requestConverter(RequestConverterFunction requestConverterFunction)
```
    Deprecated. Use requestConverters(RequestConverterFunction...).
    
    Adds the given RequestConverterFunction to this VirtualHostAnnotatedServiceBindingBuilder.
  - requestConverters
```
public VirtualHostAnnotatedServiceBindingBuilder requestConverters(RequestConverterFunction... requestConverterFunctions)
```
    Adds the given RequestConverterFunctions to this VirtualHostAnnotatedServiceBindingBuilder.
  - requestConverters
```
public VirtualHostAnnotatedServiceBindingBuilder requestConverters(Iterable<? extends RequestConverterFunction> requestConverterFunctions)
```
    Adds the given RequestConverterFunctions to this VirtualHostAnnotatedServiceBindingBuilder.
  - requestTimeout
```
public VirtualHostAnnotatedServiceBindingBuilder 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 VirtualHostAnnotatedServiceBindingBuilder 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 VirtualHostAnnotatedServiceBindingBuilder 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 VirtualHostAnnotatedServiceBindingBuilder 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 VirtualHostAnnotatedServiceBindingBuilder accessLogFormat(String accessLogFormat)
```
    Sets the format of this HttpService's access log. The specified accessLogFormat would be parsed by AccessLogWriter.custom(String).
  - accessLogWriter
```
public VirtualHostAnnotatedServiceBindingBuilder 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 VirtualHostAnnotatedServiceBindingBuilder 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(Object service)
```
    Registers the given service to the VirtualHostBuilder.
    
    Parameters:
    
    service - annotated service object to handle incoming requests matching path prefix, which can be configured through AnnotatedServiceBindingBuilder.pathPrefix(String). If path prefix is not set then this service is registered to handle requests matching /
    
    Returns:
    
    VirtualHostBuilder to continue building VirtualHost

Class VirtualHostAnnotatedServiceBindingBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

pathPrefix

exceptionHandler

exceptionHandlers

exceptionHandlers

responseConverter

responseConverters

responseConverters

requestConverter

requestConverters

requestConverters

requestTimeout

requestTimeoutMillis

maxRequestLength

verboseResponses

accessLogFormat

accessLogWriter

decorator

build