Enum ControlledProcessState.State

    • Enum Constant Detail

      • STARTING

        public static final ControlledProcessState.State STARTING
        The process is starting and its runtime state is being made consistent with its persistent configuration.
      • RUNNING

        public static final ControlledProcessState.State RUNNING
        The process is started, is running normally and has a runtime state consistent with its persistent configuration.
      • RELOAD_REQUIRED

        public static final ControlledProcessState.State RELOAD_REQUIRED
        The process requires a stop and re-start of its root service (but not a full process restart) in order to ensure stable operation and/or to bring its running state in line with its persistent configuration. A stop and restart of the root service (also known as a 'reload') will result in the removal of all other services and creation of new services based on the current configuration, so its affect on availability to handle external requests is similar to that of a full process restart. However, a reload can execute more quickly than a full process restart.
      • RESTART_REQUIRED

        public static final ControlledProcessState.State RESTART_REQUIRED
        The process must be terminated and replaced with a new process in order to ensure stable operation and/or to bring the running state in line with the persistent configuration.
    • Method Detail

      • values

        public static ControlledProcessState.State[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ControlledProcessState.State c : ControlledProcessState.State.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ControlledProcessState.State valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • isRunning

        public boolean isRunning()
        Gets whether this state represents a process that is fully 'running'; i.e. it is not still starting and has not begun or completed stopping. The RUNNING, RELOAD_REQUIRED and RESTART_REQUIRED states are all 'running', just with different relationships between the currently running process configuration and its persistent configuration.
        Returns:
        true if the state indicates the process if fully running.