A B C D E F G I L M N O P R S T U

A

addTracePoint(byte[], byte[], byte[], int) - Method in class com.ibm.iseries.collectionservices.PerformanceDataReporter
If reporting was turned on for this instance of PerformanceDataReporter class (see enableReporting method), this method will cause a generic trace record to be logged.
addTracePoint(byte[], byte[], String) - Method in class com.ibm.iseries.collectionservices.PerformanceDataReporter
If reporting was turned on for this instance of PerformanceDataReporter class (see enableReporting method), this method will cause a generic trace record to be logged.

B

bytesProvided - Variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
In this field data collection method indicates how many bytes from collectedData array should be used by Collection Services.
bytesReturned - Variable in class com.ibm.iseries.collectionservices.MgtcolObjRecInfo
Number of bytes of data, actually returned by readData() method of MgtcolObjClass.

C

CALL_CONTINUE - Static variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
This is a constant value for requestModifier field.
CALL_NORMAL - Static variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
This is a constant value for requestModifier field.
categoryName - Variable in class com.ibm.iseries.collectionservices.MgtcolObjRepositoryEntry
10 character name of a performance collection category which created this repository.
categoryName - Variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
Name of a user-defined category for which data collection is performed.
categoryParameter - Variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
This is a parameter string, specified when user-defined category was registered.
close() - Method in class com.ibm.iseries.collectionservices.MgtcolObj
This method will close Management Collection Object, previously opened by open() method.
closeRepository(int) - Method in class com.ibm.iseries.collectionservices.MgtcolObj
This method will close repository of Management Collection Object, previously opened by openRepository() method.
collectedData - Variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
In this field data collection method returns collected data.
collectionInfo - Variable in class com.ibm.iseries.collectionservices.MgtcolObjRepositoryEntry
This array contains collection period entries for repository of a Management Collection Object.
CONTROL_RECORD - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjRecInfo
This is a constant value for recType field.
copyright - Static variable in class com.ibm.iseries.collectionservices.PerformanceDataReporter
 
copyright - Static variable in class com.ibm.iseries.collectionservices.MgtcolObj
 

D

DataCollectionProgram - interface com.ibm.iseries.collectionservices.DataCollectionProgram.
This interface defines methods which Java data collection program must implement to interface to Collection Services support for user-defined categories.
DataCollectionRequest - class com.ibm.iseries.collectionservices.DataCollectionRequest.
This class defines a set of parameters, which are passed to methods of DataCollectionProgram interface.
DataCollectionRequest() - Constructor for class com.ibm.iseries.collectionservices.DataCollectionRequest
 
dataLimit - Variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
This is a maximum number of bytes of data collection method is allowed to return in collectedData parameter.
dftInterval - Variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
Default collection interval in seconds for this collection object.
disableReporting() - Method in class com.ibm.iseries.collectionservices.PerformanceDataReporter
This method disables reporting of performance data for this instance of PerformanceDataReporter class.
doBegin(DataCollectionRequest) - Method in interface com.ibm.iseries.collectionservices.DataCollectionProgram
Start Collection request.
doCollect(DataCollectionRequest) - Method in interface com.ibm.iseries.collectionservices.DataCollectionProgram
Interval Collection request.
doEnd(DataCollectionRequest) - Method in interface com.ibm.iseries.collectionservices.DataCollectionProgram
End Collection request.
doShutdown(DataCollectionRequest) - Method in interface com.ibm.iseries.collectionservices.DataCollectionProgram
Cleanup and Terminate (Shutdown) request.

E

