Package org.jboss.as.controller

Enum Class ControlledProcessState.State

java.lang.Object
java.lang.Enum<ControlledProcessState.State>
org.jboss.as.controller.ControlledProcessState.State
All Implemented Interfaces:
Serializable, Comparable<ControlledProcessState.State>, Constable
Enclosing class:
ControlledProcessState
public static enum ControlledProcessState.State extends Enum<ControlledProcessState.State>

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    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.
    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.
    RUNNING
    The process is started, is running normally and has a runtime state consistent with its persistent configuration.
    STARTING
    The process is starting and its runtime state is being made consistent with its persistent configuration.
    STOPPED
    The process is stopped
    STOPPING
    The process is stopping.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    String
    toString()
     
    static ControlledProcessState.State
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ControlledProcessState.State[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • 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.

    • STOPPING

      public static final ControlledProcessState.State STOPPING
      The process is stopping.

    • STOPPED

      public static final ControlledProcessState.State STOPPED
      The process is stopped

  • Method Details

    • values

      public static ControlledProcessState.State[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ControlledProcessState.State valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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.

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ControlledProcessState.State>