Streams JMX API
Teracloud Streams JMX Management APIs
The Teracloud Streams Java Management Extensions (JMX) APIs provide programmatic access to configuration and status information for Streams objects, such as domains, instances, jobs, and resources. You can manage and monitor these objects by using a set of JMX beans. A JMX bean provides attributes, operations, and notifications for working with the managed object.Attributes generally provide configuration and state information about Streams objects. The JMX APIs provide methods for getting and setting the attribute values. For example, the InstanceMXBean has a fusion scheme attribute, which you can get or set by using the getFusionScheme and setFusionScheme methods.
In addition to getting and setting attribute values, the JMX APIs provide operations for management tasks. For example, you can use operations to submit and cancel jobs.
Notifications provide a way to signal a value change, event, or problem. For example, you can use notifications to detect when attribute values change. You can also use notifications to monitor when significant events occur, such as when a job stops or starts.
- Getting started with JMX APIs
To develop an application that uses the Streams JMX API, you must configure the access control lists and determine the JMX URL for establishing a connection. - Accessing Streams information with JMX APIs
To access Streams information by using the JMX API, you must supply the necessary environment parameter values, establish a JMX connection, obtain access to an Streams JMX bean proxy, and call bean methods through the proxy. - Registering JMX beans for jobs
You must register JMX beans for jobs and related objects before you can access them from an application. Related objects include processing elements (PEs), operators, and connections. - Performing large data operations with JMX APIs
The Streams JMX API uses an HTTPS implementation for transferring large data values between the client where the application runs and the server where the JMX service runs. For example, this implementation is used for client retrieval of processing element (PE) metrics and for uploading an application when a job is submitted. - Processing JMX API notifications
To successfully process JMX notifications, your application must implement the NotificationListener interface, become a listener for notifications, and be tolerant of potential lost notifications. - Handling JMX API errors
The Streams Java Management Extensions (JMX) APIs throw a standard Java exception when an error occurs.
Packages
Package
Description
The com.ibm.streams.management package contains classes and interfaces for working with the
Streams managed beans.
The com.ibm.streams.management.domain package contains classes and interfaces for accessing and managing
the Streams domain for which the management API (JMX) service is running.
The com.ibm.streams.management.instance package contains classes and interfaces for accessing and managing
the Streams instances and instance services.
The com.ibm.streams.management.job package contains classes and interfaces for accessing and managing
Streams jobs.
The com.ibm.streams.management.resource package contains classes and interfaces for accessing and managing resources used to
run Streams services and jobs.
The com.ibm.streams.management.security package contains classes and interfaces for accessing and managing permissions
to Streams secured objects for user, group, and role security principals.