Package com.linecorp.armeria.server.throttling

Class ThrottlingHttpService

java.lang.Object

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

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

com.linecorp.armeria.server.throttling.ThrottlingService<HttpRequest,HttpResponse>

com.linecorp.armeria.server.throttling.ThrottlingHttpService

All Implemented Interfaces:

Service<HttpRequest,HttpResponse>

public class ThrottlingHttpService
extends ThrottlingService<HttpRequest,HttpResponse>

Decorates a HTTP Service to throttle incoming requests.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ThrottlingHttpService(Service<HttpRequest,HttpResponse> delegate, ThrottlingStrategy<HttpRequest> strategy)	Creates a new instance that decorates the specified Service.

Method Summary

Modifier and Type	Method	Description
static Function<Service<HttpRequest,HttpResponse>,ThrottlingHttpService>	newDecorator(ThrottlingStrategy<HttpRequest> strategy)	Creates a new decorator using the specified ThrottlingStrategy instance.
protected HttpResponse	onFailure(ServiceRequestContext ctx, HttpRequest req, Throwable cause)	Invoked when req is throttled.

Methods inherited from class com.linecorp.armeria.server.throttling.ThrottlingService

onSuccess, serve

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

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

Constructor Detail

ThrottlingHttpService

protected ThrottlingHttpService(Service<HttpRequest,HttpResponse> delegate,
                                ThrottlingStrategy<HttpRequest> strategy)

Creates a new instance that decorates the specified Service.

Method Detail

newDecorator

public static Function<Service<HttpRequest,HttpResponse>,ThrottlingHttpService> newDecorator(ThrottlingStrategy<HttpRequest> strategy)

Creates a new decorator using the specified ThrottlingStrategy instance.

Parameters:

strategy - The ThrottlingStrategy instance to be used

onFailure

protected HttpResponse onFailure(ServiceRequestContext ctx,
                                 HttpRequest req,
                                 @Nullable
                                 Throwable cause)
                          throws Exception

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

Specified by:

onFailure in class ThrottlingService<HttpRequest,HttpResponse>

Throws:

Exception