Package com.inductiveautomation.ignition.common.script

Class 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 Detail

      • 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

      • scheduledScripts

        protected java.util.List<com.inductiveautomation.ignition.common.script.ScheduledScript> scheduledScripts

    • 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)

      • getUpdateScript

        public java.lang.String getUpdateScript()

      • setUpdateScript

        public void setUpdateScript​(java.lang.String updateScript)

      • getTimerScripts

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

      • setTimerScripts

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

      • getMessageHandlerScripts

        @Nonnull
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

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

      • setScheduledScripts

        public void setScheduledScripts​(java.util.List<com.inductiveautomation.ignition.common.script.ScheduledScript> scheduledScripts)

      • getScheduledScripts

        @Nonnull
public java.util.List<com.inductiveautomation.ignition.common.script.ScheduledScript> getScheduledScripts()

      • setTagChangeScripts

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

      • 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()

      • 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()

      • 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