Package com.linecorp.armeria.common

Interface SuccessFunction

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@UnstableApi
public interface SuccessFunction

A function that determines whether a Client and Service handled a request successfully or not. This function can be used by the decorators like the following to determine whether the request was handled successfully or not:

• MetricCollectingClient
• MetricCollectingService
• LoggingClient
• LoggingService

Example:

 ServerBuilder sb = Server
         .builder()
         .successFunction((ctx, req) -> req.responseHeaders().status().code() == 200 ||
                                        req.responseHeaders().status().code() == 404)
         .decorator(MetricCollectingService.newDecorator(MeterIdPrefixFunction.ofDefault("myServer")))
         .decorator(LoggingService.newDecorator()));

 WebClient client = WebClient
         .builder(uri)
         .successFunction((ctx, req) -> req.responseHeaders().status().code() == 200 ||
                                        req.responseHeaders().status().code() == 404)
         .decorator(MetricCollectingClient.newDecorator(MeterIdPrefixFunction.ofDefault("myClient")))
         .decorator(LoggingClient.newDecorator()))
         .build();
 
 

Method Summary

Modifier and Type	Method	Description
static SuccessFunction	always()	Returns a SuccessFunction that will always return true.
boolean	isSuccess(RequestContext ctx, RequestLog log)	Returns true if the request was handled successfully.
static SuccessFunction	never()	Returns a SuccessFunction that will always return false.
static SuccessFunction	ofDefault()	Returns the default success classification function which checks RequestLog.responseCause() is null, 100 <= HttpStatus < 400 and RpcResponse.isCompletedExceptionally() == false.

Method Details

never

static SuccessFunction never()

Returns a SuccessFunction that will always return false.

always

static SuccessFunction always()

Returns a SuccessFunction that will always return true.

ofDefault

static SuccessFunction ofDefault()

Returns the default success classification function which checks RequestLog.responseCause() is null, 100 <= HttpStatus < 400 and RpcResponse.isCompletedExceptionally() == false.

isSuccess

boolean isSuccess(RequestContext ctx,
 RequestLog log)

Returns true if the request was handled successfully.

See Also:

• ServerBuilder.successFunction(SuccessFunction)
• ClientBuilder.successFunction(SuccessFunction)