com.ergotech.transsecs.secs

Class MessageBean

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.manipulators.Manipulator

com.ergotech.vib.manipulators.SimpleManipulator

com.ergotech.vib.manipulators.BroadcastServer

com.ergotech.transsecs.secs.MessageBean

public class MessageBean
extends BroadcastServer

This component will send a message. The output of the bean is the result of sending the message.

Nested Class Summary

Nested classes/interfaces inherited from class com.ergotech.vib.servers.SimpleDataSource

SimpleDataSource.NameEditorData

Nested classes/interfaces inherited from class com.ergotech.vib.servers.DataSource

DataSource.Writable

Field Summary

Fields inherited from class com.ergotech.vib.manipulators.BroadcastServer

cvsRev

Fields inherited from class com.ergotech.vib.manipulators.Manipulator

UPDATE_DISPLAYED_VALUE, VALUE_INPUT

Fields inherited from class com.ergotech.vib.servers.SimpleDataSource

customTimer, EXPORT_READ_ONLY, EXPORT_READ_WRITE, NO_EXPORT, requiresSyncWrite, sharedTimer, syncWriteTimeout, timebase

Fields inherited from class com.ergotech.vib.servers.DataSource

autoSuspend, AUTOSUSPEND_DEFAULT, AUTOSUSPEND_NEVER, AUTOSUSPEND_NO_LISTENERS, AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES, colorHi, colorHiHi, colorLo, colorLoLo, colorNormal, connectors, consoleLogger, currentColor, currentValue, debugLevel, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors

Constructor and Description
MessageBean() constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessageName()
java.lang.String	getToolName()
void	initMessage() Finds the controller and specific message and creates connectors from the message.
void	messageReceivedEvent(ValueChangedEvent event) The "MessageReceived" event.
void	setMessageName(java.lang.String messageName)
void	setToolName(java.lang.String toolName)
void	start() Calls initMessage to find the controller and specific message and creates connectors from the message.
void	stop() Removes the connector and nulls the message variable.
void	valueInput(ValueChangedEvent newEvent) Causes the message to be sent.

Methods inherited from class com.ergotech.vib.manipulators.BroadcastServer

setValueObject

Methods inherited from class com.ergotech.vib.manipulators.SimpleManipulator

getDefaultQualityForLocation

Methods inherited from class com.ergotech.vib.manipulators.Manipulator

getInPortNames, getStaticLocationFor, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, valueChanged

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, destroy, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, tick, VIBEvent

Methods inherited from class com.ergotech.vib.servers.DataSource

addVIBEventListener, checkScript, executeInScriptInternal, executeScript, executeScriptInternal, executeScriptInternal, getAutoSuspend, getBooleanValue, getBoolValue, getColorHi, getColorHiHi, getColorLo, getColorLoLo, getColorNormal, getConnectors, getConsoleLogger, getCurrentColor, getDataSourceName, getDoubleValue, getFloatValue, getGWTLogger, getIncomingValueObject, getInScript, getIntValue, getLongValue, getParent, getPopupLogger, getScript, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, popupMessage, post, removeConnector, removeVIBEventListener, replaceConnectors, scriptExtensionSubstition, setColorHi, setColorHiHi, setColorLo, setColorLoLo, setColorNormal, setConsoleLogger, setGWTLogger, setHardSuspended, setInScript, setParent, setPopupLogger, setScript, setSendColors, setSendOnlyChangedValuesDefault, setSyncWriteTimeout, setTimedPopupLogger, setTraceLogger, setValueHi, setValueHiHi, setValueLo, setValueLoLo, updateColor, updateListeners, updateListeners, updateListeners, whoAmI

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageBean

public MessageBean()

constructor

Method Detail

getMessageName

public java.lang.String getMessageName()

Returns:

Returns the messageName.

getToolName

public java.lang.String getToolName()

Returns:

Returns the toolName.

initMessage

public void initMessage()

Finds the controller and specific message and creates connectors from the message. This will cause a full initialization regardless of the current state of the bean. That is, it should be called only once.

messageReceivedEvent

public void messageReceivedEvent(ValueChangedEvent event)
                          throws VIBUpdateFailedException

The "MessageReceived" event. Called when the message we are proxying for is received.

Throws:

VIBUpdateFailedException - thrown if "setValueObject" throws.

setMessageName

public void setMessageName(java.lang.String messageName)

Parameters:

messageName - The messageName to set.

setToolName

public void setToolName(java.lang.String toolName)

Parameters:

toolName - The toolName to set.

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

Calls initMessage to find the controller and specific message and creates connectors from the message.

Overrides:

start in class SimpleDataSource

Throws:

BadParameterException

VIBUpdateFailedException

See Also:

SimpleDataSource.start()

stop

public void stop()
          throws BadParameterException

Removes the connector and nulls the message variable.

Overrides:

stop in class SimpleDataSource

Throws:

BadParameterException

See Also:

SimpleDataSource.stop()

valueInput

public void valueInput(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

Causes the message to be sent. This is called "Send Message" in the beaninfo.

Overrides:

valueInput in class BroadcastServer

Parameters:

newEvent - an event from the registered data source

Throws:

VIBUpdateFailedException

See Also:

BroadcastServer.setValueObject(ValueObjectInterface)