Package com.inductiveautomation.factorypmi.application.script.builtin

Class ClientSystemUtilities

java.lang.Object

com.inductiveautomation.ignition.common.script.builtin.SystemUtilities

com.inductiveautomation.factorypmi.application.script.builtin.ClientSystemUtilities

public class ClientSystemUtilities
extends SystemUtilities

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ClientSystemUtilities.SendRequestManager

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.script.builtin.SystemUtilities

SystemUtilities.RequestImpl

Field Summary

Fields

Modifier and Type	Field	Description
static int	APPLET_FLAG
static int	CLIENT_FLAG
static int	DESIGNER_FLAG
static int	FULLSCREEN_FLAG
static int	MOBILE_FLAG
static int	PREVIEW_FLAG
static int	SSL_FLAG
static int	WEBSTART_FLAG

Fields inherited from class com.inductiveautomation.ignition.common.script.builtin.SystemUtilities

DEFAULT_REQUEST_TIMEOUT, log, MSGID_GENERATOR, MSGLOG

Constructor Summary

Constructors

Constructor	Description
ClientSystemUtilities()

Method Summary

Modifier and Type	Method	Description
DatasetUtilities.PyDataSet	_getSessionInfo(java.lang.String unameFilter, java.lang.String projectFilter)
protected java.lang.Thread	_invokeAsyncImpl(org.python.core.PyObject fun)
void	exit()	Exits the FPMI Client.
void	exit(boolean force)
java.util.Collection<java.lang.String>	getAvailableLocales()
java.util.Collection<java.lang.String>	getAvailableTerms()
static java.lang.String	getClientId()
static int	getConnectionMode()
static int	getConnectTimeout()
java.lang.String	getEdition()
static java.lang.String	getGatewayAddress()
long	getInactivitySeconds()	Returns the number of seconds of inactivity for the system
java.lang.String	getLocale()
java.lang.String	getProjectName()
static int	getReadTimeout()
int	getSystemFlags()
void	initialize(FPMIApp app)
org.python.core.PyObject	invokeGateway(java.lang.String function, org.python.core.PyObject... args)	Deprecated.
void	invokeLater(org.python.core.PyObject fun)
void	invokeLater(org.python.core.PyObject fun, int time)
void	modifyTranslation(java.lang.String term, java.lang.String translation)
void	modifyTranslation(java.lang.String term, java.lang.String translation, java.lang.String locale)
Dataset	queryAuditLog(org.python.core.PyObject[] values, java.lang.String[] keywords)
void	retarget(java.lang.String projectName)
void	retarget(java.lang.String projectName, java.lang.String gatewayAddr)
void	retarget(java.lang.String projectName, java.lang.String gatewayAddr, org.python.core.PyDictionary params)
void	retarget(java.lang.String projectName, java.lang.String gatewayAddr, org.python.core.PyDictionary params, java.lang.String[] startupWindows)
java.util.List<java.lang.String>	sendMessageInternal(java.lang.String project, java.lang.String messageHandler, org.python.core.PyDictionary payload, java.util.Properties filterParams)
protected Request	sendRequestInternal(java.lang.String project, java.lang.String messageHandler, org.python.core.PyDictionary payload, java.util.Properties params, boolean async)
static void	setConnectionMode(int mode)
static void	setConnectTimeout(int connectTimeout)
void	setLocale(java.lang.String locale)
static void	setReadTimeout(int readTimeout)
void	shutdown()
java.lang.String	translate(java.lang.String term)
java.lang.String	translate(java.lang.String term, java.lang.String locale, java.lang.Boolean strict)

Methods inherited from class com.inductiveautomation.ignition.common.script.builtin.SystemUtilities

_getCpuUsageString, beep, execute, getGatewayStatus, getLogger, getProperty, getSessionInfo, getSessionInfo, getSessionInfo, getSessionInfo, invokeAsynchronous, jsonDecode, jsonEncode, jsonEncode, jsonEncode, jsonEncode, logger, playSoundClip, playSoundClip, playSoundClip, playSoundClip, sendMessage, sendRequest, sendRequestAsync, sendRequestInternal, setLoggingLevel, threadDump

Methods inherited from class java.lang.Object

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

Field Detail

DESIGNER_FLAG

public static final int DESIGNER_FLAG

See Also:

Constant Field Values

PREVIEW_FLAG

public static final int PREVIEW_FLAG

