com.ergotech.transsecs.secs

Class LocalMessageReference

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.transsecs.secs.LocalMessageReference

public abstract class LocalMessageReference
extends SimpleManipulator

This bean acts as a "wrapper" or reference for a TransSECS generated VIBMessageBean subclass deployed locally. The component uses only the generated data source names of the generated bean to reference the elements and to send and receive 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

Modifier and Type	Field and Description
static java.lang.String	ERROR_STATUS_NAME This datasource will be triggered if an error response is recieved to a message.
static java.lang.String	GOOD_STATUS_NAME This datasource will be triggered if a good response is recieved to a message.
static java.lang.String	RESPONSE_RECEIVED The name of the "responseReceived" inport.
static java.lang.String	RESPONSE_STATUS_NAME This is the name that we publish use to publish the received response.
static java.lang.String	SEND_MESSAGE_NAME This is the name that we publish use to send the.

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

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, DEFAULT_AUTOSUSPEND, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors

Constructor and Description
LocalMessageReference() This sets the inports based on the Vector provided by getInports.

Method Summary

Modifier and Type	Method and Description
void	errorStatusReceived(ValueChangedEvent newEvent) Called after sending the message when the result of sending, up to and including seeing a response, is known.
DataSource	getDataSource(java.lang.String name) Added for backward compatibility.
Connector	getErrorConnector() Search the sources for a connector with the inport ERROR_STATUS_NAME with a source of a VIBMessageBean and the outport ERROR_STATUS_NAME
Connector	getGoodConnector() Search the sources for a connector with the inport GOOD_STATUS_NAME with a source of a VIBMessageBean and the outport GOOD_STATUS_NAME
Connector	getResponseConnector() Search the sources for a connector with the inport RESPONSE_RECEIVED with a source of a VIBMessageBean and the outport RESPONSE_STATUS_NAME
int	getStaticLocationFor(java.lang.String method) This is the default getStaticLocationFor with a location used by the staticmethodevent to find a specific entry value object.
void	goodStatusReceived(ValueChangedEvent newEvent) Called after sending the message when the result of sending, up to and including seeing a response, is known.
void	init() Initialize the component.
void	responseReceived(ValueChangedEvent newEvent) Called after sending the message when the result of sending, up to and including seeing a response, is known.
void	start() Add the connector for the response.
void	stop() Remove the connector for the response.
void	valueChanged(int loc, ValueChangedEvent e) Uses the locations hashtable to find a server that matches the need and then calls valueInput on it.
void	valueInput(ValueChangedEvent newEvent) Send the message, resolve the notification status and output the result of sending the message.

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

getDefaultQualityForLocation

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

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

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

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, destroy, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSources, getDisplayName, getExportCriteria, getExposeComponentConnections, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, setValueObject, 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, getScriptEngine, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, performScriptSubstitutions, 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

Field Detail

ERROR_STATUS_NAME

public static final java.lang.String ERROR_STATUS_NAME

This datasource will be triggered if an error response is recieved to a message. This must match the definition in VIBMessageBean and is duplicated here to aviod causing a reference to VIBMessageBean.

See Also:

Constant Field Values

GOOD_STATUS_NAME

public static final java.lang.String GOOD_STATUS_NAME

This datasource will be triggered if a good response is recieved to a message. This must match the definition in VIBMessageBean and is duplicated here to aviod causing a reference to VIBMessageBean.

See Also:

Constant Field Values

RESPONSE_RECEIVED

public static final java.lang.String RESPONSE_RECEIVED

The name of the "responseReceived" inport.

See Also:

Constant Field Values

RESPONSE_STATUS_NAME

public static final java.lang.String RESPONSE_STATUS_NAME

This is the name that we publish use to publish the received response. The name of the tool and the message (getControllerName and getName) are prepended. This must match the definition in VIBMessageBean and is duplicated here to aviod causing a reference to VIBMessageBean.

See Also:

Constant Field Values

