|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.iseries.collectionservices.MgtcolObj
MgtcolObj class is a Java equivalent of Collection Services
Collection Object APIs.
For more information about Collection Object APIs,
go to iSeries Information Center.
Field Summary | |
static java.lang.String |
copyright
|
Constructor Summary | |
MgtcolObj(java.lang.String objectName,
java.lang.String libraryName)
|
Method Summary | |
void |
close()
This method will close Management Collection Object, previously opened by open() method. |
void |
closeRepository(int repositoryHandle)
This method will close repository of Management Collection Object, previously opened by openRepository() method. |
java.lang.String |
getLibrary()
|
java.lang.String |
getName()
|
void |
open()
This method will open Management Collection Object for processing. |
int |
openRepository(java.lang.String repositoryName,
java.lang.String format)
This method will open repository of Management Collection Object for processing. |
void |
readData(int repositoryHandle,
MgtcolObjReadOptions readOptions,
MgtcolObjRecInfo recInfo,
byte[] recordData)
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. |
static MgtcolObj |
rtvActive()
This method creates an object of MgtcolObj class, representing an active Management Collection Object. |
MgtcolObjAttributes |
rtvAttributes(java.lang.String format)
This method returns information about attributes of a Management Collection Object and its repositories. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String copyright
Constructor Detail |
public MgtcolObj(java.lang.String objectName, java.lang.String libraryName)
objectName
- Name of the Management Collection Object, being represented
by this object of MgtcolObj classlibraryName
- Name of the library where Management Collection Object residesMethod Detail |
public java.lang.String getName()
public java.lang.String getLibrary()
public static MgtcolObj rtvActive() throws MgtcolObjException
rtvActive() method is a Java counterpart of Retrieve Active Management Collection Object Name (QpmRtvActiveMgtcolName) API.
MgtcolObjException
- if collector is not running or
errors are encountered in the process.public MgtcolObjAttributes rtvAttributes(java.lang.String format) throws MgtcolObjException
rtvAttributes() method is a Java counterpart of Retrieve Management Collection Object Attributes (QpmRtvMgtcolAttrs) API.
format
- format of information to return. Two formats are defined:
MgtcolObjException
- if errors are encountered in the process.public void open() throws MgtcolObjException
open() method is a Java counterpart of Open Management Collection Object (QpmOpenMgtcol) API.
MgtcolObjException
- if not able to open Management Collection Object,
identified by this object of MgtcolObj classpublic int openRepository(java.lang.String repositoryName, java.lang.String format) throws MgtcolObjException, MgtcolObjNotOpen
openRepository() method is a Java counterpart of Open Management Collection Object Repository (QpmOpenMgtcolRepo) API.
repositoryName
- 10 character name of a repository of a Management Collection Objectformat
- this parameter defines what kind of processing readData() method
will perform on repository records, what kind of information it will return
and what kind of control information can be passed to it.
The only supported format in V5R2 is "MCOD0100".MgtcolObjNotOpen
- if method is called for an object which was not
previously opened.MgtcolObjException
- if not able to open repository of
a Management Collection Object.public void close()
close() method is a Java counterpart of Close Management Collection Object (QpmCloseMgtcol) API.
public void closeRepository(int repositoryHandle)
closeRepository() method is a Java counterpart of Close Management Collection Object Repository (QpmCloseMgtcolRepo) API.
repositoryHandle
- repository handle, which uniquely identifies repositorypublic void readData(int repositoryHandle, MgtcolObjReadOptions readOptions, MgtcolObjRecInfo recInfo, byte[] recordData) throws MgtcolObjException, MgtcolObjNotOpen, MgtcolObjRepoNotOpen
readData() method is a Java counterpart of Read Management Collection Object Data (QpmReadMgtcolData) API.
repositoryHandle
- repository handle, which uniquely identifies repositoryreadOptions
- object of MgtcolObjReadOptions class,
which defines numerous processing options for the method.recInfo
- object of MgtcolObjRecInfo class, in which method will
return information about processed repository record and overall results of a method call.recordDara
- byte array to receive data from a record.
Length of data to be returned in this array is controlled by a length field
in an object of MgtcolObjReadOptions class (see second parameter).MgtcolObjNotOpen
- if method is called for an object which was
not previously openedMgtcolObjRepoNotOpen
- if method is called for a repository,
which was not previously openedMgtcolObjException
- if not able to process repository record
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |