Package com.linecorp.armeria.server

Class VirtualHostContextPathServicesBuilder

java.lang.Object

com.linecorp.armeria.server.VirtualHostContextPathServicesBuilder

@UnstableApi
public final class VirtualHostContextPathServicesBuilder
extends Object

Builds ServiceConfigs for a VirtualHostBuilder. All ServiceConfigs built by this builder will be served under the specified context paths.

 Server.builder()
       .virtualHost("foo.com")
       .contextPath("/v3")
       .service(myService) // served by virtual host "foo.com" under "/v3"
 

Method Summary

Modifier and Type	Method	Description
VirtualHostBuilder	and()	Returns the parent AbstractContextPathServicesBuilder.
VirtualHostContextPathAnnotatedServiceConfigSetters	annotatedService()	Returns a new instance of AbstractContextPathAnnotatedServiceConfigSetters to build an annotated service fluently.
VirtualHostContextPathServicesBuilder	annotatedService(Object service)	Binds the specified annotated service object under the context path.
VirtualHostContextPathServicesBuilder	annotatedService(Object service, Object... exceptionHandlersAndConverters)	Binds the specified annotated service object under the path prefix "/".
VirtualHostContextPathServicesBuilder	annotatedService(Object service, Function<? super HttpService,? extends HttpService> decorator, Object... exceptionHandlersAndConverters)	Binds the specified annotated service object under the path prefix "/".
VirtualHostContextPathServicesBuilder	annotatedService(String pathPrefix, Object service)	Binds the specified annotated service object under the specified path prefix.
VirtualHostContextPathServicesBuilder	annotatedService(String pathPrefix, Object service, Iterable<?> exceptionHandlersAndConverters)	Binds the specified annotated service object under the specified path prefix.
VirtualHostContextPathServicesBuilder	annotatedService(String pathPrefix, Object service, Object... exceptionHandlersAndConverters)	Binds the specified annotated service object under the specified path prefix.
VirtualHostContextPathServicesBuilder	annotatedService(String pathPrefix, Object service, Function<? super HttpService,? extends HttpService> decorator, Iterable<?> exceptionHandlersAndConverters)	Binds the specified annotated service object under the specified path prefix.
VirtualHostContextPathServicesBuilder	annotatedService(String pathPrefix, Object service, Function<? super HttpService,? extends HttpService> decorator, Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions, Iterable<? extends RequestConverterFunction> requestConverterFunctions, Iterable<? extends ResponseConverterFunction> responseConverterFunctions)	Binds the specified annotated service object under the specified path prefix.
VirtualHostContextPathServicesBuilder	annotatedService(String pathPrefix, Object service, Function<? super HttpService,? extends HttpService> decorator, Object... exceptionHandlersAndConverters)	Binds the specified annotated service object under the specified path prefix.
VirtualHostContextPathServicesBuilder	decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Decorates all HttpServices with the specified DecoratingHttpServiceFunction.
VirtualHostContextPathServicesBuilder	decorator(Route route, DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Decorates HttpServices whose Route matches the specified Route.
VirtualHostContextPathServicesBuilder	decorator(Route route, Function<? super HttpService,? extends HttpService> decorator)	Decorates HttpServices under the specified directory.
VirtualHostContextPathServicesBuilder	decorator(String pathPattern, DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Decorates HttpServices whose Route matches the specified pathPattern.
VirtualHostContextPathServicesBuilder	decorator(String pathPattern, Function<? super HttpService,? extends HttpService> decorator)	Decorates HttpServices whose Route matches the specified pathPattern.
VirtualHostContextPathServicesBuilder	decorator(Function<? super HttpService,? extends HttpService> decorator)	Decorates all HttpServices with the specified decorator.
VirtualHostContextPathServicesBuilder	decoratorUnder(String prefix, DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Decorates HttpServices under the specified directory.
VirtualHostContextPathServicesBuilder	decoratorUnder(String prefix, Function<? super HttpService,? extends HttpService> decorator)	Decorates HttpServices under the specified directory.
VirtualHostContextPathServiceBindingBuilder	route()	Returns a VirtualHostContextPathServiceBindingBuilder which is for binding an HttpService fluently.
VirtualHostContextPathDecoratingBindingBuilder	routeDecorator()	Returns a VirtualHostContextPathDecoratingBindingBuilder which is for binding a decorator fluently.
VirtualHostContextPathServicesBuilder	service(HttpServiceWithRoutes serviceWithRoutes, Iterable<? extends Function<? super HttpService,? extends HttpService>> decorators)	Decorates and binds the specified HttpServiceWithRoutes at multiple Routes under the context path.
final VirtualHostContextPathServicesBuilder	service(HttpServiceWithRoutes serviceWithRoutes, Function<? super HttpService,? extends HttpService>... decorators)	Decorates and binds the specified HttpServiceWithRoutes at multiple Routes under the context path.
VirtualHostContextPathServicesBuilder	service(Route route, HttpService service)	Binds the specified HttpService at the specified Route under the context path.
VirtualHostContextPathServicesBuilder	service(String pathPattern, HttpService service)	Binds the specified HttpService at the specified path pattern under the context path.
VirtualHostContextPathServicesBuilder	serviceUnder(String pathPrefix, HttpService service)	Binds the specified HttpService under the specified context path.
VirtualHostContextPathServicesBuilder	withRoute(Consumer<? super VirtualHostContextPathServiceBindingBuilder> customizer)	Configures an HttpService under the context path with the customizer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

withRoute

public VirtualHostContextPathServicesBuilder withRoute(Consumer<? super VirtualHostContextPathServiceBindingBuilder> customizer)

Configures an HttpService under the context path with the customizer.

route

public VirtualHostContextPathServiceBindingBuilder route()

Returns a VirtualHostContextPathServiceBindingBuilder which is for binding an HttpService fluently.

routeDecorator

public VirtualHostContextPathDecoratingBindingBuilder routeDecorator()

Returns a VirtualHostContextPathDecoratingBindingBuilder which is for binding a decorator fluently. The specified decorator(s) is/are executed in reverse order of the insertion.

serviceUnder

public VirtualHostContextPathServicesBuilder serviceUnder(String pathPrefix,
 HttpService service)

Binds the specified HttpService under the specified context path. If the specified HttpService is an HttpServiceWithRoutes, the pathPrefix is added to each Route of ServiceWithRoutes.routes(). For example, the serviceWithRoutes in the following code will be bound to ("/v1/foo/bar") and ("/v1/foo/baz"):

 > HttpServiceWithRoutes serviceWithRoutes = new HttpServiceWithRoutes() {
 >     @Override
 >     public HttpResponse serve(ServiceRequestContext ctx, HttpRequest req) { ... }
 >
 >     @Override
 >     public Set<Route> routes() {
 >         return Set.of(Route.builder().path("/bar").build(),
 >                       Route.builder().path("/baz").build());
 >     }
 > };
 >
 > Server.builder()
 >       .contextPath("/v1")
 >       .serviceUnder("/foo", serviceWithRoutes)
 >       .build();
 

service

public VirtualHostContextPathServicesBuilder service(String pathPattern,
 HttpService service)

Binds the specified HttpService at the specified path pattern under the context path. e.g.

• /login (no path parameters)
• /users/{userId} (curly-brace style)
• /list/:productType/by/:ordering (colon style)
• exact:/foo/bar (exact match)
• prefix:/files (prefix match)
• glob:/~*/downloads/** (glob pattern)
• regex:^/files/(?<filePath>.*)$ (regular expression)

service

public VirtualHostContextPathServicesBuilder service(Route route,
 HttpService service)

Binds the specified HttpService at the specified Route under the context path.

service

@SafeVarargs
public final VirtualHostContextPathServicesBuilder service(HttpServiceWithRoutes serviceWithRoutes,
 Function<? super HttpService,? extends HttpService>... decorators)

Decorates and binds the specified HttpServiceWithRoutes at multiple Routes under the context path.

Parameters:

serviceWithRoutes - the HttpServiceWithRoutes.

decorators - the decorator functions, which will be applied in the order specified.

service

public VirtualHostContextPathServicesBuilder service(HttpServiceWithRoutes serviceWithRoutes,
 Iterable<? extends Function<? super HttpService,? extends HttpService>> decorators)

Decorates and binds the specified HttpServiceWithRoutes at multiple Routes under the context path.

Parameters:

serviceWithRoutes - the HttpServiceWithRoutes.

decorators - the decorator functions, which will be applied in the order specified.

annotatedService

public VirtualHostContextPathServicesBuilder annotatedService(Object service)

Binds the specified annotated service object under the context path.

annotatedService

public VirtualHostContextPathServicesBuilder annotatedService(Object service,
 Object... exceptionHandlersAndConverters)

Binds the specified annotated service object under the path prefix "/".

Parameters:

exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions

annotatedService

public VirtualHostContextPathServicesBuilder annotatedService(Object service,
 Function<? super HttpService,? extends HttpService> decorator,
 Object... exceptionHandlersAndConverters)

Binds the specified annotated service object under the path prefix "/".

Parameters:

exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions

annotatedService

public VirtualHostContextPathServicesBuilder annotatedService(String pathPrefix,
 Object service)

Binds the specified annotated service object under the specified path prefix.

annotatedService

public VirtualHostContextPathServicesBuilder annotatedService(String pathPrefix,
 Object service,
 Object... exceptionHandlersAndConverters)

Binds the specified annotated service object under the specified path prefix.

Parameters:

exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions

annotatedService

public VirtualHostContextPathServicesBuilder annotatedService(String pathPrefix,
 Object service,
 Function<? super HttpService,? extends HttpService> decorator,
 Object... exceptionHandlersAndConverters)

Binds the specified annotated service object under the specified path prefix.

Parameters:

exceptionHandlersAndConverters - the ExceptionHandlerFunction, RequestConverterFunction and/or ResponseConverterFunction

annotatedService

public VirtualHostContextPathServicesBuilder annotatedService(String pathPrefix,
 Object service,
 Iterable<?> exceptionHandlersAndConverters)

Binds the specified annotated service object under the specified path prefix.

Parameters:

exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions

annotatedService

public VirtualHostContextPathServicesBuilder annotatedService(String pathPrefix,
 Object service,
 Function<? super HttpService,? extends HttpService> decorator,
 Iterable<?> exceptionHandlersAndConverters)

Binds the specified annotated service object under the specified path prefix.

Parameters:

exceptionHandlersAndConverters - the ExceptionHandlerFunction, RequestConverterFunction and/or ResponseConverterFunction

annotatedService

public VirtualHostContextPathServicesBuilder annotatedService(String pathPrefix,
 Object service,
 Function<? super HttpService,? extends HttpService> decorator,
 Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions,
 Iterable<? extends RequestConverterFunction> requestConverterFunctions,
 Iterable<? extends ResponseConverterFunction> responseConverterFunctions)

Binds the specified annotated service object under the specified path prefix.

Parameters:

exceptionHandlerFunctions - the ExceptionHandlerFunctions

requestConverterFunctions - the RequestConverterFunctions

responseConverterFunctions - the ResponseConverterFunctions

annotatedService

public VirtualHostContextPathAnnotatedServiceConfigSetters annotatedService()

Returns a new instance of AbstractContextPathAnnotatedServiceConfigSetters to build an annotated service fluently.

decorator

public VirtualHostContextPathServicesBuilder decorator(Function<? super HttpService,? extends HttpService> decorator)

Decorates all HttpServices with the specified decorator. The specified decorator(s) is/are executed in reverse order of the insertion.

Parameters:

decorator - the Function that decorates HttpServices

decorator

public VirtualHostContextPathServicesBuilder decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction)

Decorates all HttpServices with the specified DecoratingHttpServiceFunction. The specified decorator(s) is/are executed in reverse order of the insertion.

Parameters:

decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpServices

decorator

public VirtualHostContextPathServicesBuilder decorator(String pathPattern,
 Function<? super HttpService,? extends HttpService> decorator)

Decorates HttpServices whose Route matches the specified pathPattern. The specified decorator(s) is/are executed in reverse order of the insertion.

decorator

public VirtualHostContextPathServicesBuilder decorator(String pathPattern,
 DecoratingHttpServiceFunction decoratingHttpServiceFunction)

Decorates HttpServices whose Route matches the specified pathPattern. The specified decorator(s) is/are executed in reverse order of the insertion.

Parameters:

decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpServices

decorator

public VirtualHostContextPathServicesBuilder decorator(Route route,
 Function<? super HttpService,? extends HttpService> decorator)

Decorates HttpServices under the specified directory. The specified decorator(s) is/are executed in reverse order of the insertion.

decorator

public VirtualHostContextPathServicesBuilder decorator(Route route,
 DecoratingHttpServiceFunction decoratingHttpServiceFunction)

Decorates HttpServices whose Route matches the specified Route. The specified decorator(s) is/are executed in reverse order of the insertion.

Parameters:

route - the route being decorated

decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpServices

decoratorUnder

public VirtualHostContextPathServicesBuilder decoratorUnder(String prefix,
 DecoratingHttpServiceFunction decoratingHttpServiceFunction)

Decorates HttpServices under the specified directory. The specified decorator(s) is/are executed in reverse order of the insertion.

Parameters:

decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpServices

decoratorUnder

public VirtualHostContextPathServicesBuilder decoratorUnder(String prefix,
 Function<? super HttpService,? extends HttpService> decorator)

Decorates HttpServices under the specified directory. The specified decorator(s) is/are executed in reverse order of the insertion.

and

public VirtualHostBuilder and()

Returns the parent AbstractContextPathServicesBuilder.