See Also:

Constant Field Values

CLIENT_FLAG

public static final int CLIENT_FLAG

See Also:

Constant Field Values

WEBSTART_FLAG

public static final int WEBSTART_FLAG

See Also:

Constant Field Values

APPLET_FLAG

public static final int APPLET_FLAG

See Also:

Constant Field Values

FULLSCREEN_FLAG

public static final int FULLSCREEN_FLAG

See Also:

Constant Field Values

SSL_FLAG

public static final int SSL_FLAG

See Also:

Constant Field Values

MOBILE_FLAG

public static final int MOBILE_FLAG

See Also:

Constant Field Values

Constructor Detail

ClientSystemUtilities

public ClientSystemUtilities()

Method Detail

initialize

public void initialize(FPMIApp app)

shutdown

public void shutdown()

getSystemFlags

public int getSystemFlags()

getEdition

public java.lang.String getEdition()

queryAuditLog

public Dataset queryAuditLog(org.python.core.PyObject[] values,
                             java.lang.String[] keywords)

getConnectTimeout

public static int getConnectTimeout()

setConnectTimeout

public static void setConnectTimeout(int connectTimeout)

getReadTimeout

public static int getReadTimeout()

setReadTimeout

public static void setReadTimeout(int readTimeout)

setConnectionMode

public static void setConnectionMode(int mode)

getConnectionMode

public static int getConnectionMode()

exit

public void exit()

Exits the FPMI Client.

exit

public void exit(boolean force)

getInactivitySeconds

public long getInactivitySeconds()

Returns the number of seconds of inactivity for the system

_getSessionInfo

public DatasetUtilities.PyDataSet _getSessionInfo(java.lang.String unameFilter,
                                                  java.lang.String projectFilter)

Specified by:

_getSessionInfo in class SystemUtilities

getLocale

public java.lang.String getLocale()

getAvailableLocales

public java.util.Collection<java.lang.String> getAvailableLocales()

getAvailableTerms

public java.util.Collection<java.lang.String> getAvailableTerms()

setLocale

public void setLocale(java.lang.String locale)

translate

public java.lang.String translate(java.lang.String term)

translate

public java.lang.String translate(java.lang.String term,
                                  java.lang.String locale,
                                  java.lang.Boolean strict)

modifyTranslation

public void modifyTranslation(java.lang.String term,
                              java.lang.String translation)

modifyTranslation

public void modifyTranslation(java.lang.String term,
                              java.lang.String translation,
                              java.lang.String locale)

invokeLater

public void invokeLater(org.python.core.PyObject fun)

invokeLater

public void invokeLater(org.python.core.PyObject fun,
                        int time)

invokeGateway

@Deprecated
public org.python.core.PyObject invokeGateway(java.lang.String function,
                                              org.python.core.PyObject... args)
                                       throws GatewayException

Deprecated.

Throws:

GatewayException

_invokeAsyncImpl

protected java.lang.Thread _invokeAsyncImpl(org.python.core.PyObject fun)

Specified by:

_invokeAsyncImpl in class SystemUtilities

getGatewayAddress

public static java.lang.String getGatewayAddress()

getClientId

public static java.lang.String getClientId()

getProjectName

public java.lang.String getProjectName()

retarget

public void retarget(java.lang.String projectName)

retarget

public void retarget(java.lang.String projectName,
                     java.lang.String gatewayAddr)

retarget

public void retarget(java.lang.String projectName,
                     java.lang.String gatewayAddr,
                     org.python.core.PyDictionary params)

retarget

public void retarget(java.lang.String projectName,
                     java.lang.String gatewayAddr,
                     org.python.core.PyDictionary params,
                     java.lang.String[] startupWindows)

sendMessageInternal

public java.util.List<java.lang.String> sendMessageInternal(java.lang.String project,
                                                            java.lang.String messageHandler,
                                                            org.python.core.PyDictionary payload,
                                                            java.util.Properties filterParams)
                                                     throws java.lang.Exception

Specified by:

sendMessageInternal in class SystemUtilities

Throws:

java.lang.Exception

sendRequestInternal

protected Request sendRequestInternal(java.lang.String project,
                                      java.lang.String messageHandler,
                                      org.python.core.PyDictionary payload,
                                      java.util.Properties params,
                                      boolean async)

Specified by:

sendRequestInternal in class SystemUtilities