Available TIBCO Hawk Methods

The following table lists the microagent methods available for the adapter.

For more information about the methods available in the standard and class microagents, see " TIBCO Adapter SDK Hawk Microagents and Methods" in TIBCO Adapter SDK Programmer’s Guide.
Note: The getActivityStatisticsBySchema(), getActivityStatisticsByOperation(), getActivityStatisticsByService(), and resetActivityStatistics() methods are now deprecated. You must use the class microagent to get equivalent methods. When the value of the adfiles.addCustomHawkMethodsToClassMAgent property is set to ON in the TRA file, these methods are added to the class microagent.
Method Description
activateTraceRole() Activates a mapping of a role to a sink at run time.
deactivateTraceRole() Deactivates a mapping of a role to sinks at run time.
getActivityStatisticsByOperation() Returns statistics for one operation.
getActivityStatisticsBySchema() Returns statistics for any activities on a particular object or schema.
getActivityStatisticsByService() Returns statistics related to the data handled by a particular adapter service since it started.
getAdapterServicesInformation() Returns information about the services implemented by this adapter.
getComponents() Returns information about the publisher, subscriber and IODescriptor.
getConfig() Returns basic configuration information. More specific information is accessed by using more specific methods.
getConfigProperties() Returns all attributes and elements for the given repository object.
getDocumentDelay() Returns the document delay setting for a given Publication Service.
getHostInformation() Returns standard and extended application information.
getPollingInterval() Returns the current polling interval setting.
getQueueStatistics() Returns the current count of elements in any internal queue used by the adapter.
getRvConfig() Returns information about all defined TIBCO Rendezvous sessions.
getStatus() Returns general status information, such as the number of TIBCO Rendezvous messages received and published, the number of errors that have occurred since the last call, the PID of the application, and so on.
getTraceSinks() Returns information about sinks to which traces currently go.
getVersion() Return the configuration ID, application name, version, and date for this adapter instance.
_onUnsolictedMsg() Displays alert messages sent to the current adapter.
preRegisterListener() Preregisters an anticipated listener.
resetActivityStatistics() Resets all the counts for the activity statistics.
reviewLedger() Returns information retrieved from the ledger file of a certified messaging session for a publisher adapter.
setDocumentDelay() Sets the document delay for Publication Service.
setPollingInterval() Sets the polling interval for Publication Service.
setTraceSinks() Adds a role or changes the file limit of a previously specified sink.
stopApplicationInstance() Stops the running adapter instance.
unRegisterListener() Unregisters a currently preregistered listener.
refreshExtendedLogging() Refreshes the Log4J log without restarting the adapter whenever changes are made to the Log4J properties file.