Package com.linecorp.armeria.server

Class DecoratingService<T_I extends Request,T_O extends Response,R_I extends Request,R_O extends Response>

java.lang.Object

com.linecorp.armeria.server.DecoratingService<T_I,T_O,R_I,R_O>

Type Parameters:

T_I - the Request type of the Service being decorated

T_O - the Response type of the Service being decorated

R_I - the Request type of this Service

R_O - the Response type of this Service

All Implemented Interfaces:

Service<R_I,R_O>

Direct Known Subclasses:

SimpleDecoratingService

public abstract class DecoratingService<T_I extends Request,T_O extends Response,R_I extends Request,R_O extends Response>
extends Object
implements Service<R_I,R_O>

A Service that decorates another Service. Use SimpleDecoratingService or Service.decorate(DecoratingServiceFunction) if your Service has the same Request and Response type with the Service being decorated.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DecoratingService(Service<T_I,T_O> delegate)	Creates a new instance that decorates the specified Service.

Method Summary

Modifier and Type	Method	Description
<T> Optional<T>	as(Class<T> serviceType)	Undecorates this Service to find the Service which is an instance of the specified serviceType.
protected <T extends Service<T_I,T_O>> T	delegate()	Returns the Service being decorated.
void	serviceAdded(ServiceConfig cfg)	Invoked when this Service has been added to a Server with the specified configuration.
boolean	shouldCachePath(String path, String query, PathMapping pathMapping)	Returns whether the given path and query should be cached if the service's result is successful.
String	toString()

Methods inherited from class java.lang.Object

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

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

decorate, decorate, decorate, serve

Constructor Detail

DecoratingService

protected DecoratingService(Service<T_I,T_O> delegate)

Creates a new instance that decorates the specified Service.

Method Detail

delegate

protected final <T extends Service<T_I,T_O>> T delegate()

Returns the Service being decorated.

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<T_I extends Request,T_O extends Response>

Throws:

Exception

as

public final <T> Optional<T> as(Class<T> serviceType)

Description copied from interface: Service

Undecorates this Service to find the Service which is an instance of the specified serviceType. Use this method instead of an explicit downcast since most Services are decorated via Service.decorate(Function) and thus cannot be downcast. For example:

 Service s = new MyService().decorate(LoggingService.newDecorator())
                            .decorate(AuthService.newDecorator());
 MyService s1 = s.as(MyService.class);
 LoggingService s2 = s.as(LoggingService.class);
 AuthService s3 = s.as(AuthService.class);
 

Specified by:

as in interface Service<T_I extends Request,T_O extends Response>

Parameters:

serviceType - the type of the desired Service

Returns:

the Service which is an instance of serviceType if this Service decorated such a Service. Optional.empty() otherwise.

shouldCachePath

public boolean shouldCachePath(String path,
                               @Nullable
                               String query,
                               PathMapping pathMapping)

Description copied from interface: Service

Returns whether the given path and query should be cached if the service's result is successful. By default, exact path mappings with no input query are cached.

Specified by:

shouldCachePath in interface Service<T_I extends Request,T_O extends Response>

toString

public String toString()

Overrides:

toString in class Object