Package org.craftercms.engine.service

Interface SiteHealthCheckService

All Known Implementing Classes:
SiteHealthCheckServiceImpl
public interface SiteHealthCheckService
Service to provide health check status.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    healthCheck()
    Determine if current engine has valid healthy sites Engine has valid healthy sites when: 1.
    boolean
    healthCheck(String site)
    Performs the health checks for the given site.

  • Method Details

    • healthCheck

      boolean healthCheck()
      Determine if current engine has valid healthy sites Engine has valid healthy sites when: 1. There are no sites at all 2. There is one or more valid healthy site
      Returns:
      true if engine has healthy sites, false otherwise

    • healthCheck

      boolean healthCheck(String site)
      Performs the health checks for the given site.
      Parameters:
      site - the site to check.
      Returns:
      true if all the health checks pass, false otherwise.