Class HealthStatusManager

    • Field Detail


        public static final String SERVICE_NAME_ALL_SERVICES
        The special "service name" that represent all services on a GRPC server. It is an empty string.
        See Also:
        Constant Field Values
    • Constructor Detail

      • HealthStatusManager

        public HealthStatusManager()
        Creates a new health service instance.
    • Method Detail

      • getHealthService

        public BindableService getHealthService()
        Gets the health check service created in the constructor.
      • clearStatus

        public void clearStatus​(String service)
        Clears the health status record of a service. The health service will respond with NOT_FOUND error on checking the status of a cleared service.
        service - the name of some aspect of the server that is associated with a health status. This name can have no relation with the gRPC services that the server is running with. It can also be an empty String "" per the gRPC specification.
      • enterTerminalState

        public void enterTerminalState()
        enterTerminalState causes the health status manager to mark all services as not serving, and prevents future updates to services. This method is meant to be called prior to server shutdown as a way to indicate that clients should redirect their traffic elsewhere.