AnnotatedServiceBindingBuilder (filter-service-metrics 1.13 1.13 API)

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

public final class AnnotatedServiceBindingBuilder
extends Object

A builder class for binding an HttpService fluently. This class can be instantiated through ServerBuilder.annotatedService().

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


 ServerBuilder sb = Server.builder();
 sb.annotatedService()                       // Returns an instance of this class
   .requestTimeoutMillis(5000)
   .maxRequestLength(8192)
   .exceptionHandler((ctx, request, cause) -> HttpResponse.of(400))
   .pathPrefix("/foo")
   .verboseResponses(true)
   .build(new Service())                     // Return to the ServerBuilder.
   .build();

See Also:: ServiceBindingBuilder

Method Summary

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

Class AnnotatedServiceBindingBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

pathPrefix

exceptionHandler

exceptionHandlers

exceptionHandlers

responseConverter

responseConverters

responseConverters

requestConverter

requestConverters

requestConverters

decorator

requestTimeout

requestTimeoutMillis

maxRequestLength

verboseResponses

accessLogFormat

accessLogWriter

build