Package org.apache.cassandra.service

Interface StartupCheck

All Known Implementing Classes:
DataResurrectionCheck, FileSystemOwnershipCheck
public interface StartupCheck
A test to determine if the system is in a valid state to start up. Some implementations may not actually halt startup, but provide information or advice on tuning and non-fatal environmental issues (e.g. like checking for and warning about suboptimal JVM settings). Other checks may indicate that the system is not in a correct state to be started. Examples include missing or unaccessible data directories, unreadable sstables and misconfiguration of cluster_name in cassandra.yaml. The StartupChecks class manages a collection of these tests, which it executes right at the beginning of the server setup process.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute(StartupChecksOptions startupChecksOptions)
    Run some test to determine whether the system is safe to be started In the case where a test determines it is not safe to proceed, the test should log a message regarding the reason for the failure and ideally the steps required to remedy the problem.
    default StartupChecks.StartupCheckType
    getStartupCheckType()
     
    default void
    postAction(StartupChecksOptions options)
    Post-hook after all startup checks succeeded.

  • Method Details

    • execute

      void execute(StartupChecksOptions startupChecksOptions) throws StartupException
      Run some test to determine whether the system is safe to be started In the case where a test determines it is not safe to proceed, the test should log a message regarding the reason for the failure and ideally the steps required to remedy the problem.
      Parameters:
      startupChecksOptions - all options from descriptor
      Throws:
      StartupException - if the test determines that the environement or system is not in a safe state to startup

    • getStartupCheckType

      default StartupChecks.StartupCheckType getStartupCheckType()
      Returns:
      type of this startup check for configuration retrieval

    • postAction

      default void postAction(StartupChecksOptions options)
      Post-hook after all startup checks succeeded.
      Parameters:
      options - startup check options from descriptor