Package com.linecorp.armeria.common.grpc

Interface GoogleGrpcStatusFunction

All Superinterfaces:

GrpcStatusFunction

@UnstableApi
public interface GoogleGrpcStatusFunction
extends GrpcStatusFunction

A GrpcStatusFunction that provides a way to include details of a status into a Metadata. You can implement a mapping function to convert Throwable into a Status which is stored in the `grpc-status-details-bin` key in the Metadata. If a given Throwable is an instance of either StatusRuntimeException or StatusException, the Status retrieved from the exception is returned with higher priority.

Method Summary

Modifier and Type	Method	Description
default @Nullable Status	apply(RequestContext ctx, Throwable throwable, Metadata metadata)	Maps the specified Throwable to a gRPC Status, and mutates the specified Metadata.
@Nullable com.google.rpc.Status	applyStatusProto(RequestContext ctx, Throwable throwable, Metadata metadata)	Maps the specified Throwable to a Status, and mutates the specified Metadata.

Method Details

apply

@Nullable
default @Nullable Status apply(RequestContext ctx,
 Throwable throwable,
 Metadata metadata)

Description copied from interface: GrpcStatusFunction

Maps the specified Throwable to a gRPC Status, and mutates the specified Metadata. If null is returned, the built-in mapping rule is used by default.

Specified by:

apply in interface GrpcStatusFunction

applyStatusProto

@Nullable com.google.rpc.Status applyStatusProto(RequestContext ctx,
 Throwable throwable,
 Metadata metadata)

Maps the specified Throwable to a Status, and mutates the specified Metadata. The `grpc-status-details-bin` key is ignored since it will be overwritten by apply(RequestContext, Throwable, Metadata). If null is returned, the built-in mapping rule is used by default.