|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.inventory.TWGInvCollector
The TWGInvCollector is an abstract base class for deriving Inventory collectors. Each collector will be notified when Inventory events occur for the specified managed object so that they may take any necessary actions.
You must call one of the registerCollector() methods in this class during the InitClassRegistration() section of your TWGExtension subclass.
Field Summary | |
---|---|
static int |
INV_COLLECTION_AUTH_FAILURE
Authorization Failure |
static int |
INV_COLLECTION_COMM_ERROR
Communication Error |
static int |
INV_COLLECTION_GENERAL_FAILURE
General Failure |
static int |
INV_COLLECTION_HARDWARE_FAILURE
Hardware Inventory Error |
static int |
INV_COLLECTION_NO_DATA
No Inventory Data Returned |
static int |
INV_COLLECTION_SOFTWARE_FAILURE
Software Inventory Error |
static int |
INV_COLLECTION_SUCCESS
Collection completed successfully |
static int |
INV_COLLECTION_TIMEOUT
Timeout |
static int |
INV_COLLECTION_UNKNOWN_SYSTEM
System Unknown to Inventory |
Constructor Summary | |
---|---|
TWGInvCollector()
Default constructor |
Method Summary | |
---|---|
abstract java.lang.String |
getCollectorThreadName()
The name of the Inventory Collector. |
static TWGDatabaseQuery |
GetCreateDefaultQuery(TWGDatabaseTable Table)
Get/create default query for specified table |
abstract java.lang.String[] |
getDatabaseTableClassNames()
Subclasses must override this method to specify what inventory tables are populated by the collector |
void |
internalStartInventory(long moid,
java.lang.String className,
byte[] addrInfo,
int reason)
Called by main inventory Server to put a StartInventory job on the queue. |
void |
internalStopInventory(long moid)
Called by the main Inventory server to put a Stop Inventory job on the queue. |
void |
inventoryComplete(long moid,
int returnCode,
long updateTime)
Inventory Collectors call this method when they have finished processing for a requested inventory on a selected managed object. |
static void |
registerCollector(TWGExtension ext,
java.lang.String collectorClassName,
java.lang.String moClassName)
Register inventory collector. |
static void |
registerCollector(TWGExtension ext,
java.lang.String collectorClassName,
java.lang.String moClassName,
java.lang.String overrideCollectorName)
Register overriding inventory collector The collector will REPLACE the specified collector already designated to be notified when managed objects of this class require inventory operations. |
static void |
registerCollectorForService(TWGExtension ext,
java.lang.String collectorClassName,
java.lang.String moClassName,
java.lang.String serviceName)
Register inventory collector for a required client service The collector will be ADDED to the list of collectors already designated to be notified when managed objects of this class require inventory operations. |
static void |
registerCollectorForServiceOCN(TWGExtension ext,
java.lang.String collectorClassName,
java.lang.String moClassName,
java.lang.String ovClassName,
java.lang.String serviceName)
Same as registerCollectorForService but allow overrideClassName |
void |
run()
Worker thread for queueing up inventory items for the collector |
void |
sendToDb(int cmdCode,
java.lang.Object cmdObj)
Used by the collector to send information to the database. |
abstract void |
shutdown()
Called when the Inventory Server is stopping and the Collector needs to shutdown. |
void |
start()
Start collector service node and thread. |
abstract void |
startInventory(long moid,
java.lang.String className,
byte[] addrInfo)
An Inventory collection should be performed on the indicated managed object. |
abstract void |
stopInventory(long objId)
A previously requested Inventory scan should be stopped on the indicated managed object |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int INV_COLLECTION_SUCCESS
public static final int INV_COLLECTION_GENERAL_FAILURE
public static final int INV_COLLECTION_AUTH_FAILURE
public static final int INV_COLLECTION_COMM_ERROR
public static final int INV_COLLECTION_HARDWARE_FAILURE
public static final int INV_COLLECTION_SOFTWARE_FAILURE
public static final int INV_COLLECTION_UNKNOWN_SYSTEM
public static final int INV_COLLECTION_TIMEOUT
public static final int INV_COLLECTION_NO_DATA
Constructor Detail |
public TWGInvCollector()
Method Detail |
public abstract java.lang.String[] getDatabaseTableClassNames()
public static final void registerCollector(TWGExtension ext, java.lang.String collectorClassName, java.lang.String moClassName) throws java.lang.ClassNotFoundException, java.lang.InstantiationException, java.lang.IllegalAccessException
ext
- TWGExtension instance to register database table classes undercollectorClassName
- class name of TWGInvCollector subclass to registermoClassName
- managed object class name to associate collector with
java.lang.ClassNotFoundException
java.lang.InstantiationException
java.lang.IllegalAccessException
public static final void registerCollector(TWGExtension ext, java.lang.String collectorClassName, java.lang.String moClassName, java.lang.String overrideCollectorName) throws java.lang.ClassNotFoundException, java.lang.InstantiationException, java.lang.IllegalAccessException
ext
- TWGExtension instance to register database table classes undercollectorClassName
- class name of TWGInvCollector subclass to registermoClassName
- managed object class name to associate collector withoverrideCollectorName
- collector class to override in the MO class' inheritance list
java.lang.ClassNotFoundException
java.lang.InstantiationException
java.lang.IllegalAccessException
public static final void registerCollectorForService(TWGExtension ext, java.lang.String collectorClassName, java.lang.String moClassName, java.lang.String serviceName) throws java.lang.ClassNotFoundException, java.lang.InstantiationException, java.lang.IllegalAccessException
ext
- TWGExtension instance to register database table classes undercollectorClassName
- class name of TWGInvCollector subclass to registermoClassName
- managed object class name to associate collector withserviceName
- service name required on managed object for collector to
be called (collector is not called if service is not supported on MO)
java.lang.ClassNotFoundException
java.lang.InstantiationException
java.lang.IllegalAccessException
public static final void registerCollectorForServiceOCN(TWGExtension ext, java.lang.String collectorClassName, java.lang.String moClassName, java.lang.String ovClassName, java.lang.String serviceName) throws java.lang.ClassNotFoundException, java.lang.InstantiationException, java.lang.IllegalAccessException
java.lang.ClassNotFoundException
java.lang.InstantiationException
java.lang.IllegalAccessException
public void start()
public abstract java.lang.String getCollectorThreadName()
public abstract void startInventory(long moid, java.lang.String className, byte[] addrInfo)
moid
- managed object IDclassName
- class name of Managed ObjectaddrInfo
- specific addressing info required for this type of managed objectpublic abstract void stopInventory(long objId)
objId
- managed object idpublic abstract void shutdown()
public final void inventoryComplete(long moid, int returnCode, long updateTime)
moid
- managed object idreturnCode
- inventory collection statusupdateTime
- time update was completed, milliseconds since January 1, 1970 GMTpublic final void sendToDb(int cmdCode, java.lang.Object cmdObj)
TWGDbStoreRow row; TWGDbReplaceManagedObjCmd dbCmd = new TWGDbReplaceManagedObjCmd(managedObjectId); row = new TWGDbStoreRow(***TABLE_NAME***); row.addColumnValue(***COLUMN NAME***, ***COLUMN VALUE***); . . . dbCmd.addRow(row); sendToDb(TWGDbReplaceManagedObjCmd.TWG_DB_REPLACE_MANAGEDOBJ_CMD, dbCmd);
cmdCode
- command identifier for command we are sendingcmdObj
- Serializable object for sending to the Databasepublic final void internalStartInventory(long moid, java.lang.String className, byte[] addrInfo, int reason)
moid
- managed object idclassName
- java class name of objectaddrInfo
- required addressing info from object that can be
used to communicate with objectpublic final void internalStopInventory(long moid)
moid
- managed object idpublic void run()
run
in interface java.lang.Runnable
public static TWGDatabaseQuery GetCreateDefaultQuery(TWGDatabaseTable Table) throws TWGDbException
Table
- database table to get/create default query for
TWGDbException
- if failed to create default query
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |