The Spotfire Streaming Adapter for JMX Control establishes JMX connections with or without authentication.
Together with the JMX MetaData and JMX Attribute Reader adapters, users can monitor and query related information.
This section describes the properties you can set for this adapter, using the various tabs of the Properties view in StreamBase Studio.
Name: Use this required field to specify or change the name of this instance of this component. The name must be unique within the current EventFlow module. The name can contain alphanumeric characters, underscores, and escaped special characters. Special characters can be escaped as described in Identifier Naming Rules. 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 checkbox 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 purpose and function of the component. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.
| Property | Type | Description |
|---|---|---|
| Connect On Startup | check box | If enabled, the adapter connects to the server on startup. |
| Host | string | Hostname for the JMX server to use. |
| Port | int | Port number of the JMX server to use. |
| Enable Auth | check box | If enabled, the adapter connects to the server with the following authentication parameters. |
| UserName | string | The username for connecting to the JMX server. |
| Password | string | The password for connecting to the JMX server. |
| Security Type | selection | None or use SSL for the connection. |
| Log Level | drop-down list | 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 is used. Available values, in increasing order of verbosity, are: OFF, ERROR, WARN, INFO, DEBUG, TRACE. |
Use the settings in this tab to enable this operator or adapter for runtime start and stop conditions in a multi-node cluster. During initial development of the fragment that contains this operator or adapter, and for maximum compatibility with 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.
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.
Caution
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.
Use the control port to send action commands to the adapter. Tuples enqueued on this port connect or disconnect the adapter to the JMX server.
The control port's schema is a single string field:
| Field | Data Type | Description |
|---|---|---|
| command | string | The command tells the adapter what action to take. Available commands are connect, disconnect, and list. |
| Field | Data Type | Description |
|---|---|---|
| status | string | The name of the status. |
| message | string | Status message. |
| host | string | Host of the JMX server. |
| port | int | Port number for the JMX server to use. |
| time | timestamp | The date and time the status information was produced. |
The following lists all available status:
-
Connected—Connection established.
-
Connection State—Connection state.
-
Connect Failed—Connection failed.
-
Disconnected—Disconnect a server.
-
Reconnecting—Try to reconnect to server.
-
Input Error—Input error.
-
Error—An error occurred.