enableReporting() - Method in class com.ibm.iseries.collectionservices.PerformanceDataReporter
This method enables reporting of performance data for this instance of PerformanceDataReporter class.
endTime - Variable in class com.ibm.iseries.collectionservices.MgtcolObjCollectionEntry
Date and time when either collection was ended or collection interval was changed for a performance category associated with this repository.
endTransaction(byte[], int, byte[], int, long[], long[]) - Method in class com.ibm.iseries.collectionservices.PerformanceDataReporter
If reporting was turned on for this instance of PerformanceDataReporter class (see enableReporting method), this method will cause performance data to be collected for end of transaction.
endTransaction(byte[], int, String, long[], long[]) - Method in class com.ibm.iseries.collectionservices.PerformanceDataReporter
If reporting was turned on for this instance of PerformanceDataReporter class (see enableReporting method), this method will cause performance data to be collected for end of transaction.

F

format - Variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
Format of a parameter structure passed to a data collection program.
FORMAT_01 - Static variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
This is a constant value for format field,

G

getLibrary() - Method in class com.ibm.iseries.collectionservices.MgtcolObj
 
getName() - Method in class com.ibm.iseries.collectionservices.MgtcolObj
 

I

interval - Variable in class com.ibm.iseries.collectionservices.MgtcolObjCollectionEntry
Collection interval in seconds for a performance category, which created this repository.
INTERVAL_RECORD - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjRecInfo
This is a constant value for recType field.
intervalKey - Variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
Record key of a repository record about to be written into Management Collection Object.
intervalTimestamp - Variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
Time when Collection Services collector initiated a particular request in a system timestamp format.
isActive - Variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
Indicates whether collection is in progress for this collection object.
isPDCActive() - Static method in class com.ibm.iseries.collectionservices.PerformanceDataReporter
This method tests if this thread is in an active PDC trace collection.
isRepaired - Variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
Indicates whether collection object required repair.
isReportingEnabled() - Method in class com.ibm.iseries.collectionservices.PerformanceDataReporter
This method tests if reporting of performance data is currently enabled for this instance of PerformanceDataReporter class.
isUsrtnsActive() - Static method in class com.ibm.iseries.collectionservices.PerformanceDataReporter
This method tests if Collection Services collector is active and collects performance data for *USRTNS category.

L

length - Variable in class com.ibm.iseries.collectionservices.MgtcolObjReadOptions
Specifies, how many bytes of record data should be read.
logicalPSN - Variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
Logical serial number of a system partition, where collection object was created.
logTransaction(byte[], int, byte[], int) - Method in class com.ibm.iseries.collectionservices.PerformanceDataReporter
If reporting was turned on for this instance of PerformanceDataReporter class (see enableReporting method), this method will cause additional transaction data to be logged.
logTransaction(byte[], int, String) - Method in class com.ibm.iseries.collectionservices.PerformanceDataReporter
If reporting was turned on for this instance of PerformanceDataReporter class (see enableReporting method), this method will cause additional transaction data to be logged.

M

MgtcolObj - class com.ibm.iseries.collectionservices.MgtcolObj.
MgtcolObj class is a Java equivalent of Collection Services Collection Object APIs.
MgtcolObj(String, String) - Constructor for class com.ibm.iseries.collectionservices.MgtcolObj
 
MgtcolObjAttributes - class com.ibm.iseries.collectionservices.MgtcolObjAttributes.
MgctolObjAttributes class represents attributes of a Management Collection Object and its repositories as returned by rtvAttributes() method of MgtcolObj class.
MgtcolObjAttributes() - Constructor for class com.ibm.iseries.collectionservices.MgtcolObjAttributes
 
MgtcolObjCollectionEntry - class com.ibm.iseries.collectionservices.MgtcolObjCollectionEntry.
MgctolObjRepositoryEntry class represents information about periods of data collection into repository of a Management Collection Object as returned by rtvAttributes() method of MgtcolObj class (see also class and MgtcolObjRepositoryEntry class).
MgtcolObjCollectionEntry() - Constructor for class com.ibm.iseries.collectionservices.MgtcolObjCollectionEntry
 
MgtcolObjException - exception com.ibm.iseries.collectionservices.MgtcolObjException.
Exception of MgtcolObjException class is thrown by methods of MgtcolObj class, when there is a corresponding exception message, sent by native Management Collection Object APIs.
MgtcolObjException(String) - Constructor for class com.ibm.iseries.collectionservices.MgtcolObjException
 
