com.inductiveautomation.ignition.designer.gateway

Class DTGatewayInterface

java.lang.Object

com.inductiveautomation.ignition.designer.gateway.DTGatewayInterface

All Implemented Interfaces:

GatewayConstants

public class DTGatewayInterface
extends java.lang.Object
implements GatewayConstants

This is the designer interface to the gateway, which defines various designer-only function to deal with the gateway

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DTGatewayInterface.DatasourceInfo

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.gateway.GatewayConstants

_DATE_FORMATTER, ARG_MESSAGETYPE, ARG_MODULEID, ATR_INDEX, ATR_LENGTH, ATR_NAME, ATR_TYPE, booleanNull, byteNull, charNull, DATE_FORMAT_STRING, doubleNull, ELM_ARG, ELM_COLLIST, ELM_COLUMN, ELM_COMPRESSEDROWS, ELM_DATA, ELM_ERRORCODE, ELM_ERRORMESSAGE, ELM_EXCLS, ELM_EXMSG, ELM_EXOVERRIDES_TOSTRING, ELM_EXSTRING, ELM_MBODY, ELM_MESSAGE, ELM_MTYPE, ELM_NOTIFICATION, ELM_NOTIFICATIONS, ELM_RESPONSE, ELM_ROW, ELM_ROWS, ELM_SERIALIZED_RESPONSE, ELM_SETCOOKIE, ELM_STACKTRACE, ELM_STELM, ELM_STELM_DECL, ELM_STELM_FILE, ELM_STELM_LINE, ELM_STELM_METH, ERRNO_ASYNC_CALL, ERRNO_ASYNC_CALL_CANCELED, ERRNO_ASYNC_CALL_FAILED, ERRNO_BROWSE_ERROR, ERRNO_COMM_ERROR, ERRNO_CONNECTION_MODE, ERRNO_DBCONNECTION_NAMING, ERRNO_DBCONNECTION_SQL, ERRNO_HISTORY_QUERY_ERROR, ERRNO_INTERNAL, ERRNO_INVALIDARGS, ERRNO_INVOCATION_EXCEPTION, ERRNO_LICENE_RESTRICTED, ERRNO_LOGIN_FAILED, ERRNO_LOGIN_FAILED_LICENSING, ERRNO_NAMING, ERRNO_NO_SESSION, ERRNO_NON_ACTIVE_NODE, ERRNO_NON_MASTER_NODE, ERRNO_NOT_AUTHORIZED, ERRNO_NOTIMP, ERRNO_OK, ERRNO_PARSE, ERRNO_PASSWORD_EXPIRED, ERRNO_PONG, ERRNO_POST_ERROR, ERRNO_RUNTIME_EXPIRED, ERRNO_SQL, ERRNO_SQLTAGS_PROVIDER_DISABLED, ERRNO_SQLTAGS_PROVIDER_FAULTED, ERRNO_SQLTAGS_PROVIDER_LOADING, ERRNO_SQLTAGS_PROVIDER_MISSING, ERRNO_SQLTAGS_SEND_TAGS, ERRNO_SSL_REQUIRED, ERRNO_TIMEOUT, ERRNO_TRIAL_EXPIRED, ERRNO_VERSION_INCOMPATABILITY, ERROR_MESSAGE_TYPE, floatNull, intNull, longNull, MODE_DISCONNECTED, MODE_FULL, MODE_READ_ONLY, MTYPE_COPY_IMAGE, MTYPE_CREATE_IMAGE_FOLDER, MTYPE_CREATE_PROJECT, MTYPE_DBTEST, MTYPE_GET_NEW_RESOURCEID, MTYPE_INVALID, MTYPE_INVOKE_FUNCTION, MTYPE_LIST_AUTHS, MTYPE_LIST_COLS, MTYPE_LIST_DBS, MTYPE_LIST_IMAGES, MTYPE_LIST_MODULES, MTYPE_LIST_ROLES, MTYPE_LIST_SQLTAG_PROVIDERS, MTYPE_LIST_TABLES, MTYPE_LIST_ZONES, MTYPE_PING, MTYPE_PLATFORM_EDITION, MTYPE_PUBLIC_PING, MTYPE_REMOVE_IMAGE, MTYPE_REPORT_ERROR, MTYPE_SEND_EMAIL, MTYPE_SQLTAGS_ADD_SCANCLASS, MTYPE_SQLTAGS_ADD_TAGS, MTYPE_SQLTAGS_EDIT_SCANCLASS, MTYPE_SQLTAGS_EDIT_TAGS, MTYPE_SQLTAGS_ERROR_LIST, MTYPE_SQLTAGS_FSQL_BROWSE, MTYPE_SQLTAGS_FSQL_LIST, MTYPE_SQLTAGS_GET_SCANCLASS, MTYPE_SQLTAGS_LIST, MTYPE_SQLTAGS_META_LIST, MTYPE_SQLTAGS_POLL, MTYPE_SQLTAGS_REMOVE_SCANCLASS, MTYPE_SQLTAGS_REMOVE_TAGS, MTYPE_SQLTAGS_WRITE, MTYPE_STATUS_POLL, MTYPE_UPLOAD_IMAGE, MTYPE_VERSION_CHECK, PROTECT_DIALOG_TYPE, shortNull, WARNING_MESSAGE_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DTGatewayInterface()

