Package com.inductiveautomation.ignition.designer.gateway

Class DTGatewayInterface

java.lang.Object

com.inductiveautomation.ignition.designer.gateway.DTGatewayInterface

All Implemented Interfaces:

GatewayConstants

public class DTGatewayInterface
extends 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	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, CONNECT_TIMEOUT, 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_INSECURE_REDIRECT, ERRNO_INTERNAL, ERRNO_INVALIDARGS, ERRNO_INVOCATION_EXCEPTION, ERRNO_LICENE_RESTRICTED, ERRNO_LOGIN_CANCELLED, 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_PROJECT_PULL, ERRNO_PROJECT_PUSH, 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_DBTEST, MTYPE_GET_NEW_RESOURCEID, MTYPE_INVALID, MTYPE_INVOKE_FUNCTION, MTYPE_LIST_AUTHS, MTYPE_LIST_COLS, MTYPE_LIST_DBS, MTYPE_LIST_IDPS, MTYPE_LIST_IMAGES, MTYPE_LIST_MODULES, MTYPE_LIST_ROLES, MTYPE_LIST_SECURITY_LEVELS, MTYPE_LIST_SQLTAG_PROVIDERS, MTYPE_LIST_TABLES, MTYPE_LIST_ZONES, MTYPE_PING, MTYPE_PLATFORM_EDITION, MTYPE_PUBLIC_PING, MTYPE_REMOVE_IMAGE, MTYPE_RENAME_IMAGE_FOLDER, 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, OPC_BROWSE_TIMEOUT, PROTECT_DIALOG_TYPE, shortNull, SOCKET_TIMEOUT, WARNING_MESSAGE_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DTGatewayInterface()

Method Summary