MgtcolObjNotOpen - exception com.ibm.iseries.collectionservices.MgtcolObjNotOpen.
Exception of MgtcolObjNotOpen class is thrown by methods of MgtcolObj class, when a method requires that object of MgtcolObj class be opened before use.
MgtcolObjNotOpen() - Constructor for class com.ibm.iseries.collectionservices.MgtcolObjNotOpen
 
MgtcolObjReadOptions - class com.ibm.iseries.collectionservices.MgtcolObjReadOptions.
MgtcolObjReadOptions class represents processing parameters, passed to readData() method of MgtcolObj class.
MgtcolObjReadOptions() - Constructor for class com.ibm.iseries.collectionservices.MgtcolObjReadOptions
 
MgtcolObjRecInfo - class com.ibm.iseries.collectionservices.MgtcolObjRecInfo.
MgtcolObjRecInfo class represents record information, returned by readData() method of MgtcolObj class.
MgtcolObjRecInfo() - Constructor for class com.ibm.iseries.collectionservices.MgtcolObjRecInfo
 
MgtcolObjRepoNotOpen - exception com.ibm.iseries.collectionservices.MgtcolObjRepoNotOpen.
Exception of MgtcolObjRepoNotOpen class is thrown by methods of MgtcolObj class, when a method requires that repository of a collection object be opened before use.
MgtcolObjRepoNotOpen() - Constructor for class com.ibm.iseries.collectionservices.MgtcolObjRepoNotOpen
 
MgtcolObjRepositoryEntry - class com.ibm.iseries.collectionservices.MgtcolObjRepositoryEntry.
MgctolObjRepositoryEntry class represents information about attributes of a repository of a Management Collection Object as returned by rtvAttributes() method of MgtcolObj class (see also class).
MgtcolObjRepositoryEntry() - Constructor for class com.ibm.iseries.collectionservices.MgtcolObjRepositoryEntry
 
MORE_DATA - Static variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
This is a constant value for moreData field.
moreData - Variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
More data flag.

N

name - Variable in class com.ibm.iseries.collectionservices.MgtcolObjRepositoryEntry
10 character name of repository of a Management Collection Object.
NO_MORE_DATA - Static variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
This is a constant value for moreData field.

O

offset - Variable in class com.ibm.iseries.collectionservices.MgtcolObjReadOptions
Offset in bytes in a record data, where read operation should begin.
offset - Variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
In this field data collection method indicates where Collection Services should start copying data from collectedData array.
open() - Method in class com.ibm.iseries.collectionservices.MgtcolObj
This method will open Management Collection Object for processing.
openRepository(String, String) - Method in class com.ibm.iseries.collectionservices.MgtcolObj
This method will open repository of Management Collection Object for processing.
option - Variable in class com.ibm.iseries.collectionservices.MgtcolObjReadOptions
This field specifies a record positioning option.

P

PerformanceDataReporter - class com.ibm.iseries.collectionservices.PerformanceDataReporter.
PerformanceDataReporter class is a Java equivalent of User-defined Transaction APIs, which enable applications to send performance-related information to Performance Explorer and Collection Services.
PerformanceDataReporter() - Constructor for class com.ibm.iseries.collectionservices.PerformanceDataReporter
This constructor will create a new instance of PerformanceDataReporter class with performance reporting turned on.
PerformanceDataReporter(boolean) - Constructor for class com.ibm.iseries.collectionservices.PerformanceDataReporter
With this constructor user can control initial state of performance reporting for new instance of PerformanceDataReporter class.

R

