Available TIBCO Hawk Methods

This section lists the methods available in the custom microagent of TIBCO ActiveMatrix Adapter for Database:

•

Custom Microagent Methods with adb.perfMon

If setting the adb.perfMon TRA properties to on, the methods listed in Custom Microagent Methods with adb.perfMon will be displayed and available to use. If setting adb.perfMon to off, the methods will not be displayed and useable.

Although the microagents, methods, and arguments dialog in TIBCO Hawk Display lists more methods than are documented here, only the following methods are supported.

For the methods available in the standard and class microagents, see "Appendix C TIBCO Adapter SDK Hawk Microagents and Methods" in TIBCO Adapter SDK Programmer’s Guide.

Custom Microagent Methods
Custom Method	Description
`getEventQueueSize()`	Retrieves the size of the TIBCO Rendezvous event queue for the specified adapter instance.
`setDebugLevel()`	Sets the debug level for the current adapter instance.
toggleVerboseFlag()	Changes the value of the verbose flag from on to off, or the reverse.
showConfiguration()	Shows the configuration defined for the current agent.
terminateADBagent()	Stops the current TIBCO ActiveMatrix Adapter for Database agent.
getPollingInterval()	Returns the current polling interval setting.
setPollingInterval()	Set the polling interval for the Publication Service.
getPollingBatchSize()	Get the polling batch size for the Publication Service.
setPollingBatchSize()	Set the polling batch size for the Publication Service.

Custom Microagent Methods with adb.perfMon
Custom Method	Description
getActivityStatistics()	Returns the total number of objects processed for all the schemas, based on the request type. Also, returns the number of success and error objects.
getActivityStatisticsByService	Returns the total number of objects processed for each of the schemas associated with the specified service.
getActivityStatisticsByOperation()	Returns the total number of objects processed for all the schemas by each service that is associated with a specified operation.
getThreadStatistics()	Return the operation counts of the current threads.
getQueueStatistics()	Return the current count of elements in any internal queue used by the adapter.
getConnectionStatistics()	Returns the state and statistics for all the current connections used by the adapter.
resetActivityStatistics()	Resets all the counts for the activity statistics.
resetThreadStatistics()	Resets all the counts for the thread statistics.
`resetConnectionStatistics()`	Resets all the counts for the queue statistics.

SDK Microagent Methods

Method

Description

getStatus()

Retrieves basic status information about the adapter.

The getStatus method is provided by TIBCO Adapter SDK. Note the following information returned by this method:

•

Instance ID Instance ID for this adapter instance.

•

Adapter Name Name of the application.

•

Messages Received Number of TIBCO Rendezvous messages received.

•

Messages Sent Number of TIBCO Rendezvous messages published.

For more information about the getStatus method, see TIBCO Adapter SDK Programmer’s Guide.

Note: Information retrieved by the getStatus method does not indicate the records processed by the adapter services. The retrieved information contains not only records of the adapter services, but also records sent and received by the adapter itself for certain functions.

Subtopics