com.ibm.streams.operator.control.variable

Class AbstractControlVariable<T>

java.lang.Object

javax.management.NotificationBroadcasterSupport

com.ibm.streams.operator.control.NotifierSupport<T>

com.ibm.streams.operator.control.AbstractPersistentControlMBean<T>

com.ibm.streams.operator.control.variable.AbstractControlVariable<T>

Type Parameters:

T -

All Implemented Interfaces:

PersistentControlMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter

Direct Known Subclasses:

BooleanControlVariable, DoubleControlVariable, LongControlVariable, StringControlVariable

public abstract class AbstractControlVariable<T>
extends AbstractPersistentControlMBean<T>

Abstract control variable for the Job Control Plane (JCP). Applications can create MBeans that represent control variables in the JCP using concrete sub-classes, such as StringControlVariable.
The name of the switch is taken from the name property of the bean's ObjectName.

Since:

InfoSphere® Streams Version 4.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IBM_COPYRIGHT

Fields inherited from class com.ibm.streams.operator.control.NotifierSupport

ATTRIBUTE_CHANGE_INFO

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractControlVariable(javax.management.MBeanNotificationInfo... info)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
javax.management.ObjectName	preRegister(javax.management.MBeanServer server, javax.management.ObjectName name) Actions the MBean takes before it is registered in an MBean server.

Methods inherited from class com.ibm.streams.operator.control.AbstractPersistentControlMBean

persistControlState, setupComplete

Methods inherited from class com.ibm.streams.operator.control.NotifierSupport

getObjectName, getServer, nextSequence, postDeregister, postRegister, preDeregister, sendAttributeChangeNotification, sendBooleanAttributeChangeNotification, sendNotification, sendNotification

Methods inherited from class javax.management.NotificationBroadcasterSupport

addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.streams.operator.control.PersistentControlMBean

updateControlState

Field Detail

IBM_COPYRIGHT

public static final java.lang.String IBM_COPYRIGHT

See Also:

Constant Field Values

Constructor Detail

AbstractControlVariable

protected AbstractControlVariable(javax.management.MBeanNotificationInfo... info)

Method Detail

preRegister

public javax.management.ObjectName preRegister(javax.management.MBeanServer server,
                                               javax.management.ObjectName name)
                                        throws java.lang.Exception

Description copied from class: NotifierSupport

Actions the MBean takes before it is registered in an MBean server.
The implementation saves server and name for future use by the MBean. Sub-classes must call super.preRegister(server,name). If name is null then then sub-class must call this once it has created the ObjectName it will return.

Specified by:

preRegister in interface javax.management.MBeanRegistration

Overrides:

preRegister in class NotifierSupport<T>

Parameters:

server - MBean server this MBean is being registered in.

name - Name of this MBean, if null then the MBean must create an ObjectName and return it from this method.

Returns:

Name to register this MBean under, must not be null.

Throws:

java.lang.Exception - registering this MBean.

getName

public final java.lang.String getName()