READ_BY_KEY_EQUAL - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjReadOptions
This is a constant value for option field.
READ_BY_KEY_GREATER_EQUAL - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjReadOptions
This is a constant value for option field.
READ_BY_KEY_LESS_EQUAL - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjReadOptions
This is a constant value for option field.
READ_CURRENT - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjReadOptions
This is a constant value for option field.
READ_FIRST - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjReadOptions
This is a constant value for option field.
READ_NEXT - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjReadOptions
This is a constant value for option field.
readData(int, MgtcolObjReadOptions, MgtcolObjRecInfo, byte[]) - Method in class com.ibm.iseries.collectionservices.MgtcolObj
This method will position to a specified record of a repository in a Management Collection Object, return information about this record and return specified part of record data for this record.
recKey - Variable in class com.ibm.iseries.collectionservices.MgtcolObjRecInfo
Record key of a current record.
recKey - Variable in class com.ibm.iseries.collectionservices.MgtcolObjReadOptions
Key of a record to be searched for when one of the Read Record by Key ... options was specified in option field.
recLength - Variable in class com.ibm.iseries.collectionservices.MgtcolObjRecInfo
Length in bytes of a current repository record.
RECORD_NOT_FOUND - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjRecInfo
This is a constant value for recStatus field.
RECORD_OK - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjRecInfo
This is a constant value for recStatus field.
recStatus - Variable in class com.ibm.iseries.collectionservices.MgtcolObjRecInfo
In this field, readData() method returns result of record positioning.
recType - Variable in class com.ibm.iseries.collectionservices.MgtcolObjRecInfo
This field indicates record type, processed by API.
repositoryCount - Variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
Number of repositories found in this Management Collection Object.
repositoryInfo - Variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
This array contains an entry for every repository found in a Management Collection Object.
requestModifier - Variable in class com.ibm.iseries.collectionservices.DataCollectionRequest
This field modifies a meaning of a request for which a method was called.
retentionPeriod - Variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
Number of hours collection object should be kept on system, before it will be automatically deleted.
rtvActive() - Static method in class com.ibm.iseries.collectionservices.MgtcolObj
This method creates an object of MgtcolObj class, representing an active Management Collection Object.
rtvAttributes(String) - Method in class com.ibm.iseries.collectionservices.MgtcolObj
This method returns information about attributes of a Management Collection Object and its repositories.

S

size - Variable in class com.ibm.iseries.collectionservices.MgtcolObjRepositoryEntry
Size of repository in Kbytes (K = 1024).
size - Variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
Size of the Management Collection Object in Kbytes (K = 1024).
startTime - Variable in class com.ibm.iseries.collectionservices.MgtcolObjCollectionEntry
Date and time when either collection was started or collection interval was changed for a performance category associated with this repository.
startTransaction(byte[], int, byte[], int, long[]) - Method in class com.ibm.iseries.collectionservices.PerformanceDataReporter
If reporting was turned on for this instance of PerformanceDataReporter class (see enableReporting method), this method will cause performance data to be collected for start of transaction.
startTransaction(byte[], int, String, long[]) - Method in class com.ibm.iseries.collectionservices.PerformanceDataReporter
If reporting was turned on for this instance of PerformanceDataReporter class (see enableReporting method), this method will cause performance data to be collected for start of transaction.
STOP_RECORD - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjRecInfo
This is a constant value for recType field.
SUMMARY_FAILED - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
This is a constant value for sumStatus field.
SUMMARY_IN_PROGRESS - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
This is a constant value for sumStatus field.
SUMMARY_NOT_RUN - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
This is a constant value for sumStatus field.
SUMMARY_OK - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
This is a constant value for sumStatus field.
sumStatus - Variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
This field indicates a status of summarization process for this object.

T

timeCreated - Variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
Date and time, when collection object was created.
timestamp - Variable in class com.ibm.iseries.collectionservices.MgtcolObjRecInfo
This is the exact time when repository record was created.
timeUpdated - Variable in class com.ibm.iseries.collectionservices.MgtcolObjAttributes
Date and time when last update to collection object data occurred.

U

UNEXPECTED_RECORD - Static variable in class com.ibm.iseries.collectionservices.MgtcolObjRecInfo
This is a constant value for recType field.

A B C D E F G I L M N O P R S T U