IBM Rational Performance Tester SDK

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


public interface IVirtualUserInfo

The IVirtualUserInfo interface provides information about the virtual user.

This interface is implemented by the object stored in the VirtualUserDataArea DataArea under the key VirtualUserInfo. This object is accessed from ICustomCode2 by calling ITestExecutionServices.findDataArea(IDataArea.VIRTUALUSER).get(IVirtualUserInfo.KEY)

See Also:
IDataArea, ITestExecutionServices

Field Summary
static String KEY
          Key for the supplied IVirtualUserInfo object in the virtual user's DataArea.
 
Method Summary
 InetAddress getIPAddress()
          Return the IP address being used by this virtual user if IP Aliasing is enabled.
 InetAddress getIPv4Address()
          Return the IPv4 address being used by this virtual user if IP Aliasing is enabled.
 InetAddress getIPv6UnicastAddress()
          Return the IPv6 Unicast address being used by this virtual user if IP Aliasing is enabled.
 int getPDLogLevel()
          Returns the Problem Determination Log level that is effective for the current test.
 Random getRandom()
          Returns the virtual user's random number generator.
 int getTestLogLevel()
          Returns the TestLog level that is effective for all events for the current test.
 int getTestLogLevel(int filter)
          Returns the TestLog level for the given filter that is effective for the current test.
 int getUID()
          Returns the virtual user's globally unique id.
 int getUserGroupIndex()
          Returns the index of this virtual user within this virtual user's user group.
 String getUserGroupName()
          Returns the name of the user group to which this virtual user belongs.
 String getUserName()
          Returns the name of the virtual user.
 int popPDLogLevel()
          Pops the Problem Determination Log level stack.
 int popTestLogLevel()
          Pops the stack for the TestLog level for all events.
 int popTestLogLevel(int filter)
          Pops the stack for the TestLog level for the given filter.
 void pushPDLogLevel(int level)
          Pushes the given Problem Determination Log level onto the virtual user's stack.
 void pushTestLogLevel(int level)
          Pushes the given TestLog level for all events onto the test's stack.
 void pushTestLogLevel(int level, int filter)
          Pushes the given TestLog level for the given filter onto the test's stack.
 InetAddress setIPAddress(InetAddress addr)
          Set the IP address used by this virtual user if IP Aliasing is enabled.
 InetAddress setIPv4Address(InetAddress addr)
          Set the IPv4 address used by this virtual user if IP Aliasing is enabled.
 InetAddress setIPv6UnicastAddress(InetAddress addr)
          Set the IPv6 Unicast address used by this virtual user if IP Aliasing is enabled.
 int setPDLogLevel(int level)
          Sets the Problem Determination Log level for the remainder of the current virtual user to the given level.
 int setTestLogLevel(int level)
          Sets the TestLog level for all events for the remainder of the current test to the given level.
 int setTestLogLevel(int level, int filter)
          Sets the TestLog level for the given filter for the remainder of the current test to the given level.
 

Field Detail

KEY

static final String KEY
Key for the supplied IVirtualUserInfo object in the virtual user's DataArea.

See Also:
Constant Field Values
Method Detail

getRandom

Random getRandom()
Returns the virtual user's random number generator.

Returns:
The virtual user's random number generator.

getUID

int getUID()
Returns the virtual user's globally unique id. This number is unique across all drivers and is valid for the duration of a test run.

Returns:
The GUID associated with the current virtual user for the current test run.

getUserName

String getUserName()
Returns the name of the virtual user.

Returns:
The name of the virtual user.

getUserGroupName

String getUserGroupName()
Returns the name of the user group to which this virtual user belongs.

Returns:
The name of the user group to which this virtual user belongs.

getUserGroupIndex

int getUserGroupIndex()
Returns the index of this virtual user within this virtual user's user group.

Returns:
The index of this virtual user within this virtual user's user group.

getPDLogLevel

int getPDLogLevel()
Returns the Problem Determination Log level that is effective for the current test.

Returns:
The Problem Determination Log level that is effective for the current test.

setPDLogLevel

int setPDLogLevel(int level)
Sets the Problem Determination Log level for the remainder of the current virtual user to the given level.

The Problem Determination Log level is kept on a stack for the virtual user. Setting the level is equivalent to popping the stack (if it is not empty) and pushing the new level.

Parameters:
level - The new Problem Determination Log level.
Returns:
The old Problem Determination Log level.
See Also:
IVirtualUserInfo.pushPDLogLevel(int), IVirtualUserInfo.popPDLogLevel()

pushPDLogLevel

