com.ibm.jtopenlite.command.program.perf

Class WorkWithCollector

java.lang.Object

com.ibm.jtopenlite.command.program.perf.WorkWithCollector

All Implemented Interfaces:

Program

public class WorkWithCollector
extends java.lang.Object
implements Program

Obtain performance data using the QPMWKCOL API.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_CHANGE
static java.lang.String	ACTION_END
static java.lang.String	ACTION_START
static int	COLLECT_120
static int	COLLECT_15
static int	COLLECT_240
static int	COLLECT_30
static int	COLLECT_60
static java.lang.String	RESOURCE_COMM
static java.lang.String	RESOURCE_DISK
static java.lang.String	RESOURCE_IOP
static java.lang.String	RESOURCE_JOB
static java.lang.String	RESOURCE_POOL

Constructor Summary

Constructors

Constructor and Description
WorkWithCollector(java.lang.String typeOfActionToPerform, java.lang.String typeOfResource, int timeBetweenCollections, java.lang.String userSpaceName, java.lang.String userSpaceLibrary)

Method Summary

Methods

Modifier and Type	Method and Description
int	getFirstSequenceNumber()
int	getNumberOfParameters() Returns the number of parameters for this program.
byte[]	getParameterInputData(int parmIndex) Returns the input data of the parameter at the specified index.
int	getParameterInputLength(int parmIndex) Returns the input length of the parameter at the specified index.
int	getParameterOutputLength(int parmIndex) Returns the output length of the parameter at the specified index.
int	getParameterType(int parmIndex) Returns the type of parameter at the specified index.
java.lang.String	getProgramLibrary() Returns the library of the program object.
java.lang.String	getProgramName() Returns the name of the program object.
byte[]	getTempDataBuffer() The implementor can create their own temp byte array for the output parameter size and reuse it each time a call is performed, or for more than one parameter on the same call.
int	getTimeBetweenCollections()
java.lang.String	getTypeOfActionToPerform()
java.lang.String	getTypeOfResource()
java.lang.String	getUserSpaceLibrary()
java.lang.String	getUserSpaceName()
void	newCall() Invoked before any other methods on this interface by CommandConnection whenever this Program is called.
void	setParameterOutputData(int parmIndex, byte[] data, int maxLength) Sets the output data for the parameter at the specified index.
void	setTimeBetweenCollections(int seconds)
void	setTypeOfActionToPerform(java.lang.String action)
void	setTypeOfResource(java.lang.String resource)
void	setUserSpaceLibrary(java.lang.String library)
void	setUserSpaceName(java.lang.String userSpace)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACTION_START

public static final java.lang.String ACTION_START

See Also:

Constant Field Values

ACTION_END

public static final java.lang.String ACTION_END

See Also:

Constant Field Values

ACTION_CHANGE

public static final java.lang.String ACTION_CHANGE

See Also:

Constant Field Values

RESOURCE_JOB

public static final java.lang.String RESOURCE_JOB

See Also:

Constant Field Values

RESOURCE_POOL

public static final java.lang.String RESOURCE_POOL

See Also:

Constant Field Values

RESOURCE_DISK

public static final java.lang.String RESOURCE_DISK

See Also:

Constant Field Values

RESOURCE_IOP

public static final java.lang.String RESOURCE_IOP

See Also:

Constant Field Values

RESOURCE_COMM

public static final java.lang.String RESOURCE_COMM

See Also:

Constant Field Values

COLLECT_15

public static final int COLLECT_15

See Also:

Constant Field Values

COLLECT_30

public static final int COLLECT_30

See Also:

Constant Field Values

COLLECT_60

public static final int COLLECT_60

See Also:

Constant Field Values

COLLECT_120

public static final int COLLECT_120

See Also:

Constant Field Values

COLLECT_240

public static final int COLLECT_240

See Also:

Constant Field Values

Constructor Detail

WorkWithCollector

public WorkWithCollector(java.lang.String typeOfActionToPerform,
                 java.lang.String typeOfResource,
                 int timeBetweenCollections,
                 java.lang.String userSpaceName,
                 java.lang.String userSpaceLibrary)

Method Detail

getProgramLibrary

public java.lang.String getProgramLibrary()

Description copied from interface: Program

Returns the library of the program object.

Specified by:

getProgramLibrary in interface Program

getProgramName

public java.lang.String getProgramName()

Description copied from interface: Program

Returns the name of the program object.

Specified by:

getProgramName in interface Program

newCall

public void newCall()

Description copied from interface: Program

Invoked before any other methods on this interface by CommandConnection whenever this Program is called.

Specified by:

newCall in interface Program

setTypeOfActionToPerform

public void setTypeOfActionToPerform(java.lang.String action)

getTypeOfActionToPerform

public java.lang.String getTypeOfActionToPerform()

setTypeOfResource

public void setTypeOfResource(java.lang.String resource)

getTypeOfResource

public java.lang.String getTypeOfResource()

setTimeBetweenCollections

public void setTimeBetweenCollections(int seconds)

getTimeBetweenCollections

public int getTimeBetweenCollections()

setUserSpaceName

public void setUserSpaceName(java.lang.String userSpace)

getUserSpaceName

public java.lang.String getUserSpaceName()

setUserSpaceLibrary

public void setUserSpaceLibrary(java.lang.String library)

getUserSpaceLibrary

public java.lang.String getUserSpaceLibrary()

getFirstSequenceNumber

public int getFirstSequenceNumber()

getNumberOfParameters

public int getNumberOfParameters()

Description copied from interface: Program

Returns the number of parameters for this program.

Specified by:

getNumberOfParameters in interface Program

getParameterInputLength

public int getParameterInputLength(int parmIndex)

Description copied from interface: Program

Returns the input length of the parameter at the specified index.

Specified by:

getParameterInputLength in interface Program

getParameterOutputLength

public int getParameterOutputLength(int parmIndex)

Description copied from interface: Program

Returns the output length of the parameter at the specified index.

Specified by:

getParameterOutputLength in interface Program

getParameterType

public int getParameterType(int parmIndex)

Description copied from interface: Program

Returns the type of parameter at the specified index.

Specified by:

getParameterType in interface Program

See Also:

Parameter

getTempDataBuffer

public byte[] getTempDataBuffer()

Description copied from interface: Program

The implementor can create their own temp byte array for the output parameter size and reuse it each time a call is performed, or for more than one parameter on the same call. The implementor can choose to ignore this, and simply return null. The command connection checks to see if the buffer returned by this method is not null and large enough to accommodate the output parameter size.

Specified by:

getTempDataBuffer in interface Program

getParameterInputData

public byte[] getParameterInputData(int parmIndex)

Description copied from interface: Program

Returns the input data of the parameter at the specified index.

Specified by:

getParameterInputData in interface Program

setParameterOutputData

public void setParameterOutputData(int parmIndex,
                          byte[] data,
                          int maxLength)

Description copied from interface: Program

Sets the output data for the parameter at the specified index.

Specified by:

setParameterOutputData in interface Program