JMX Attribute Reader Adapter


The TIBCO Streaming® Adapter for Reading JMX Attributes shares a connection with the JMX Control adapter.

This adapter returns JMX attribute values in response to queries.

Adapter Properties

This section describes the properties you can set for this adapter, using the various tabs of the Properties view in StreamBase Studio.

General Tab

Name: Use this required field to specify or change the name of this instance of this component, which must be unique in the current EventFlow module. The name must contain only alphabetic characters, numbers, and underscores, and no hyphens or other special characters. The first character must be alphabetic or an underscore.

Adapter: A read-only field that shows the formal name of the adapter.

Class name: Shows the fully qualified class name that implements the functionality of this adapter. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.

Start options: This field provides a link to the Cluster Aware tab, where you configure the conditions under which this adapter starts.

Enable Error Output Port: Select this check box to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.

Description: Optionally enter text to briefly describe the component's purpose and function. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.

Operator Properties Tab

Property Type Default Description
Control Adapter string None The name on the EventFlow canvas for the JMX Control adapter that will establish and maintain a connection.
Log Level drop-down list INFO Controls the level of verbosity the adapter uses to send notifications to the console. This setting can be higher than the containing application's log level. If set lower, the system log level will be used. Available values, in increasing order of verbosity, are: OFF, ERROR, WARN, INFO, DEBUG, TRACE.

Cluster Aware Tab

Use the settings in this tab to allow this operator or adapter to start and stop based on conditions that occur at runtime in a cluster with more than one node. During initial development of the fragment that contains this operator or adapter, and for maximum compatibility with TIBCO Streaming releases before 10.5.0, leave the Cluster start policy control in its default setting, Start with module.

Cluster awareness is an advanced topic that requires an understanding of StreamBase Runtime architecture features, including clusters, quorums, availability zones, and partitions. See Cluster Awareness Tab Settings on the Using Cluster Awareness page for instructions on configuring this tab.

Concurrency Tab

Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.


Concurrency settings are not suitable for every application, and using these settings requires a thorough analysis of your application. For details, see Execution Order and Concurrency, which includes important guidelines for using the concurrency options.

Query Input Port


Use the query port to perform JMX queries: list out domains, MBeans, and attributes.

Query Port Schema

Field Data Type Description
beanName list(string) Used for query attributes inside certain beans; if leave empty, will search all beans.
attributeName list(string) Used for query certain attributes; if leave empty, will query for all attributes.

Query Status Output Port

Field Data Type Description
status string The name of the status.
message string Status message.
inputTuple tuple Input tuple.
time timestamp The date and time the status information was produced.

The following lists all available status:

  • Error — An error occurred.

  • Info — Info message.

Attribute Data Output Port

Field Data Type Description
beanName string Bean name which queried attribute is in.
attributeName string Attribute name.
dateType string Attribute data type.
value string Attribute value.
valueList list(string) List of attribute values.
InputTuple tuple Input tuple.
time timestamp The date and time the status information was produced.

Related Topics