com.inductiveautomation.ignition.common.script

Class ScriptConfig

java.lang.Object

com.inductiveautomation.ignition.common.script.ScriptConfig

Direct Known Subclasses:

ClientScriptConfig

public class ScriptConfig
extends java.lang.Object

This class is simply a storage class for the serialization of various script configuration things. An instance of this class is held by the root FPMIApp and it stores things like the startup and shutdown scripts, the keystroke scripts, and the timer scripts.

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageHandlerManager	messageHandlerManager
protected java.util.Map<MessageHandlerKey,java.lang.String>	messageHandlerScripts
static java.lang.String	MODULE_ID
static java.lang.String	RESOURCE_TYPE
protected java.lang.String	shutdownScript
protected java.lang.String	startupScript
protected TagChangeScriptManager	tagChangeManager
protected java.util.List<TagChangeScript>	tagChangeScripts
protected TimerScriptManager	timerScriptManager
protected java.util.Map<TimerKey,java.lang.String>	timerScripts

Constructor Summary

Constructors

Constructor and Description
ScriptConfig()

Method Summary

Modifier and Type	Method and Description
java.util.List<ScriptExecutionReport>	getMessageHandlerExecutionReports()
MessageHandlerManager	getMessageHandlerManager() Returns an instance of the MessageHandlerManager so that the client can register a push listener and use this manager.
java.util.Map<MessageHandlerKey,java.lang.String>	getMessageHandlerScripts()
java.lang.String	getShutdownScript()
java.lang.String	getStartupScript()
java.util.List<ScriptExecutionReport>	getTagChangeScriptExecutionReports()
java.util.List<TagChangeScript>	getTagChangeScripts()
java.util.List<ScriptExecutionReport>	getTimerScriptExecutionReports()
java.util.Map<TimerKey,java.lang.String>	getTimerScripts()
void	invokeGWMessageHandler(java.lang.String messageHandlerName, org.python.core.PyDictionary messageParams)
void	setMessageHandlerScripts(java.util.Map<MessageHandlerKey,java.lang.String> map)
void	setShutdownScript(java.lang.String string)
void	setStartupScript(java.lang.String string)
void	setTagChangeScripts(java.util.List<TagChangeScript> scripts)
void	setTagChangeScripts(java.util.Map<java.lang.String,java.lang.String> oldMap) Deprecated.
void	setTimerScripts(java.util.Map<TimerKey,java.lang.String> map)
void	shutdown() Shuts down long-running tasks in the script config, such as timer scripts and tag change scripts
void	startup(java.lang.String projectName, ScriptManager manager, TagSubscriptionManager tagManager, IScriptsEnabled scriptsEnabled)

Methods inherited from class java.lang.Object

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

Field Detail

MODULE_ID

public static final java.lang.String MODULE_ID

See Also:

Constant Field Values

RESOURCE_TYPE

public static final java.lang.String RESOURCE_TYPE

See Also:

Constant Field Values

startupScript

protected java.lang.String startupScript

shutdownScript

protected java.lang.String shutdownScript

timerScripts

protected java.util.Map<TimerKey,java.lang.String> timerScripts

messageHandlerScripts

protected java.util.Map<MessageHandlerKey,java.lang.String> messageHandlerScripts

tagChangeScripts

protected java.util.List<TagChangeScript> tagChangeScripts

timerScriptManager

protected transient TimerScriptManager timerScriptManager

tagChangeManager

protected transient TagChangeScriptManager tagChangeManager

messageHandlerManager

protected transient MessageHandlerManager messageHandlerManager

Constructor Detail

ScriptConfig

public ScriptConfig()

Method Detail

getShutdownScript

public java.lang.String getShutdownScript()

getStartupScript

public java.lang.String getStartupScript()

setShutdownScript

public void setShutdownScript(java.lang.String string)

setStartupScript

public void setStartupScript(java.lang.String string)

getTimerScripts

public java.util.Map<TimerKey,java.lang.String> getTimerScripts()

setTimerScripts

public void setTimerScripts(java.util.Map<TimerKey,java.lang.String> map)

getMessageHandlerScripts

public java.util.Map<MessageHandlerKey,java.lang.String> getMessageHandlerScripts()

setMessageHandlerScripts

public void setMessageHandlerScripts(java.util.Map<MessageHandlerKey,java.lang.String> map)

setTagChangeScripts

@Deprecated
public void setTagChangeScripts(java.util.Map<java.lang.String,java.lang.String> oldMap)

Deprecated.

getTagChangeScripts

public java.util.List<TagChangeScript> getTagChangeScripts()

setTagChangeScripts

public void setTagChangeScripts(java.util.List<TagChangeScript> scripts)

startup

public void startup(java.lang.String projectName,
                    ScriptManager manager,
                    TagSubscriptionManager tagManager,
                    IScriptsEnabled scriptsEnabled)

shutdown

public void shutdown()

Shuts down long-running tasks in the script config, such as timer scripts and tag change scripts

getTimerScriptExecutionReports

public java.util.List<ScriptExecutionReport> getTimerScriptExecutionReports()

getTagChangeScriptExecutionReports

public java.util.List<ScriptExecutionReport> getTagChangeScriptExecutionReports()

getMessageHandlerManager

public MessageHandlerManager getMessageHandlerManager()

Returns an instance of the MessageHandlerManager so that the client can register a push listener and use this manager.

Returns:

getMessageHandlerExecutionReports

public java.util.List<ScriptExecutionReport> getMessageHandlerExecutionReports()

invokeGWMessageHandler

public void invokeGWMessageHandler(java.lang.String messageHandlerName,
                                   org.python.core.PyDictionary messageParams)
                            throws MessageHandlerException

Throws:

MessageHandlerException