SEND_MESSAGE_NAME

public static final java.lang.String SEND_MESSAGE_NAME

This is the name that we publish use to send the. The name of the tool and the message (getControllerName and getName) are prepended. This must match the definition in VIBMessageBean and is duplicated here to aviod causing a reference to VIBMessageBean.

See Also:

Constant Field Values

Constructor Detail

LocalMessageReference

public LocalMessageReference()

This sets the inports based on the Vector provided by getInports.

Method Detail

errorStatusReceived

public void errorStatusReceived(ValueChangedEvent newEvent)
                         throws VIBUpdateFailedException

Called after sending the message when the result of sending, up to and including seeing a response, is known. This will be called if sending the message failed, or the expected response was not received.

Parameters:

newEvent - The ValueChangedEvent that the bean or data source has sent.

Throws:

VIBUpdateFailedException

getDataSource

public DataSource getDataSource(java.lang.String name)
                         throws BadParameterException

Added for backward compatibility. A request for "PrimaryOutPort", which has been removed, will return "GOOD_STATUS_NAME" outport

Overrides:

getDataSource in class SimpleDataSource

Throws:

BadParameterException

getErrorConnector

public Connector getErrorConnector()

Search the sources for a connector with the inport ERROR_STATUS_NAME with a source of a VIBMessageBean and the outport ERROR_STATUS_NAME

Returns:

the errorConnector

getGoodConnector

public Connector getGoodConnector()

Search the sources for a connector with the inport GOOD_STATUS_NAME with a source of a VIBMessageBean and the outport GOOD_STATUS_NAME

Returns:

the goodConnector

getResponseConnector

public Connector getResponseConnector()

Search the sources for a connector with the inport RESPONSE_RECEIVED with a source of a VIBMessageBean and the outport RESPONSE_STATUS_NAME

Returns:

the responseConnector

getStaticLocationFor

public int getStaticLocationFor(java.lang.String method)
                         throws BadParameterException

This is the default getStaticLocationFor with a location used by the staticmethodevent to find a specific entry value object. This will return 0 every time.

Overrides:

getStaticLocationFor in class Manipulator

Throws:

BadParameterException

goodStatusReceived

public void goodStatusReceived(ValueChangedEvent newEvent)
                        throws VIBUpdateFailedException

Called after sending the message when the result of sending, up to and including seeing a response, is known. This will be called if sending the message succeeded and the expected response (if any) was seen.

Parameters:

newEvent - The ValueChangedEvent that the bean or data source has sent.

Throws:

VIBUpdateFailedException

init

public void init()
          throws BadParameterException

Initialize the component.

Overrides:

init in class DataSource

Throws:

BadParameterException

responseReceived

public void responseReceived(ValueChangedEvent newEvent)
                      throws VIBUpdateFailedException

Called after sending the message when the result of sending, up to and including seeing a response, is known.

Parameters:

newEvent - The ValueChangedEvent that the bean or data source has sent.

Throws:

VIBUpdateFailedException

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

Add the connector for the response.

Overrides:

start in class SimpleDataSource

Throws:

BadParameterException

VIBUpdateFailedException

See Also:

PLCDeviceServer.start()

stop

public void stop()
          throws BadParameterException

Remove the connector for the response.

Overrides:

stop in class SimpleDataSource

Throws:

BadParameterException

See Also:

SimpleDataSource.stop()

valueChanged

public void valueChanged(int loc,
                         ValueChangedEvent e)
                  throws VIBUpdateFailedException,
                         BadParameterException

Uses the locations hashtable to find a server that matches the need and then calls valueInput on it.

Overrides:

valueChanged in class Manipulator

Throws:

BadParameterException

VIBUpdateFailedException

valueInput

public void valueInput(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

Send the message, resolve the notification status and output the result of sending the message.

Overrides:

valueInput in class Manipulator

Parameters:

newEvent - The ValueChangedEvent that the bean or data source has sent.

Throws:

VIBUpdateFailedException