SPL File control.spl

SPL standard and specialized toolkits > spl 1.2.1 > spl.control > control.spl

Content

Operators

• JobControlPlane: The JobControlPlane composite operator must be added to any application with a consistent region.

Types

• MBeanNotification: Type that represents a JMX notification from an MBean.
• MBeanNotificationBase: Base type that represents most attributes of a JMX notification from an MBean.
• MBeanNotificationUserString: Type containing a single attribute that is used to extract the user data as an rstring from a JMX notification.

Composites

composite JobControlPlane

The JobControlPlane composite operator must be added to any application with a consistent region. It is used by operators in a consistent region to communicate status information.

An instance of the JobControlPlane operator in an SPL application creates a job control plane, which other operators can use to communicate control information. A JobControlPlane is a JMX MBean Server that supports registration of MBeans from operators within the job. Operators then use their MBeans, or the ones that are automatically registered in the JobControlPlane, to provide intra-job control, co-ordination, and configuration.

The Java™ Operator API package com.ibm.streams.operator.control provides the interfaces and methods that a Java primitive operator uses to interact with its JobControlPlane.

The JMX URL is registered in the name service of the InfoSphere® Streams instance with the key com.ibm.ssb.control.job.jobid where jobid is the identifier of the job. Note that if the processing element that is hosting the JobControlPlane is restarted, the JMX URL changes. When the job is submitted, the JMX URL for external clients for the JobControlPlane is obtained from the streamtool command. For example:

streamtool getnsentry -d domain-id -i instance-id com.ibm.streams.control.job.jobid

In this example, domain-id represents the domain identifier and instance-id represents the instance identifier. The numeric identifier of the submitted job is the jobid. The command returns a JMX URL that can then be used by any JMX client, such as JConsole, to connect to the JobControlPlane.

This operator is restartable, relocatable, and partition isolated.

Ports

This operator has 0 input ports and 0 output ports.

Windowing

This operator does not accept any window configurations.

Parameters

This operator does not support parameters.

Metrics

This operator does not report any metrics.

Examples

composite Main {
  graph
   () as JCP = JobControlPlane() {}
}

Types

MBeanNotificationBase

MBeanNotificationBase = rstring source, rstring notifyType, int64 sequence, timestamp ts, rstring message;

MBeanNotificationUserString

Type containing a single attribute that is used to extract the user data as an rstring from a JMX notification. See MBeanNotificationBase.

MBeanNotificationUserString = rstring userStringData;

MBeanNotification

Type that represents a JMX notification from an MBean.

MBeanNotification = tuple<rstring jobId>, MBeanNotificationBase, MBeanNotificationUserString;