Modifier and Type	Method	Description
void	copyImage(Component dlg, String dest, String[] paths)
void	createImageFolder(Component dlg, String name, String parent)
void	createProject(Component frame, String projectName, ProjectManifest manifest, List<ProjectResource> resources)
List<String>	getAuditProfiles(Component owner)
AuthenticationStrategy	getAuthenticationStrategy()
Map<String,Long>	getAuthProfiles(Component owner)
Dataset	getColumnList(Component owner, String datasource, String tablename)	Deprecated. Silently blocks the EDT with a modal dialog.
Dataset	getColumnList(String datasource, String tablename)	Returns a dataset where each row represents a column in the table.
Map<String,DTGatewayInterface.DatasourceInfo>	getDatasources(Component owner)
GlobalProps	getExistingGlobalProps(String projectName)
IdpAdapterMeta[]	getIdps(Component owner)
Dataset	getImageList(Component dlg, String folder)
static DTGatewayInterface	getInstance()
List<String>	getProjectList(Component dlg)
String[]	getRoles(Component owner)
com.google.common.collect.ImmutableCollection<SecurityLevelConfig>	getSecurityLevels(Component owner)
String[]	getTableList(Component owner, String datasource)	Deprecated. Prefer calling getTableList(String) in a SwingWorker for true async.
String[]	getTableList(String datasource)	Fetches the list of tables in datasource
List<String>	getTagProviders(Component owner)
Map<String,ProjectManifest>	getValidProjectManifests()
String[]	getZones(Component owner)
RuntimeProject	loadProject(String projectName)	Note - loads synchronously
void	removeImage(Component dlg, String[] paths)
void	renameImageFolder(Component dlg, String from, String dest)
Dataset	runQuery(Component frame, String query, String dsn)
Dataset	runQuery(Component frame, String query, String dsn, int limit)
String	saveProjectAs(Component frame, String newName, ProjectManifest manifest, List<ProjectResource> resources)
void	uploadImage(Component dlg, String name, String desc, String type, 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 Details

DTGatewayInterface

protected DTGatewayInterface()

Method Details

getInstance

public static DTGatewayInterface getInstance()

getDatasources

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

Throws:

GatewayException

getTagProviders

public List<String> getTagProviders(Component owner)
                             throws GatewayException

Throws:

GatewayException

getAuthProfiles

public Map<String,Long> getAuthProfiles(Component owner)
                                 throws GatewayException

Throws:

GatewayException

getIdps

public IdpAdapterMeta[] getIdps(Component owner)
                         throws GatewayException

Throws:

GatewayException

getSecurityLevels

public com.google.common.collect.ImmutableCollection<SecurityLevelConfig> getSecurityLevels(Component owner)
                                                                                     throws GatewayException

Throws:

GatewayException

getAuthenticationStrategy

public AuthenticationStrategy getAuthenticationStrategy()
                                                 throws GatewayException

Throws:

GatewayException

getAuditProfiles

public List<String> getAuditProfiles(Component owner)
                              throws GatewayException

Throws:

GatewayException

getTableList

@Deprecated(since="8.1.27")
public String[] getTableList(Component owner,
 String datasource)
                      throws GatewayException

Deprecated.

Prefer calling getTableList(String) in a SwingWorker for true async.

Fetches the list of tables in datasource

Parameters:

owner - The component invoking this action; used as the basis for the automatic UI that will be displayed if this task takes longer than 3 seconds.

Returns:

A sorted array of table names in the specified datasource.

Throws:

GatewayException - If there's any issue communicating with the gateway

getTableList

public String[] getTableList(String datasource)
                      throws GatewayException

Fetches the list of tables in datasource

Returns:

A sorted array of table names in the specified datasource.

Throws:

GatewayException - If there's any issue communicating with the gateway

getColumnList

@Deprecated(since="8.1.27")
public Dataset getColumnList(Component owner,
 String datasource,
 String tablename)
                      throws GatewayException

Deprecated.

Silently blocks the EDT with a modal dialog. Prefer calling getColumnList(String, String) from a SwingWorker.

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

getColumnList

public Dataset getColumnList(String datasource,
 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(Component frame,
 String query,
 String dsn)
                 throws GatewayException

Throws:

GatewayException

runQuery

public Dataset runQuery(Component frame,
 String query,
 String dsn,
 int limit)
                 throws GatewayException

Throws:

GatewayException

getProjectList

public List<String> getProjectList(Component dlg)
                            throws GatewayException

Throws:

GatewayException

getValidProjectManifests

public Map<String,ProjectManifest> getValidProjectManifests()
                                                     throws GatewayException

Throws:

GatewayException

createImageFolder

public void createImageFolder(Component dlg,
 String name,
 String parent)
                       throws GatewayException

Throws:

GatewayException

removeImage

public void removeImage(Component dlg,
 String[] paths)
                 throws GatewayException

Throws:

GatewayException

copyImage

public void copyImage(Component dlg,
 String dest,
 String[] paths)
               throws GatewayException

Throws:

GatewayException

renameImageFolder

public void renameImageFolder(Component dlg,
 String from,
 String dest)
                       throws GatewayException

Throws:

GatewayException

uploadImage

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

Throws:

GatewayException

getImageList

public Dataset getImageList(Component dlg,
 String folder)
                     throws GatewayException

Throws:

GatewayException

saveProjectAs

public String saveProjectAs(Component frame,
 String newName,
 ProjectManifest manifest,
 List<ProjectResource> resources)
                     throws GatewayException

Throws:

GatewayException

createProject

public void createProject(Component frame,
 String projectName,
 ProjectManifest manifest,
 List<ProjectResource> resources)
                   throws GatewayException

Throws:

GatewayException

loadProject

public RuntimeProject loadProject(String projectName)
                           throws Exception

Note - loads synchronously

Parameters:

projectName - the project name

Throws:

Exception - on failure to load project

getExistingGlobalProps

@Nullable
public GlobalProps getExistingGlobalProps(String projectName)
                                   throws Exception

Throws:

Exception

getRoles

public String[] getRoles(Component owner)
                  throws GatewayException

Throws:

GatewayException

getZones

public String[] getZones(Component owner)
                  throws GatewayException

Throws:

GatewayException