Interface HealthCheckService

  • All Known Implementing Classes:
    DefaultHealthCheckService

    public interface HealthCheckService
    Service designed to be called periodically by Token to report health of the API.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void healthCheck​(java.lang.String bankId)
      An empty implementation checks that integration service is running and is accessible from TokenOS.
    • Method Detail

      • healthCheck

        void healthCheck​(@Nullable
                         java.lang.String bankId)
        An empty implementation checks that integration service is running and is accessible from TokenOS. An implementation may optionally include checks on internal services.

        To report the unhealthy status, an implementation of this method should throw StatusRuntimeException with Status.UNAVAILABLE.

        Parameters:
        bankId - bank id (used only for integrations covering multiple banks)