Copyright © TIBCO Software Inc. All Rights Reserved

Available Microagents

Each adapter has three microagents, a standard TIBCO Hawk microagent named COM.TIBCO.ADAPTER.xyz where xyz is the adapter configuration name, a custom microagent, and a class microagent (for PAM compliance). The microagents provide:

•	Business level statistics—statistics that report the progress of the adapter as it interacts with the vendor application. For example, in a database adapter such statistics might indicate whether objects were successfully or unsuccessfully inserted, updated, or deleted in the database.

•

Queries that return information about the state of the adapter. This can be an important tool for seeing the internals of an adapter and debugging it if something appears wrong. For example, methods can return information about threads, internal queues, or connections to the target system. Using these methods, one might be able to identify certain bottlenecks or gauge how successfully an adapter is scaling with respect to the current environment.

•

Updates of the adapter runtime parameters. This includes retrieving the current runtime parameters and setting new runtime parameters without restarting the adapter. An example of this is getting and setting the polling interval. Updating a runtime parameter through the Hawk microagent only affects the setting of the instance that is running. It does not make a permanent change of the setting in either the repository or the .tra file.

By default, all three microagents are available at run time. You can disallow adding custom methods to the standard microagent when deploying the adapter by changing the addCustomHawkMethodsToClassMAgent property value in the adapter’s property file.

The following table lists the methods available for the adapter.

Table 23 Microagent Methods

Method	Description
Standard Methods
activateTraceRole()	Activates a mapping of a role to a sink at run time.
deactivateTraceRole()	Deactivates a mapping of a roles to sinks at run time.
getAdapterServiceInformation()	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 the more specific methods.
getConfigProperties()	Returns all attributes and elements for the given repository object.
getHostInformation()	Returns standard and extended application information.
getRvConfig()	Returns information about all TIBCO Rendezvous sessions defined.
getStatus()	Returns general status information, such as the number of TIBCO Rendezvous messages received and published, the number of errors since the last call, the PID of the application, and more.
getTraceSinks()	Returns information about sinks to which traces currently go.
getVersion()	Returns 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.
reviewLedger()	Returns information retrieved from the ledger file of a certified messaging session for a publisher adapter.
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.
Custom Methods
getActivityStatistics()	Returns the total number of objects processed for all the schemas.
getActivityStatisticsByOperation()	Returns the total number of objects processed for all the schemas by each service that is associated with a specified operation.
getActivityStatisticsByService	Returns information about the services implemented by this adapter.
getConnectionStatistics()	Returns the state and statistics for all the current connections used by the adapter.
getPollingInterval()	Returns the current polling interval setting.
getQueueStatistics()	Returns the current count of elements in any internal queue used by the adapter.
getThreadStatistics()	Returns the operation counts of the current threads
resetActivityStatistics()	Resets all the counts for the activity statistics.
resetConnectionStatistics()	Resets all the counts for the connection statistics.
resetThreadStatistics()	Resets all the counts for the thread statistics.
setPollingInterval()	Sets the polling interval for the publication service.

Copyright © TIBCO Software Inc. All Rights Reserved