com.linecorp.armeria.server.throttling

Class AbstractThrottlingService<I extends Request,O extends Response>

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Service<T_I,T_O>>

com.linecorp.armeria.server.DecoratingService<I,O,I,O>

com.linecorp.armeria.server.SimpleDecoratingService<I,O>

com.linecorp.armeria.server.throttling.AbstractThrottlingService<I,O>

All Implemented Interfaces:

Unwrappable, Service<I,O>

Direct Known Subclasses:

ThrottlingRpcService, ThrottlingService

public abstract class AbstractThrottlingService<I extends Request,O extends Response>
extends SimpleDecoratingService<I,O>

Decorates a Service to throttle incoming requests.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractThrottlingService(Service<I,O> delegate, ThrottlingStrategy<I> strategy, Function<CompletionStage<? extends O>,O> responseConverter) Creates a new instance that decorates the specified Service.

Method Summary

Modifier and Type	Method and Description
protected abstract O	onFailure(ServiceRequestContext ctx, I req, Throwable cause) Invoked when req is throttled.
protected O	onSuccess(ServiceRequestContext ctx, I req) Invoked when req is not throttled.
O	serve(ServiceRequestContext ctx, I req) Serves an incoming Request.

Methods inherited from class com.linecorp.armeria.server.DecoratingService

serviceAdded, shouldCachePath

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, delegate, 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

as, decorate

Constructor Detail

AbstractThrottlingService

protected AbstractThrottlingService(Service<I,O> delegate,
                                    ThrottlingStrategy<I> strategy,
                                    Function<CompletionStage<? extends O>,O> responseConverter)

Creates a new instance that decorates the specified Service.

Method Detail

onSuccess

protected O onSuccess(ServiceRequestContext ctx,
                      I req)
               throws Exception

Invoked when req is not throttled. By default, this method delegates the specified req to the AbstractUnwrappable.delegate() of this service.

Throws:

Exception

onFailure

protected abstract O onFailure(ServiceRequestContext ctx,
                               I req,
                               Throwable cause)
                        throws Exception

Invoked when req is throttled. By default, this method responds with the HttpStatus.SERVICE_UNAVAILABLE status.

Throws:

Exception

serve

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

Description copied from interface: Service

Serves an incoming Request.

Parameters:

ctx - the context of the received Request

req - the received Request

Returns:

the Response

Throws:

Exception