IBM Rational Performance Tester TES

com.ibm.rational.test.lt.kernel.services
Interface IEngineInfo


public interface IEngineInfo

The IEngineInfo interface provides information about the performance testing execution engine.

IEngineInfo is the interface implemented by the object stored in the EngineDataArea DataArea under the key EngineInfo. This object is accessed from ICustomCode2 by calling ITestExecutionServices.findDataArea(IDataArea.ENGINE).get(IEngineInfo.KEY)

See Also:
IDataArea, ITestExecutionServices

Field Summary
static String KEY
          Key for the IEngineInfo object in the engine's DataArea that is provided by IBM Rational Performance Tester.
 
Method Summary
 int getActiveUsers()
           
 int getCompletedUsers()
           
 String getDeploymentDirectory()
           
 String getHostName()
           
 com.ibm.rational.test.lt.kernel.impl.KNetworkInterface getNetworkInterface()
           
 int getScheduleActiveUsers()
          This method returns the number of active users in the schedule as of the last update from the workbench.
 int getScheduleActiveUsers(String group)
          This method returns the number of active users in the given user group as of the last update from the workbench.
 int getScheduleUsers()
          This method returns the number of users assigned to the schedule as of the last update from the workbench.
 int getScheduleUsers(String group)
          This method returns the number of users assigned to the given user group as of the last update from the workbench.
 String[] getUserGroups()
           
 String getWorkBenchHostName()
          get Workbench host name.
 String getWorkBenchUserId()
          get Workbench user id.
 

Field Detail

KEY

static final String KEY
Key for the IEngineInfo object in the engine's DataArea that is provided by IBM Rational Performance Tester.

See Also:
Constant Field Values
Method Detail

getActiveUsers

int getActiveUsers()
Returns:
The number of virtual users currently running in this engine.

getCompletedUsers

int getCompletedUsers()
Returns:
The number of virtual users in this engine that have completed.

getHostName

String getHostName()
Returns:
The hostname of the computer on which this engine is running.

getDeploymentDirectory

String getDeploymentDirectory()
Returns:
The local directory in which IBM Rational Performance Tester deployed all test assets.

getWorkBenchUserId

String getWorkBenchUserId()
get Workbench user id.

Returns:
the user id of the user running the workbench.

getWorkBenchHostName

String getWorkBenchHostName()
get Workbench host name.

Returns:
the hostname of the host directing the test.

getNetworkInterface

com.ibm.rational.test.lt.kernel.impl.KNetworkInterface getNetworkInterface()
Returns:
The kernel network interface for this driver.

getUserGroups

String[] getUserGroups()
Returns:
An array containing all the user groups present in the current schedule

getScheduleActiveUsers

int getScheduleActiveUsers()
This method returns the number of active users in the schedule as of the last update from the workbench. The workbench updates the engine with this information every 5 seconds.

Returns:
The total number of active users in the current schedule.

getScheduleActiveUsers

int getScheduleActiveUsers(String group)
This method returns the number of active users in the given user group as of the last update from the workbench. The workbench updates the engine with this information every 5 seconds.

If the specified group is either null or does not exist, throws IllegalArgumentException.

Parameters:
group - The name of the group of interest.
Returns:
The total number of active users in the given user group.

getScheduleUsers

int getScheduleUsers()
This method returns the number of users assigned to the schedule as of the last update from the workbench. The workbench updates the engine with this information every 5 seconds. The number returned includes all users assigned but not yet started, currently running, completed and stopped.

Returns:
The total number of users assigned to the current schedule.

getScheduleUsers

int getScheduleUsers(String group)
This method returns the number of users assigned to the given user group as of the last update from the workbench. The workbench updates the engine with this information every 5 seconds. The number returned includes all users assigned but not yet started, currently running, completed and stopped.

If the specified group is either null or does not exist, throws IllegalArgumentException.

Parameters:
group - The name of the group of interest.
Returns:
The total number of users assigned to the given user group.

IBM Rational Performance Tester TES

© Copyright IBM Corp. 2012. All rights reserved.