PersistentControlMBean (IBM InfoSphere Streams Java Operator API)

All Known Subinterfaces:

BooleanControlVariableMXBean, DoubleControlVariableMXBean, LongControlVariableMXBean, RegionMonitorMXBean, StringControlVariableMXBean

All Known Implementing Classes:

AbstractControlVariable, AbstractPersistentControlMBean, BooleanControlVariable, DoubleControlVariable, LongControlVariable, StringControlVariable
```
public interface PersistentControlMBean
```
Control state persistence for MBeans in the Job Control Plane (JCP).
An MBean that implements PersistentControlMBean is automatically persisted by the JCP when it is created using MBeanServerConnection.createMBean. The JCP persists the class name, object name and constructor signature and arguments after the MBean is registered but before the createMBean call returns. After any restart of the Job Control Plane, persisted MBeans are recreated and registered in the Job Control Plane before it is made available to operators in the job.
An MBean's can persist additional state by invoking the ControlPlaneMXBean.persistControlState(javax.management.ObjectName, byte[]) against the ControlPlaneManagement.MGMT_NAME MBean. After a JCP restart if such persisted state exists for a PersistentControlMBean, then its updateControlState(byte[]) is called to allow the MBean to update its control state to its last persisted value.
Note that PersistentControlMBeans should only persist state that changes using persistControlState, information that is passed into the constructor is persisted automatically by the JCP.

Since:

InfoSphere® Streams Version 4.0

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`setupComplete()` Called when the JCP has completed its persistent setup of this MBean.
`void`	`updateControlState(byte[] controlState)` Called when the JCP discovers that data has been associated with this MBean (via its name).

- Method Detail
  - updateControlState
```
void updateControlState(byte[] controlState)
```
    Called when the JCP discovers that data has been associated with this MBean (via its name).
    
    Parameters:
    controlState - Control state previous persisted for this MBean.
  - setupComplete
```
void setupComplete()
```
    Called when the JCP has completed its persistent setup of this MBean. This is always called after the MBean has been registered.
    For the first (explicit) creation of the MBean using createMBean(), it will be called once the MBean's constructor arguments have been persisted.
    On subsequent creations of the MBean, driven by the previous persist of the constructor arguments, it will be called after updateControlState(byte[]) if the MBean previously persisted data using AbstractPersistentControlMBean.persistControlState(byte[]) or ControlPlaneMXBean.persistControlState(javax.management.ObjectName, byte[]), otherwise it is called once it is determined no control data was persisted.
    Once this method is called, this MBean has its most recent control state.

updateControlState

setupComplete