Package org.mockserver.grpc

Class GrpcHealthCheckHandler

java.lang.Object

org.mockserver.grpc.GrpcHealthCheckHandler

public class GrpcHealthCheckHandler
extends Object

Handles grpc.health.v1.Health/Check requests without a proto descriptor. Decodes the HealthCheckRequest manually (field 1 = service string), looks up the ServingStatus from GrpcHealthRegistry, and encodes the HealthCheckResponse manually (field 1 = status enum varint).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HEALTH_CHECK_PATH

Constructor Summary

Constructors

Constructor	Description
GrpcHealthCheckHandler(GrpcHealthRegistry registry)

Method Summary

Modifier and Type	Method	Description
String	decodeServiceName(byte[] grpcFramedBody)	Decodes a HealthCheckRequest from gRPC-framed bytes and returns the service name.
byte[]	encodeResponse(ServingStatus status)	Encodes a HealthCheckResponse as gRPC-framed bytes.
ServingStatus	getStatus(String serviceName)	Returns the ServingStatus for the given service name from this handler's registry.
boolean	isHealthCheckRequest(String path)	Returns true if the request path matches the health check path.
boolean	isRegistered(String serviceName)	Returns whether Check for this service name should succeed at all.

Methods inherited from class java.lang.Object

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

Field Details

HEALTH_CHECK_PATH

public static final String HEALTH_CHECK_PATH

See Also:

• Constant Field Values

Constructor Details

GrpcHealthCheckHandler

public GrpcHealthCheckHandler(GrpcHealthRegistry registry)

Method Details

isHealthCheckRequest

public boolean isHealthCheckRequest(String path)

Returns true if the request path matches the health check path.

getStatus

public ServingStatus getStatus(String serviceName)

Returns the ServingStatus for the given service name from this handler's registry. Delegates to the registry so tests using a non-singleton registry get correct results.

isRegistered

public boolean isRegistered(String serviceName)

Returns whether Check for this service name should succeed at all.

grpc.health.v1.Health/Check is specified to fail the RPC with status NOT_FOUND when the client asks about a service the server does not know about, rather than returning a HealthCheckResponse. Callers must consult this before getStatus(java.lang.String) and, when it returns false, respond with a NOT_FOUND status and no message body.

decodeServiceName

public String decodeServiceName(byte[] grpcFramedBody)

Decodes a HealthCheckRequest from gRPC-framed bytes and returns the service name. Returns empty string if the body is null/empty or cannot be decoded.

encodeResponse

public byte[] encodeResponse(ServingStatus status)

Encodes a HealthCheckResponse as gRPC-framed bytes. HealthCheckResponse { ServingStatus status = 1; }