Class ScriptConfig
- java.lang.Object
-
- com.inductiveautomation.ignition.common.script.ScriptConfig
-
- Direct Known Subclasses:
ClientScriptConfig
,SystemEventsConfig
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 Description protected MessageHandlerManager
messageHandlerManager
protected java.util.Map<MessageHandlerKey,java.lang.String>
messageHandlerScripts
static java.lang.String
MODULE_ID
static ResourceType
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
protected java.lang.String
updateScript
-
Constructor Summary
Constructors Constructor Description ScriptConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method 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.List<ProjectScriptDiagnostic>
getMessageHandlerScriptDiagnostics()
java.util.Map<MessageHandlerKey,java.lang.String>
getMessageHandlerScripts()
java.lang.String
getShutdownScript()
java.lang.String
getStartupScript()
java.util.List<ProjectScriptDiagnostic>
getTagChangeScriptDiagnostics()
java.util.List<ScriptExecutionReport>
getTagChangeScriptExecutionReports()
java.util.List<TagChangeScript>
getTagChangeScripts()
java.util.List<ProjectScriptDiagnostic>
getTimerScriptDiagnostics()
java.util.List<ScriptExecutionReport>
getTimerScriptExecutionReports()
java.util.Map<TimerKey,java.lang.String>
getTimerScripts()
java.lang.String
getUpdateScript()
void
invokeGWMessageHandler(java.lang.String messageHandlerName, org.python.core.PyDictionary messageParams)
Deprecated.void
invokeGWMessageHandler(java.lang.String messageHandlerName, org.python.core.PyDictionary messageParams, java.util.Properties filterParams)
void
invokeGWRequestHandler(java.lang.String messageHandlerName, org.python.core.PyDictionary messageParams, MessageResultHandler handler)
Deprecated.void
invokeGWRequestHandler(java.lang.String messageHandlerName, org.python.core.PyDictionary messageParams, MessageResultHandler handler, java.util.Properties filterParams)
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
setUpdateScript(java.lang.String updateScript)
void
shutdown()
Shuts down long-running tasks in the script config, such as timer scripts and tag change scriptsvoid
startup(java.lang.String projectName, ScriptManager manager, TagManager tagManager, IScriptsEnabled scriptsEnabled)
-
-
-
Field Detail
-
MODULE_ID
public static final java.lang.String MODULE_ID
- See Also:
- Constant Field Values
-
RESOURCE_TYPE
public static final ResourceType RESOURCE_TYPE
-
startupScript
protected java.lang.String startupScript
-
shutdownScript
protected java.lang.String shutdownScript
-
updateScript
protected java.lang.String updateScript
-
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
-
-
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)
-
getUpdateScript
public java.lang.String getUpdateScript()
-
setUpdateScript
public void setUpdateScript(java.lang.String updateScript)
-
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, TagManager 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()
-
getTimerScriptDiagnostics
public java.util.List<ProjectScriptDiagnostic> getTimerScriptDiagnostics()
-
getTagChangeScriptDiagnostics
public java.util.List<ProjectScriptDiagnostic> getTagChangeScriptDiagnostics()
-
getMessageHandlerScriptDiagnostics
public java.util.List<ProjectScriptDiagnostic> getMessageHandlerScriptDiagnostics()
-
getMessageHandlerManager
public MessageHandlerManager getMessageHandlerManager()
Returns an instance of the MessageHandlerManager so that the client can register a push listener and use this manager.
-
getMessageHandlerExecutionReports
public java.util.List<ScriptExecutionReport> getMessageHandlerExecutionReports()
-
invokeGWRequestHandler
@Deprecated public void invokeGWRequestHandler(java.lang.String messageHandlerName, org.python.core.PyDictionary messageParams, MessageResultHandler handler) throws MessageHandlerException
Deprecated.- Throws:
MessageHandlerException
-
invokeGWRequestHandler
public void invokeGWRequestHandler(java.lang.String messageHandlerName, org.python.core.PyDictionary messageParams, MessageResultHandler handler, java.util.Properties filterParams) throws MessageHandlerException
- Throws:
MessageHandlerException
-
invokeGWMessageHandler
@Deprecated public void invokeGWMessageHandler(java.lang.String messageHandlerName, org.python.core.PyDictionary messageParams) throws MessageHandlerException
Deprecated.- Throws:
MessageHandlerException
-
invokeGWMessageHandler
public void invokeGWMessageHandler(java.lang.String messageHandlerName, org.python.core.PyDictionary messageParams, java.util.Properties filterParams) throws MessageHandlerException
- Throws:
MessageHandlerException
-
-