com.ergotech.vib.servers

Class DeviceManagerManipulator

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.servers.DeviceManagerManipulator

Direct Known Subclasses:

HistoricalDeviceManager, PortDeviceServer, RaspiDeviceManager, ServersDeviceManager, ValueHolderDeviceManager

public class DeviceManagerManipulator
extends SimpleManipulator

This is a device manager that allows creation of servers and some manipulators

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.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
DeviceManagerManipulator()

Method Summary

Modifier and Type	Method and Description
java.util.LinkedHashMap<java.lang.String,java.lang.String>	availableServers() The list of possible sub-servers of this device.
ValueObjectInterface	clientRequest(java.lang.String target, java.lang.String request, int requestId, ValueObjectInterface value) Overridden to allow for a DeviceInterface.PREPARE_SERVER and DeviceInterface.RELEASE_SERVER.
SimpleDataSource	createServer(java.lang.String className, java.lang.String serverName) Create the server.
void	deleteDevice() This method indicates that this device is being removed and all servers associated with it should be cleaned up an removed.
void	deleteServer(SimpleDataSource server) Delete the provided server.
void	destroy() Destroy all the servers.
void	earlyStart() Start all the servers that are set to not fire late.
SimpleDataSource[]	getEditableServers() Returns all the servers that are in the "serverContainer".
SimpleDataSource[]	getPersistentServers() Return servers that should be edited in a tree.
DataSourceContainer	getServerContainer()
SimpleDataSource[]	getServers() Return the list of servers that need to be persisted.
SimpleDataSource[]	getServersInternal() Return a list of all servers.
SimpleDataSource[]	getViewServers() Return view-only servers.
void	init() Init all the servers.
SimpleDataSource	preparingServer(SimpleDataSource server) An opportunity for a subclass to configure a server that is being prepared.
void	setContainer(DataSourceContainer container) Moves the server container to the new container.
void	setName(java.lang.String name) The name of the device.
void	setServers(SimpleDataSource[] servers) Adds all the servers to the server container.
void	start() Start all the servers.
void	stop() Stop all the servers.

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, valueInput

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

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientResponse, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getExposeComponentConnections, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, 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

Constructor Detail

DeviceManagerManipulator

public DeviceManagerManipulator()

Method Detail

availableServers

public java.util.LinkedHashMap<java.lang.String,java.lang.String> availableServers()

The list of possible sub-servers of this device.

Returns:

a hash of server name vs server class for the demo servers.

clientRequest

public ValueObjectInterface clientRequest(java.lang.String target,
                                          java.lang.String request,
                                          int requestId,
                                          ValueObjectInterface value)
                                   throws VIBUpdateFailedException,
                                          BadParameterException

Overridden to allow for a DeviceInterface.PREPARE_SERVER and DeviceInterface.RELEASE_SERVER.

Overrides:

clientRequest in class SimpleDataSource

request - the request string which is interpreted by any server

requestId - the id of the request that should be returned in any response.

value - the value associated with this request. This may be null.

Throws:

BadParameterException

VIBUpdateFailedException - thrown if the server cannot fulfil the request.

See Also:

com.ergotech.vib.servers.SimpleDataSource#clientRequest(java.lang.String, int, com.ergotech.vib.valueobjects.ValueObjectInterface)

createServer

public SimpleDataSource createServer(java.lang.String className,
                                     java.lang.String serverName)
                              throws BadParameterException

Create the server. The string provided is the class name.

Throws:

BadParameterException

deleteDevice

public void deleteDevice()

This method indicates that this device is being removed and all servers associated with it should be cleaned up an removed.

deleteServer

public void deleteServer(SimpleDataSource server)

Delete the provided server.

destroy

public void destroy()
             throws BadParameterException

Destroy all the servers.

Overrides:

destroy in class SimpleDataSource

Throws:

BadParameterException

See Also:

com.ergotech.vib.utils.LifeCycle#destroy()

earlyStart

public void earlyStart()
                throws BadParameterException,
                       VIBUpdateFailedException

Start all the servers that are set to not fire late.

Throws:

BadParameterException

VIBUpdateFailedException

See Also:

com.ergotech.vib.utils.LifeCycle#start()

getEditableServers

public SimpleDataSource[] getEditableServers()

Returns all the servers that are in the "serverContainer". By default this is a pass through to getServersInternal().

getPersistentServers

public SimpleDataSource[] getPersistentServers()

Return servers that should be edited in a tree. By default this method returns null to allow all servers to be edited in a table.

getServerContainer

public DataSourceContainer getServerContainer()

Returns:

Returns the serverContainer.

getServers

public SimpleDataSource[] getServers()

Return the list of servers that need to be persisted. This returns all servers for this manager because all servers are persisted. By default, this is a pass through to getServersInternal()

getServersInternal

public SimpleDataSource[] getServersInternal()

Return a list of all servers. This list is obtained by scanning the server container and returning all instances from that container.

Returns:

all servers

getViewServers

public SimpleDataSource[] getViewServers()

Return view-only servers. By default this method returns null because all servers are editable.

init

public void init()
          throws BadParameterException

Init all the servers.

Overrides:

init in class DataSource

Throws:

BadParameterException

See Also:

com.ergotech.vib.utils.LifeCycle#init()

preparingServer

public SimpleDataSource preparingServer(SimpleDataSource server)

An opportunity for a subclass to configure a server that is being prepared.

setContainer

public void setContainer(DataSourceContainer container)
                  throws BadParameterException

Moves the server container to the new container.

Overrides:

setContainer in class SimpleDataSource

Parameters:

container - The container to set.

Throws:

BadParameterException

See Also:

com.ergotech.vib.servers.SimpleDataSource#setContainer(com.ergotech.vib.utils.DataSourceContainer)

setName

public void setName(java.lang.String name)
             throws BadParameterException

The name of the device. This is an arbitrary string provided by the user. This method will also reset currentErrorCount.

Overrides:

setName in class SimpleDataSource

Throws:

BadParameterException

See Also:

#getTagName

setServers

public void setServers(SimpleDataSource[] servers)

Adds all the servers to the server container. By default this is a pass through to setServersInternal().

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

Start all the servers.

Overrides:

start in class SimpleDataSource

Throws:

BadParameterException

VIBUpdateFailedException

See Also:

com.ergotech.vib.utils.LifeCycle#start()

stop

public void stop()
          throws BadParameterException

Stop all the servers.

Overrides:

stop in class SimpleDataSource

Throws:

BadParameterException

See Also:

com.ergotech.vib.utils.LifeCycle#stop()