void pushPDLogLevel(int level)
Pushes the given Problem Determination Log level onto the virtual user's stack.

This changes the effective Problem Determination Log level for the remainder of the virtual user's execution.

Parameters:
level - The new Problem Determination Log level.
See Also:
IVirtualUserInfo.popPDLogLevel()

popPDLogLevel

int popPDLogLevel()
Pops the Problem Determination Log level stack.

This restores the effective Problem Determination Log level to the value previous to the last push.

Returns:
The popped level
See Also:
IVirtualUserInfo.pushPDLogLevel(int)

getTestLogLevel

int getTestLogLevel()
Returns the TestLog level that is effective for all events for the current test.

Returns:
The TestLog level that is effective for the current test.

getTestLogLevel

int getTestLogLevel(int filter)
Returns the TestLog level for the given filter that is effective for the current test.

Parameters:
filter - The filter specifying the TestLog level to get.
Returns:
The TestLog level that is effective for the current test.

setTestLogLevel

int setTestLogLevel(int level)
Sets the TestLog level for all events for the remainder of the current test to the given level.

The TestLog level is kept on a stack for the test. Setting the level is equivalent to popping the stack (if it is not empty) and pushing the new level.

Parameters:
level - The new TestLog level.
Returns:
The old TestLog level.
See Also:
IVirtualUserInfo.pushTestLogLevel(int), IVirtualUserInfo.popTestLogLevel()

setTestLogLevel

int setTestLogLevel(int level,
                    int filter)
Sets the TestLog level for the given filter for the remainder of the current test to the given level.

The TestLog level is kept on a stack for the test. Setting the level is equivalent to popping the stack (if it is not empty) and pushing the new level.

Parameters:
level - The new TestLog level.
filter - The filter specifying the TestLog level to set.
Returns:
The old TestLog level.
See Also:
IVirtualUserInfo.pushTestLogLevel(int), IVirtualUserInfo.popTestLogLevel()

pushTestLogLevel

void pushTestLogLevel(int level)
Pushes the given TestLog level for all events onto the test's stack.

This changes the effective TestLog level for the remainder of the test.,/p>

Parameters:
level - The new TestLog level.
See Also:
IVirtualUserInfo.popTestLogLevel()

pushTestLogLevel

void pushTestLogLevel(int level,
                      int filter)
Pushes the given TestLog level for the given filter onto the test's stack.

This changes the effective TestLog level for the remainder of the test.,/p>

Parameters:
level - The new TestLog level.
filter - The filter specifying the TestLog level to push.
See Also:
IVirtualUserInfo.popTestLogLevel()

popTestLogLevel

int popTestLogLevel()
Pops the stack for the TestLog level for all events.

This restores the effective TestLog level to its value before the last push.

Returns:
The popped level.
See Also:
IVirtualUserInfo.pushTestLogLevel(int)

popTestLogLevel

int popTestLogLevel(int filter)
Pops the stack for the TestLog level for the given filter.

This restores the effective TestLog level to its value before the last push.

Parameters:
filter - The filter specifying the TestLog level to pop.
Returns:
The popped level.
See Also:
IVirtualUserInfo.pushTestLogLevel(int)

getIPAddress

InetAddress getIPAddress()
Return the IP address being used by this virtual user if IP Aliasing is enabled.

Returns:
InetAddress if IP Aliasing enabled, null if not.

setIPAddress

InetAddress setIPAddress(InetAddress addr)
Set the IP address used by this virtual user if IP Aliasing is enabled.

Returns:
The current InetAddress if IP Aliasing enabled, null if not.

getIPv4Address

InetAddress getIPv4Address()
Return the IPv4 address being used by this virtual user if IP Aliasing is enabled.

Returns:
Inetv4Address if IP Aliasing enabled, null if not.

setIPv4Address

InetAddress setIPv4Address(InetAddress addr)
Set the IPv4 address used by this virtual user if IP Aliasing is enabled.

Returns:
The current Inetv4Address if IP Aliasing enabled, null if not.

getIPv6UnicastAddress

InetAddress getIPv6UnicastAddress()
Return the IPv6 Unicast address being used by this virtual user if IP Aliasing is enabled.

Returns:
Inetv6UnicastAddress if IP Aliasing enabled, null if not.

setIPv6UnicastAddress

InetAddress setIPv6UnicastAddress(InetAddress addr)
Set the IPv6 Unicast address used by this virtual user if IP Aliasing is enabled.

Returns:
The current Inetv6UnicastAddress if IP Aliasing enabled, null if not.

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.