Method Summary

Modifier and Type	Method and Description
boolean	canEditProtectedResources(long projectId)
ResourceLockRequestResponse	checkLockNotAvailable(long resourceId)
void	copyImage(java.awt.Component dlg, java.lang.String dest, java.lang.String[] paths)
void	createImageFolder(java.awt.Component dlg, java.lang.String name, java.lang.String parent)
long	createProject(java.awt.Component dlg, Project project)
java.util.List<java.lang.String>	getAuditProfiles(java.awt.Component owner)
java.util.Map<java.lang.String,java.lang.Long>	getAuthProfiles(java.awt.Component owner)
java.util.List<BasicProjectChangeRecord>	getAvailableRollbacks(java.awt.Component frame, Project project)
Dataset	getColumnList(java.awt.Component owner, java.lang.String datasource, java.lang.String tablename) Returns a dataset where each row represents a column in the table.
java.util.Map<java.lang.String,DTGatewayInterface.DatasourceInfo>	getDatasources(java.awt.Component owner)
Dataset	getImageList(java.awt.Component dlg, java.lang.String folder)
static DTGatewayInterface	getInstance()
long	getNewResourceId()
java.util.List<Project>	getProjectList(java.awt.Component dlg)
java.util.UUID	getProjectUuid(long id)
java.lang.String[]	getRoles(java.awt.Component owner)
Project	getRollbackDiff(java.awt.Component frame, Project project, long editCount)
java.lang.String[]	getTableList(java.awt.Component owner, java.lang.String datasource)
java.util.List<java.lang.String>	getTagProviders(java.awt.Component owner) Only returns providers that are eligible to be used as default.
java.lang.String[]	getZones(java.awt.Component owner)
Project	loadProject(long id) Note - loads synchronously
void	publishGlobalProject(java.awt.Component frame)
void	publishProject(java.awt.Component frame, java.lang.String commitMessage)
void	publishSelected(java.awt.Component frame, java.util.List<java.lang.Long> projectResources, java.util.List<java.lang.Long> globalResources, java.lang.String commitMessage)
void	releaseResourceLock(long resourceId)
void	removeImage(java.awt.Component dlg, java.lang.String[] paths)
ResourceLockRequestResponse	requestResourceLock(long projectId, long resourceId, long editCount)
Dataset	runQuery(java.awt.Component frame, java.lang.String query, java.lang.String dsn)
Dataset	runQuery(java.awt.Component frame, java.lang.String query, java.lang.String dsn, int limit)
Project	saveProject(java.awt.Component frame, Project project, boolean andPublish, java.lang.String commitMessage)
java.lang.Long	saveProjectAs(java.awt.Component frame, Project project, java.lang.String newName)
void	uploadImage(java.awt.Component dlg, java.lang.String name, java.lang.String desc, java.lang.String type, java.lang.String parentDir, int width, int height, byte[] data)

Methods inherited from class java.lang.Object

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

Constructor Detail

DTGatewayInterface

protected DTGatewayInterface()

Method Detail

getInstance

public static DTGatewayInterface getInstance()

getDatasources

public java.util.Map<java.lang.String,DTGatewayInterface.DatasourceInfo> getDatasources(java.awt.Component owner)
                                                                                 throws GatewayException

Throws:

GatewayException

getTagProviders

public java.util.List<java.lang.String> getTagProviders(java.awt.Component owner)
                                                 throws GatewayException

Only returns providers that are eligible to be used as default.

Throws:

GatewayException

getAuthProfiles

public java.util.Map<java.lang.String,java.lang.Long> getAuthProfiles(java.awt.Component owner)
                                                               throws GatewayException

Throws:

GatewayException

getAuditProfiles

public java.util.List<java.lang.String> getAuditProfiles(java.awt.Component owner)
                                                  throws GatewayException

Throws:

GatewayException

getTableList

public java.lang.String[] getTableList(java.awt.Component owner,
                                       java.lang.String datasource)
                                throws GatewayException

Throws:

GatewayException

getColumnList

