Package com.linecorp.armeria.server.composition

Class AbstractCompositeService<I extends Request,O extends Response>

java.lang.Object

com.linecorp.armeria.server.composition.AbstractCompositeService<I,O>

Type Parameters:

I - the Request type

O - the Response type

All Implemented Interfaces:

Unwrappable, Service<I,O>

Direct Known Subclasses:

DocService, SimpleCompositeService

public abstract class AbstractCompositeService<I extends Request,O extends Response>
extends Object
implements Service<I,O>

A skeletal Service implementation that enables composing multiple Services into one. Extend this class to build your own composite Service. e.g.

 public class MyService extends AbstractCompositeService<HttpRequest, HttpResponse> {
     public MyService() {
         super(CompositeServiceEntry.ofPrefix("/foo/", new FooService()),
               CompositeServiceEntry.ofPrefix("/bar/", new BarService()),
               CompositeServiceEntry.ofCatchAll(new OtherService()));
     }
 }
 

See Also:

AbstractCompositeServiceBuilder, CompositeServiceEntry

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCompositeService(CompositeServiceEntry<I,O>... services)	Creates a new instance with the specified CompositeServiceEntrys.
protected	AbstractCompositeService(Iterable<CompositeServiceEntry<I,O>> services)	Creates a new instance with the specified CompositeServiceEntrys.

Method Summary

Modifier and Type	Method	Description
protected Routed<Service<I,O>>	findService(RoutingContext routingCtx)	Finds the Service whose Route matches the path.
O	serve(ServiceRequestContext ctx, I req)	Serves an incoming Request.
void	serviceAdded(ServiceConfig cfg)	Invoked when this Service has been added to a Server with the specified configuration.
protected <T extends Service<I,O>> T	serviceAt(int index)	Returns the index-th Service in this composite Service.
protected List<CompositeServiceEntry<I,O>>	services()	Returns the list of CompositeServiceEntrys added to this composite Service.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.server.Service

as, decorate, decorate, decorate, shouldCachePath

Constructor Detail

AbstractCompositeService

@SafeVarargs
protected AbstractCompositeService(CompositeServiceEntry<I,O>... services)

Creates a new instance with the specified CompositeServiceEntrys.

AbstractCompositeService

protected AbstractCompositeService(Iterable<CompositeServiceEntry<I,O>> services)

Creates a new instance with the specified CompositeServiceEntrys.

Method Detail

serviceAdded

public void serviceAdded(ServiceConfig cfg)
                  throws Exception

Description copied from interface: Service

Invoked when this Service has been added to a Server with the specified configuration. Please note that this method can be invoked more than once if this Service has been added more than once.

Specified by:

serviceAdded in interface Service<I extends Request,O extends Response>

Throws:

Exception

services

protected List<CompositeServiceEntry<I,O>> services()

Returns the list of CompositeServiceEntrys added to this composite Service.

serviceAt

protected <T extends Service<I,O>> T serviceAt(int index)

Returns the index-th Service in this composite Service. The index of the Service added first is 0, and so on.

findService

protected Routed<Service<I,O>> findService(RoutingContext routingCtx)

Finds the Service whose Route matches the path.

Parameters:

routingCtx - a context to find the Service.

Returns:

the Service wrapped by Routed if there's a match. Routed.empty() if there's no match.

serve

public O serve(ServiceRequestContext ctx,
               I req)
        throws Exception

Description copied from interface: Service

Serves an incoming Request.

Specified by:

serve in interface Service<I extends Request,O extends Response>

Parameters:

ctx - the context of the received Request

req - the received Request

Returns:

the Response

Throws:

Exception