Package com.linecorp.armeria.server

Class ContextPathServicesBuilder

java.lang.Object

com.linecorp.armeria.server.ContextPathServicesBuilder

@UnstableApi
public final class ContextPathServicesBuilder
extends Object

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

 Server.builder()
       .contextPath("/v1", "/v2")
       .service(myService) // served under "/v1" and "/v2"
 

Method Summary

Modifier and Type	Method	Description
ServerBuilder	and()	Returns the parent AbstractContextPathServicesBuilder.
ContextPathAnnotatedServiceConfigSetters	annotatedService()	Returns a new instance of AbstractContextPathAnnotatedServiceConfigSetters to build an annotated service fluently.
ContextPathServicesBuilder	annotatedService(Object service)	Binds the specified annotated service object under the context path.
ContextPathServicesBuilder	annotatedService(Object service, Object... exceptionHandlersAndConverters)	Binds the specified annotated service object under the path prefix "/".
ContextPathServicesBuilder	annotatedService(Object service, Function<? super HttpService,? extends HttpService> decorator, Object... exceptionHandlersAndConverters)	Binds the specified annotated service object under the path prefix "/".
ContextPathServicesBuilder	annotatedService(String pathPrefix, Object service)	Binds the specified annotated service object under the specified path prefix.
ContextPathServicesBuilder	annotatedService(String pathPrefix, Object service, Iterable<?> exceptionHandlersAndConverters)	Binds the specified annotated service object under the specified path prefix.
ContextPathServicesBuilder	annotatedService(String pathPrefix, Object service, Object... exceptionHandlersAndConverters)	Binds the specified annotated service object under the specified path prefix.
ContextPathServicesBuilder	annotatedService(String pathPrefix, Object service, Function<? super HttpService,? extends HttpService> decorator, Iterable<?> exceptionHandlersAndConverters)	Binds the specified annotated service object under the specified path prefix.
ContextPathServicesBuilder	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.
ContextPathServicesBuilder	annotatedService(String pathPrefix, Object service, Function<? super HttpService,? extends HttpService> decorator, Object... exceptionHandlersAndConverters)	Binds the specified annotated service object under the specified path prefix.
ContextPathServicesBuilder	decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Decorates all HttpServices with the specified DecoratingHttpServiceFunction.
ContextPathServicesBuilder	decorator(Route route, DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Decorates HttpServices whose Route matches the specified Route.
ContextPathServicesBuilder	decorator(Route route, Function<? super HttpService,? extends HttpService> decorator)	Decorates HttpServices under the specified directory.
ContextPathServicesBuilder	decorator(String pathPattern, DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Decorates HttpServices whose Route matches the specified pathPattern.
ContextPathServicesBuilder	decorator(String pathPattern, Function<? super HttpService,? extends HttpService> decorator)	Decorates HttpServices whose Route matches the specified pathPattern.
ContextPathServicesBuilder	decorator(Function<? super HttpService,? extends HttpService> decorator)	Decorates all HttpServices with the specified decorator.
ContextPathServicesBuilder	decoratorUnder(String prefix, DecoratingHttpServiceFunction decoratingHttpServiceFunction)	Decorates HttpServices under the specified directory.
ContextPathServicesBuilder	decoratorUnder(String prefix, Function<? super HttpService,? extends HttpService> decorator)	Decorates HttpServices under the specified directory.
ContextPathServiceBindingBuilder	route()	Returns a ContextPathServiceBindingBuilder which is for binding an HttpService fluently.
ContextPathDecoratingBindingBuilder	routeDecorator()	Returns a ContextPathDecoratingBindingBuilder which is for binding a decorator fluently.
ContextPathServicesBuilder	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 ContextPathServicesBuilder	service(HttpServiceWithRoutes serviceWithRoutes, Function<? super HttpService,? extends HttpService>... decorators)	Decorates and binds the specified HttpServiceWithRoutes at multiple Routes under the context path.
ContextPathServicesBuilder	service(Route route, HttpService service)	Binds the specified HttpService at the specified Route under the context path.
ContextPathServicesBuilder	service(String pathPattern, HttpService service)	Binds the specified HttpService at the specified path pattern under the context path.
ContextPathServicesBuilder	serviceUnder(String pathPrefix, HttpService service)	Binds the specified HttpService under the specified context path.
ContextPathServicesBuilder	withRoute(Consumer<? super ContextPathServiceBindingBuilder> 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 ContextPathServicesBuilder withRoute(Consumer<? super ContextPathServiceBindingBuilder> customizer)

Configures an HttpService under the context path with the customizer.

route

public ContextPathServiceBindingBuilder route()

Returns a ContextPathServiceBindingBuilder which is for binding an HttpService fluently.

routeDecorator

public ContextPathDecoratingBindingBuilder routeDecorator()

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

serviceUnder

public ContextPathServicesBuilder 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 ContextPathServicesBuilder 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 ContextPathServicesBuilder service(Route route,
 HttpService service)

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

service

public ContextPathServicesBuilder 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.

service

@SafeVarargs
public final ContextPathServicesBuilder 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.

annotatedService

public ContextPathServicesBuilder annotatedService(Object service)

Binds the specified annotated service object under the context path.

annotatedService

public ContextPathServicesBuilder 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 ContextPathServicesBuilder 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 ContextPathServicesBuilder annotatedService(String pathPrefix,
 Object service)

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

annotatedService

public ContextPathServicesBuilder 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 ContextPathServicesBuilder 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 ContextPathServicesBuilder 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 ContextPathServicesBuilder 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 ContextPathServicesBuilder 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 ContextPathAnnotatedServiceConfigSetters annotatedService()

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

decorator

public ContextPathServicesBuilder 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 ContextPathServicesBuilder 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 ContextPathServicesBuilder 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 ContextPathServicesBuilder 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 ContextPathServicesBuilder 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 ContextPathServicesBuilder 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 ContextPathServicesBuilder 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 ContextPathServicesBuilder 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 ServerBuilder and()

Returns the parent AbstractContextPathServicesBuilder.