public Dataset getColumnList(java.awt.Component owner,
                             java.lang.String datasource,
                             java.lang.String tablename)
                      throws GatewayException

Returns a dataset where each row represents a column in the table. The rows are:

• column_name (name of column)
• data_type (type code from java.sql.Types)
• type_name (database dependent name of type)
• column_size (precision/length)
• primary_key (boolean indicating key status)
• indexed (boolean indicating index status)

Throws:

GatewayException

runQuery

public Dataset runQuery(java.awt.Component frame,
                        java.lang.String query,
                        java.lang.String dsn)
                 throws GatewayException

Throws:

GatewayException

runQuery

public Dataset runQuery(java.awt.Component frame,
                        java.lang.String query,
                        java.lang.String dsn,
                        int limit)
                 throws GatewayException

Throws:

GatewayException

getProjectList

public java.util.List<Project> getProjectList(java.awt.Component dlg)
                                       throws GatewayException

Throws:

GatewayException

createImageFolder

public void createImageFolder(java.awt.Component dlg,
                              java.lang.String name,
                              java.lang.String parent)
                       throws GatewayException

Throws:

GatewayException

removeImage

public void removeImage(java.awt.Component dlg,
                        java.lang.String[] paths)
                 throws GatewayException

Throws:

GatewayException

copyImage

public void copyImage(java.awt.Component dlg,
                      java.lang.String dest,
                      java.lang.String[] paths)
               throws GatewayException

Throws:

GatewayException

uploadImage

public void uploadImage(java.awt.Component dlg,
                        java.lang.String name,
                        java.lang.String desc,
                        java.lang.String type,
                        java.lang.String parentDir,
                        int width,
                        int height,
                        byte[] data)
                 throws GatewayException

Throws:

GatewayException

getImageList

public Dataset getImageList(java.awt.Component dlg,
                            java.lang.String folder)
                     throws GatewayException

Throws:

GatewayException

getAvailableRollbacks

public java.util.List<BasicProjectChangeRecord> getAvailableRollbacks(java.awt.Component frame,
                                                                      Project project)
                                                               throws GatewayException

Throws:

GatewayException

getRollbackDiff

public Project getRollbackDiff(java.awt.Component frame,
                               Project project,
                               long editCount)
                        throws GatewayException

Throws:

GatewayException

saveProjectAs

public java.lang.Long saveProjectAs(java.awt.Component frame,
                                    Project project,
                                    java.lang.String newName)
                             throws GatewayException

Throws:

GatewayException

saveProject

public Project saveProject(java.awt.Component frame,
                           Project project,
                           boolean andPublish,
                           java.lang.String commitMessage)
                    throws GatewayException

Throws:

GatewayException

publishProject

public void publishProject(java.awt.Component frame,
                           java.lang.String commitMessage)
                    throws GatewayException

Throws:

GatewayException

publishGlobalProject

public void publishGlobalProject(java.awt.Component frame)
                          throws GatewayException

Throws:

GatewayException

publishSelected

public void publishSelected(java.awt.Component frame,
                            java.util.List<java.lang.Long> projectResources,
                            java.util.List<java.lang.Long> globalResources,
                            java.lang.String commitMessage)
                     throws GatewayException

Throws:

GatewayException

createProject

public long createProject(java.awt.Component dlg,
                          Project project)
                   throws GatewayException

Throws:

GatewayException

loadProject

public Project loadProject(long id)
                    throws java.lang.Exception

Note - loads synchronously

Parameters:

id - the project id

Throws:

java.lang.Exception - on failure to load project

getProjectUuid

public java.util.UUID getProjectUuid(long id)
                              throws java.lang.Exception

Parameters:

id - the project id

Returns:

the UUID of the project

Throws:

java.lang.Exception - on failure to retrieve project UUID

getNewResourceId

public long getNewResourceId()
                      throws GatewayException

Throws:

GatewayException

canEditProtectedResources

public boolean canEditProtectedResources(long projectId)
                                  throws GatewayException

Throws:

GatewayException

requestResourceLock

public ResourceLockRequestResponse requestResourceLock(long projectId,
                                                       long resourceId,
                                                       long editCount)
                                                throws GatewayException

Throws:

GatewayException

checkLockNotAvailable

public ResourceLockRequestResponse checkLockNotAvailable(long resourceId)
                                                  throws GatewayException

Throws:

GatewayException

releaseResourceLock

public void releaseResourceLock(long resourceId)
                         throws GatewayException

Throws:

GatewayException

getRoles

public java.lang.String[] getRoles(java.awt.Component owner)
                            throws GatewayException

Throws:

GatewayException

getZones

public java.lang.String[] getZones(java.awt.Component owner)
                            throws GatewayException

Throws:

GatewayException