com.ibm.rational.test.lt.recorder.core.session

Enum RecordingSessionState

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      CONVERTING
      The session is terminated, and the persistence file is being upgraded to the current version format.
      DEPLOYING
      The session has been started and is currently launching additional processes for executing the recording components that need to be executed in a separate process.
      INITIAL
      The session has not been started yet.
      LOCKED
      The session is terminated and password-protected, and the passphrase has not been provided.
      RUNNING
      The session has been started, the recorders are ready and the clients are all started.
      STARTING_CLIENTS
      The session has been started, the recorders are ready to capture data, and the clients are being launched.
      STARTING_RECORDERS
      The session has been started and the recorders are being started.
      STOPPING_CLIENTS
      The session is about to stop and is waiting for all clients to stop.
      STOPPING_RECORDERS
      The session is about to stop and is waiting for all recorders to stop.
      TERMINATED
      The session is terminated, and the persistence file is complete.
      UNDEPLOYING
      The session is about to stop and is waiting for any extra process it has created to terminate.
    • Enum Constant Detail

      • INITIAL

        public static final RecordingSessionState INITIAL
        The session has not been started yet. This is the initial state of a recording session. A session cannot go back to this state once it has been started.
      • DEPLOYING

        public static final RecordingSessionState DEPLOYING
        The session has been started and is currently launching additional processes for executing the recording components that need to be executed in a separate process.
      • STARTING_RECORDERS

        public static final RecordingSessionState STARTING_RECORDERS
        The session has been started and the recorders are being started.
      • STARTING_CLIENTS

        public static final RecordingSessionState STARTING_CLIENTS
        The session has been started, the recorders are ready to capture data, and the clients are being launched.
      • RUNNING

        public static final RecordingSessionState RUNNING
        The session has been started, the recorders are ready and the clients are all started.
      • STOPPING_CLIENTS

        public static final RecordingSessionState STOPPING_CLIENTS
        The session is about to stop and is waiting for all clients to stop.
      • STOPPING_RECORDERS

        public static final RecordingSessionState STOPPING_RECORDERS
        The session is about to stop and is waiting for all recorders to stop.
      • UNDEPLOYING

        public static final RecordingSessionState UNDEPLOYING
        The session is about to stop and is waiting for any extra process it has created to terminate.
      • TERMINATED

        public static final RecordingSessionState TERMINATED
        The session is terminated, and the persistence file is complete.
      • CONVERTING

        public static final RecordingSessionState CONVERTING
        The session is terminated, and the persistence file is being upgraded to the current version format.
      • LOCKED

        public static final RecordingSessionState LOCKED
        The session is terminated and password-protected, and the passphrase has not been provided.
    • Method Detail

      • values

        public static RecordingSessionState[] 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 (RecordingSessionState c : RecordingSessionState.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static RecordingSessionState 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
      • getLabel

        public String getLabel()
        Returns a localized label for the state (can be displayed to the user).
        Returns:
        a localized label for the state.
IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2013. All rights reserved.