VirtualHostDecoratingServiceBindingBuilder (filter-service-metrics 1.12 1.12 API)

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

public final class VirtualHostDecoratingServiceBindingBuilder
extends Object

A builder class for binding a decorator to a Route fluently. This class can be instantiated through VirtualHostBuilder.routeDecorator().

Call build(Function) or build(DecoratingHttpServiceFunction) to build the decorator and return to the VirtualHostBuilder.


 ServerBuilder sb = new ServerBuilder();

 sb.virtualHost("example.com")
   .routeDecorator()                                // Configure a decorator with route.
   .pathPrefix("/api/users")
   .build((delegate, ctx, req) -> {
       if (!"bearer my_token".equals(req.headers().get(HttpHeaderNames.AUTHORIZATION))) {
           return HttpResponse.of(HttpStatus.UNAUTHORIZED);
       }
       return delegate.serve(ctx, req);
   });                                              // Return to the VirtualHostBuilder.

See Also:: VirtualHostServiceBindingBuilder

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`VirtualHostBuilder`	`build(DecoratingHttpServiceFunction decoratingHttpServiceFunction)` Sets the `DecoratingHttpServiceFunction` and returns `VirtualHostBuilder` that this `VirtualHostDecoratingServiceBindingBuilder` was created from.
`VirtualHostBuilder`	`build(Function<? super HttpService,? extends HttpService> decorator)` Sets the `decorator` and returns `VirtualHostBuilder` that this `VirtualHostDecoratingServiceBindingBuilder` was created from.
`VirtualHostDecoratingServiceBindingBuilder`	`connect(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.CONNECT` requests.
`VirtualHostDecoratingServiceBindingBuilder`	`consumes(Iterable<MediaType> consumeTypes)` Sets `MediaType`s that an `HttpService` will consume.
`VirtualHostDecoratingServiceBindingBuilder`	`consumes(MediaType... consumeTypes)` Sets `MediaType`s that an `HttpService` will consume.
`VirtualHostDecoratingServiceBindingBuilder`	`delete(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.DELETE` requests.
`VirtualHostDecoratingServiceBindingBuilder`	`get(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.GET` requests.
`VirtualHostDecoratingServiceBindingBuilder`	`head(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.HEAD` requests.
`VirtualHostDecoratingServiceBindingBuilder`	`methods(HttpMethod... methods)` Sets the `HttpMethod`s that an `HttpService` will support.
`VirtualHostDecoratingServiceBindingBuilder`	`methods(Iterable<HttpMethod> methods)` Sets the `HttpMethod`s that an `HttpService` will support.
`VirtualHostDecoratingServiceBindingBuilder`	`options(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.OPTIONS` requests.
`VirtualHostDecoratingServiceBindingBuilder`	`patch(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.PATCH` requests.
`VirtualHostDecoratingServiceBindingBuilder`	`path(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to.
`VirtualHostDecoratingServiceBindingBuilder`	`pathPrefix(String prefix)` Sets the specified prefix which is a directory that an `HttpService` will be bound under.
`VirtualHostDecoratingServiceBindingBuilder`	`pathUnder(String prefix)` Deprecated. Use `pathPrefix(String)`.
`VirtualHostDecoratingServiceBindingBuilder`	`post(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.POST` requests.
`VirtualHostDecoratingServiceBindingBuilder`	`produces(Iterable<MediaType> produceTypes)` Sets `MediaType`s that an `HttpService` will produce to be used in content negotiation.
`VirtualHostDecoratingServiceBindingBuilder`	`produces(MediaType... produceTypes)` Sets `MediaType`s that an `HttpService` will produce to be used in content negotiation.
`VirtualHostDecoratingServiceBindingBuilder`	`put(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.PUT` requests.
`VirtualHostDecoratingServiceBindingBuilder`	`trace(String pathPattern)` Sets the path pattern that an `HttpService` will be bound to, only supporting `HttpMethod.TRACE` requests.

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

- Method Detail
  - path
```
public VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder 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 VirtualHostDecoratingServiceBindingBuilder consumes(MediaType... consumeTypes)
```
    Sets MediaTypes that an HttpService will consume. If not set, the HttpService will accept all media types.
  - consumes
```
public VirtualHostDecoratingServiceBindingBuilder consumes(Iterable<MediaType> consumeTypes)
```
    Sets MediaTypes that an HttpService will consume. If not set, the HttpService will accept all media types.
  - produces
```
public VirtualHostDecoratingServiceBindingBuilder produces(MediaType... produceTypes)
```
    Sets MediaTypes that an HttpService will produce to be used in content negotiation. See Accept header for more information.
  - produces
```
public VirtualHostDecoratingServiceBindingBuilder produces(Iterable<MediaType> produceTypes)
```
    Sets MediaTypes that an HttpService will produce to be used in content negotiation. See Accept header for more information.
  - build
```
public VirtualHostBuilder build(Function<? super HttpService,? extends HttpService> decorator)
```
    Sets the decorator and returns VirtualHostBuilder that this VirtualHostDecoratingServiceBindingBuilder was created from.
    
    Parameters:
    
    decorator - the Function that decorates HttpService
  - build
```
public VirtualHostBuilder build(DecoratingHttpServiceFunction decoratingHttpServiceFunction)
```
    Sets the DecoratingHttpServiceFunction and returns VirtualHostBuilder that this VirtualHostDecoratingServiceBindingBuilder was created from.
    
    Parameters:
    
    decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpService

Class VirtualHostDecoratingServiceBindingBuilder

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

build

build