![]() |
Copyright © TIBCO Software Inc. All Rights Reserved |
Each adapter has two microagents, a standard TIBCO Hawk microagent named COM.TIBCO.ADAPTER.xyz (where xyz is the adapter configuration name) and a class microagent. These microagents provide:
• Business level statistics that report the progress of the adapter as it interacts with the database. 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 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 permanently change the setting in either the repository or the .tra file.The following table lists each method available for the adapter and the page on which the method is explained. Although the Microagents, Methods, and Arguments dialog in TIBCO Hawk Display lists more methods than are documented here, only the following methods are supported.Activates mapping of a role to a sink at runtime. This replaces the now-deprecated setTraceSink() TIBCO Hawk method.
Input Parameters
Input Parameters Returns statistics about data handled by a given adapter service or all adapter services since the time the adapter was started.
Input parameter Name of service to get statistics for. If no service name is given, performance statistics for all services are returned.
Displays the time (in seconds) since last time the adapter was reset, or if never reset, since the adapter started.
Quality of service for the endpoint. For example RVCM or JMS Persistent. Number of Messages Returns information about currently active TIBCO Hawk components such as publishers, subscribers, or timers.
Name of the component. If no value is entered, all components display.
The name of the TIBCO Adapter SDK class for this component, such as Publisher, Subscriber, or IODescriptorSource. For more information about the class, see your TIBCO Adapter SDK documentation. Information about this component, for example, time interval, signal type, and validating the publisher or subscriber.Retrieves generic configuration information. More specific configuration information is accessed through separate methods.
Repository Connection Location of the adapter project; either a file name or configuration URL.
Name of the property for which elements (tags) and attributes are desired. For example, agentone/startup.
Line number in which this property is defined in the project file.
Total number of times this connection had to be reestablished. Total number of operations processed by this connection since the adapter started. Total number of operations processed by this connection since the last reconnection. Displays the time (in seconds) since the last time the adapter was reset, or if never reset, since the adapter started.
Return the current count of elements in any internal queue used by the adapter. This includes the TIBCO Rendezvous event queues automatically spawned by TIBCO Rendezvous for each adapter.
Displays the time (in seconds) since the last time the adapter was reset, or if never reset, since the adapter started.Returns information about the TIBCO Rendezvous session defined by this adapter. Information about all currently defined sessions is returned if no sessionName is provided.
Input Parameter Name of the TIBCO Rendezvous session for which configuration is required. If not given, information about all sessions is returned. The default is all.
Ledger file for this certified messaging session. Returns the empty string for sessions that are not certified messaging sessions. Timeout for this certified messaging session. Returns the empty string for sessions that are not certified messaging sessions.This information is fairly limited; for more detail, additional methods are provided (getConfig() and getRvConfig().)
Type that tells what part of the adapter this thread belongs to. Valid types include "Publisher", "Subscriber", "RPC", or "Connection". Displays the time (in seconds) since last time the adapter was reset, or if never reset, since the adapter started.
Input Parameters Name of the sink for which you need information. If no name is specified, information about all sinks is returned. Default is all. Name of the role for which you need information for the specified sink or sinks. Default is all.
Retrieves version information for the current application. Two lines may be returned, one for the TIBCO Adapter SDK, one for the adapter.
Preregister an anticipated subscription service. Some sending applications can anticipate requests for certified delivery even before the listening applications start running. In such situations, the publication service can preregister subscription services, so TIBCO Rendezvous software begins storing outbound messages in the publication service ledger. If the listening correspondent requires old messages, it receives the backlogged messages when it requests certified delivery.
Input Parameters Name of the component for which the listener should be preregistered. Listener Session Name Resets all the counts for the activity statistics and when getActivityStatistics() is invoked, default values are displayed.Resets all the counts for the connection statistics and when getActivityStatistics() is invoked, default values are displayed.Resets all the counts for the thread statistics and when getActivityStatistics() is invoked, default values are displayed.Returns information retrieved from the ledger file of a TIBCO Rendezvous certified messaging session.Before invoking this method, ensure that the certified messaging publisher adapter has established a certified delivery agreement with its subscriber agents.
Input Parameters Name of the TIBCO Rendezvous session for which ledger information is desired (default is all).
Name of the TIBCO Rendezvous CM session to which this information applies. Sequence number of the most recently sent message with this subject name. Total storage (in bytes) occupied by all pending messages with this subject name.If the ledger contains ten messages with this subject name, this field sums the storage space over all of them. Within each listener submessage, the Listener Session Name field contains the name of the delivery-tracking listener session. Within each listener submessage, the Last Confirmed field contains the sequence number of the last message for which this listener session confirmed delivery. Number of RVCM messages pending for this listener. The value is computed by subtracting the last sent sequence number from the last acknowledged sequence number.
Input Parameter
Input Parameters Name of the sink for which you want to add a role or change the file limit. Name of the role you want to add to this sink (warning, error, debug, or user defined). Default is all. This parameter is ignored if the sink specified by sinkName is not a file sink.Stops the specified adapter by calling the internal stop() method. This method returns OK if successful or an error if not successful.In some cases, a "Method Invocation Succeeded" message appears, but the adapter does not return control to the command line.If the com.csgsystems.aruba.connection.PoolableATMI.cleanup property is set to true in pools.properties, there will be a separate thread to do some cleanup for the Kenan connection pool. If this thread is not closed while shutting down adapter, then when invoking the stopApplicationInstance method using TIBCO Hawk, the adapter does not return control to command line.If the com.csgsystems.aruba.connection.PoolableATMI.cleanup property is set to false, the adapter can stop and return control to command line successfully.
Input Parameters Name of the publication service to which the subscription service is preregistered. Listener Session Name
![]() |
Copyright © TIBCO Software Inc. All Rights Reserved |