com.ibm.streams.operator.control

Interface ControlPlaneMXBean

public interface ControlPlaneMXBean

Management for the Job Control Plane. A single instance of this Mbean is registered in the Job Control Plane MBean server, with name ControlPlaneManagement.MGMT_NAME.
These MBeans are registered with this Job Control Plane.

• JobMXBean registered with the name ControlPlaneManagement.JOB_NAME representing this job.
• A PeMXBean for each PE in this job. The name for a PeMXBean can be obtained using ControlPlaneManagement.getPEName(BigInteger).

The MBeans are proxies to the MBeans in the Domain JMX and only support a subset of the functionality available in the Domain JMX. Namely this functionality is not supported:

• Any operation that modifies the job or its processing elements, such as JobMXBean.cancel() or PeMXBean.stop().
• Any operation that creates or uses an OperationListener.
• Any operation that returns an URI to retrieve information.

Since:

InfoSphere® Streams Version 4.0

Method Summary

Methods

Modifier and Type	Method and Description
java.math.BigInteger	getJobId() Get the job identifier.
boolean	isConnectedToDomain() Does this Job Control Plane have an open connection to the Domain JMX.
void	persistControlState(javax.management.ObjectName name, byte[] controlState) Persist control state for a registered MBean.
javax.management.ObjectName	registerRegionMonitor(java.lang.String name, java.util.Set<java.math.BigInteger> pes) Register a RegionMonitorMXBean for an arbitrary set of processing elements within this job.
void	reportFailure(java.math.BigInteger peId) Report an apparent failure for a processing element.

Method Detail

getJobId

java.math.BigInteger getJobId()

Get the job identifier.

Returns:

Job identifier.

registerRegionMonitor

javax.management.ObjectName registerRegionMonitor(java.lang.String name,
                                                java.util.Set<java.math.BigInteger> pes)
                                                  throws javax.management.InstanceNotFoundException,
                                                         java.lang.InterruptedException

Register a RegionMonitorMXBean for an arbitrary set of processing elements within this job. Thus the region comprises all the operators in all of the specified processing elements.
A RegionMonitiorMXBean is used to monitor the health of a region within the current graph.

Parameters:

name - Name for the region monitor

pes - Set of processing elements that define the region. Any processing element identifier that is not part of the current job will be ignored and not monitored.

Returns:

The ObjectName for the registered RegionMonitorMXBean.

Throws:

java.lang.IllegalArgumentException - pes does not contain any processing elements within this job.

java.lang.IllegalStateException - The Job Control Plane has not connected to the Domain JMX.

javax.management.InstanceNotFoundException

java.lang.InterruptedException

reportFailure

void reportFailure(java.math.BigInteger peId)

Report an apparent failure for a processing element. Causes any RegionMonitorMXBean in the Control Plane that contains processing element peId to notify a failure. No action is performed against the processing element.

If a processing element connected to this control plane has its JMX connection broken then this method will be called automatically.

Parameters:

peId - Processing element identifier

persistControlState

void persistControlState(javax.management.ObjectName name,
                       byte[] controlState)
                         throws javax.management.InstanceNotFoundException,
                                java.io.IOException,
                                java.lang.InterruptedException

Persist control state for a registered MBean. On restart of the processing element containing the Job Control Plane, the saved control state is passed to PersistentControlMBean.updateControlState(byte[]).
Use of AbstractPersistentControlMBean is recommended for MBeans that need to persist state.

Parameters:

name - Name of the MBean registering the data.

controlState - State to be persisted.

Throws:

javax.management.InstanceNotFoundException - MBean name is not registered.

java.io.IOException

java.lang.InterruptedException

See Also:

Interface for MBeans that persist state., Abstract MBean that simplifies control state persistence.

isConnectedToDomain

boolean isConnectedToDomain()

Does this Job Control Plane have an open connection to the Domain JMX.

Returns:

true if currently connected to the Domain JMX, false otherwise.