java.lang.Object
- com.inductiveautomation.ignition.client.gateway_interface.AbstractGatewayConnection

All Implemented Interfaces:

GatewayConnection, GatewayInterface.GatewayExceptionMonitor, PushNotificationListener, GatewayConstants, java.util.EventListener

Direct Known Subclasses:

ClientGatewayConnection, DesignerGatewayConnection
```
public abstract class AbstractGatewayConnection
extends java.lang.Object
implements GatewayConstants, GatewayConnection, PushNotificationListener, GatewayInterface.GatewayExceptionMonitor
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

protected static class AbstractGatewayConnection.UnrecoverableIdpAuthSessionException

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.beans.PropertyChangeSupport`	`changeSupport`
`static java.lang.String`	`CONNECT_FAIL`
`static java.lang.String`	`CONNECT_SUCCESS`
`static java.lang.String`	`CONNECT_UNKNOWN`
`static java.lang.String`	`CONNECTING`
`protected int`	`connectTimeout`
`protected HttpURL`	`currentAddress`	The current address that we are communicating with
`protected java.util.List<HttpURL>`	`gatewayAddresses`	A list of all gateway addresses that were passed in.
`protected java.lang.String`	`gatewayNodeRole`
`protected java.util.TimeZone`	`gatewayTimeZone`
`static java.lang.String`	`GET_ADDRESSES_ERROR`
`protected ScopeVersionHash`	`hash`
`protected int`	`httpConcurrency`
`static java.lang.String`	`INDEPENDENT`
`protected LaunchContext`	`launchContext`
`protected javax.swing.event.EventListenerList`	`listenerList`
`protected static org.apache.log4j.Logger`	`log`
`static java.util.Map<java.lang.Integer,java.lang.String>`	`LOGGER_STATUS_LOOKUP`	Used for internal logging ONLY.
`static java.lang.String`	`NEW_ADDRESSES`
`static java.lang.String`	`NO_NEW_ADDRESSES`
`static java.lang.String`	`NON_ACTIVE`
`protected int`	`opcBrowseTimeout`
`static java.lang.String`	`REDUNDANT_BACKUP`
`static java.lang.String`	`REDUNDANT_MASTER`
`static java.lang.String`	`RELOGIN`
`protected int`	`socketTimeout`
`static int`	`STATUS_CONNECT_FAIL`
`static int`	`STATUS_CONNECT_INACTIVE`
`static int`	`STATUS_CONNECT_UNKNOWN`
`static int`	`STATUS_CONNECT_WARNING`
`static int`	`STATUS_CONNECTED`
`static int`	`STATUS_CONNECTED_INCOMPATIBLE`
`static int`	`STATUS_CONNECTING`

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_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, PROTECT_DIALOG_TYPE, shortNull, WARNING_MESSAGE_TYPE

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractGatewayConnection(LaunchContext launchContext)

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addConnectionListener(ConnectionListener listener)`
`void`	`addConnectionStatusListener(ConnectionStatusListener listener)`	Different from the ConnectionListener in the sense that this listener is intended for use in redundant setups, where the status of the inactive connection must be updated along with the status of the active connection.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener l)`
`void`	`addPropertyChangeListener(java.lang.String propName, java.beans.PropertyChangeListener l)`
`void`	`addPushNotificationListener(PushNotificationListener listener)`
`void`	`connect(java.util.List<HttpURL> gatewayURLs)`	Connect to the gateway(s) specified
`void`	`disconnect()`
`protected abstract AuthenticatedUser`	`doIdpLoginFinish(java.lang.String projectName)`
`protected abstract AuthenticatedUser`	`doLogin(GatewayInterface gatewayInterface, java.lang.String projectName, AuthChallenge challenge)`
`protected void`	`fireConnectionEvent(java.lang.String message)`
`protected void`	`fireConnectionEvent(java.lang.String messageLookup, HttpURL gatewayAddr, boolean appendGatewayAddr)`	Overloaded method to allow a gateway's connection status to be updated.
`protected void`	`fireConnectionEvent(java.lang.String messageLookup, HttpURL gatewayAddr, java.lang.Exception ex, boolean appendGatewayAddr)`	Overloaded method to allow a gateway's connection status to be updated.
`protected void`	`firePushNotification(PushNotification n)`
`protected void`	`fishForAliveServer(boolean reLogin)`	Synchronized method- Tests communication with known servers, and sets the gateway interface to the first gateway that in can connect to.
`java.util.List<HttpURL>`	`getAllAddresses()`	Returns a list of all possible Gateway addresses that are known to the client.
`AuthChallenge`	`getAuthChallenge()`	The encrypted auth challenge that was used to log in
`int`	`getConnectionMode()`	Returns the current connection mode: MODE_FULL MODE_READ_ONLY MODE_DISCONNECTED
`int`	`getConnectTimeout()`
`java.lang.String`	`getEdgeProjectName()`
`HttpURL`	`getGatewayAddress()`	Returns the address of the gateway that is currently being communicated with.
`GatewayInterface`	`getGatewayInterface()`
`java.lang.String`	`getGatewayNodeRole()`	Returns the string version of the currently connected gateway's "Node Role", which will be one of: Independent Master Backup
`java.util.TimeZone`	`getGatewayTimeZone()`
`java.lang.String`	`getGatewayWebURL()`	Returns the url to the web portion of the gateway, like "http[s]://<address>:<port>[/context]"
`int`	`getHttpConcurrency()`	The number of concurrent HTTP connections allowed.
`int`	`getOpcBrowseTimeout()`
`java.lang.String`	`getPlatformEdition()`	Platform edition.
`java.lang.String`	`getProjectName()`	The name of the project that we are currently logged into, if any.
`java.util.List<java.lang.String>`	`getRoles()`	The set of roles that the actively logged in user has, if any.
`java.lang.String`	`getScheme()`	Returns "http" or "https" depending on our transport scheme
`protected abstract int`	`getScope()`	Returns the scope for this connection.
`java.util.List<java.lang.String>`	`getSecurityZones()`	The set of security zones that the actively logged in user has, if any.
`int`	`getSocketTimeout()`
`java.lang.String`	`getUsername()`	The username of the actively logged in user, if any.
`AuthenticatedUser`	`idpLoginFinish(java.lang.String projectName)`
`boolean`	`isConnected()`	Whether or not we are currently supposed to be in a connected state.
`static boolean`	`isConnectionRelated(java.lang.Exception ex)`
`boolean`	`isConnectionUp()`
`boolean`	`isLoggedIn()`
`boolean`	`isPlatformLicensed()`
`boolean`	`isSessionValid()`
`AuthenticatedUser`	`login(java.lang.String projectName, AuthChallenge challenge)`
`void`	`logout()`
`protected GatewayInterface`	`newGatewayInterface(HttpURL addr)`	Creates a new GatewayInterface for the given URL, settings its connect and socket timeouts appropriately
`void`	`notifyGatewayException(GatewayException ex)`
`protected abstract void`	`onUnrecoverableIdpAuthSession()`
`protected abstract void`	`onVersionMismatch()`	Called when the version is detected to have changed on the gateway.
`void`	`receiveNotification(PushNotification notification)`
`void`	`removeConnectionListener(ConnectionListener listener)`
`void`	`removeConnectionStatusListener(ConnectionStatusListener listener)`
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener l)`
`void`	`removePropertyChangeListener(java.lang.String propName, java.beans.PropertyChangeListener l)`
`void`	`removePushNotificationListener(PushNotificationListener listener)`
`void`	`removePushNotificationListeners(java.lang.Class<?> c)`	Removes all PushNotificationListeners that are of same class as the passed class.
`protected void`	`setConnected(boolean connected)`
`void`	`setConnectionMode(int connectionMode)`
`protected void`	`setConnectionUp(boolean connectionUp)`	Synchronized method
`void`	`setConnectTimeout(int connectTimeout)`
`protected void`	`setGatewayInterface(GatewayInterface gi)`	Sets the new gateway interface, and adds this as a gateway exception listener and a push notification listener.
`void`	`setHttpConcurrency(int concurrency)`
`protected void`	`setIndependentAddressList(java.util.List<HttpURL> addresses, boolean reLogin)`
`void`	`setOpcBrowseTimeout(int opcBrowseTimeout)`
`protected void`	`setProjectName(java.lang.String projectName)`
`void`	`setSocketTimeout(int socketTimeout)`
`protected java.lang.String`	`toString(HttpURL url)`	Returns the HttpURL with the correct security scheme, like: "`https://myserver:443/ContextPath`"
`void`	`triggerConnectionStatusListeners()`	Manually update the status of all connection listeners.
`protected boolean`	`tryToLogin()`
`void`	`updateBackupAddresses(java.util.List<HttpURL> list)`	Synchronized method
`void`	`updateGatewayMetaInfo()`	Updates the gateway timezone and role info
`void`	`updateMasterAddresses(java.util.List<HttpURL> list)`	Synchronized method

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.client.gateway_interface.GatewayConnection
idpLoginStart

- Field Detail
  - REDUNDANT_MASTER
```
public static final java.lang.String REDUNDANT_MASTER
```
  - REDUNDANT_BACKUP
```
public static final java.lang.String REDUNDANT_BACKUP
```
  - INDEPENDENT
```
public static final java.lang.String INDEPENDENT
```
    See Also:
    
    Constant Field Values
  - CONNECT_UNKNOWN
```
public static final java.lang.String CONNECT_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - CONNECTING
```
public static final java.lang.String CONNECTING
```
    See Also:
    
    Constant Field Values
  - CONNECT_SUCCESS
```
public static final java.lang.String CONNECT_SUCCESS
```
    See Also:
    
    Constant Field Values
  - CONNECT_FAIL
```
public static final java.lang.String CONNECT_FAIL
```
    See Also:
    
    Constant Field Values
  - RELOGIN
```
public static final java.lang.String RELOGIN
```
    See Also:
    
    Constant Field Values
  - NON_ACTIVE
```
public static final java.lang.String NON_ACTIVE
```
    See Also:
    
    Constant Field Values
  - NEW_ADDRESSES
```
public static final java.lang.String NEW_ADDRESSES
```
    See Also:
    
    Constant Field Values
  - NO_NEW_ADDRESSES
```
public static final java.lang.String NO_NEW_ADDRESSES
```
    See Also:
    
    Constant Field Values
  - GET_ADDRESSES_ERROR
```
public static final java.lang.String GET_ADDRESSES_ERROR
```
    See Also:
    
    Constant Field Values
  - STATUS_CONNECT_UNKNOWN
```
public static final int STATUS_CONNECT_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - STATUS_CONNECTING
```
public static final int STATUS_CONNECTING
```
    See Also:
    
    Constant Field Values
  - STATUS_CONNECTED
```
public static final int STATUS_CONNECTED
```
    See Also:
    
    Constant Field Values
  - STATUS_CONNECT_FAIL
```
public static final int STATUS_CONNECT_FAIL
```
    See Also:
    
    Constant Field Values
  - STATUS_CONNECT_INACTIVE
```
public static final int STATUS_CONNECT_INACTIVE
```
    See Also:
    
    Constant Field Values
  - STATUS_CONNECTED_INCOMPATIBLE
```
public static final int STATUS_CONNECTED_INCOMPATIBLE
```
    See Also:
    
    Constant Field Values
  - STATUS_CONNECT_WARNING
```
public static final int STATUS_CONNECT_WARNING
```
    See Also:
    
    Constant Field Values
  - log
```
protected static final org.apache.log4j.Logger log
```
  - LOGGER_STATUS_LOOKUP
```
public static final java.util.Map<java.lang.Integer,java.lang.String> LOGGER_STATUS_LOOKUP
```
    Used for internal logging ONLY. Do not use to display messages to the user, as these strings are not internationalized.
  - connectTimeout
```
protected int connectTimeout
```
  - socketTimeout
```
protected int socketTimeout
```
  - opcBrowseTimeout
```
protected int opcBrowseTimeout
```
  - httpConcurrency
```
protected int httpConcurrency
```
  - changeSupport
```
protected java.beans.PropertyChangeSupport changeSupport
```
  - listenerList
```
protected javax.swing.event.EventListenerList listenerList
```
  - currentAddress
```
protected HttpURL currentAddress
```
    The current address that we are communicating with
  - gatewayAddresses
```
protected java.util.List<HttpURL> gatewayAddresses
```
    A list of all gateway addresses that were passed in. The client starts in independent mode and cycles thru these addresses in the fishForAliveServer() method. The addresses are used later if a version mismatch exception is thrown when reconnecting to a gateway. Redundant master and backup addresses are not maintained in this list. They are held in the potentialMasterList and potentialBackup list respectively.
  - launchContext
```
protected LaunchContext launchContext
```
  - gatewayTimeZone
```
protected java.util.TimeZone gatewayTimeZone
```
  - gatewayNodeRole
```
protected java.lang.String gatewayNodeRole
```
  - hash
```
protected ScopeVersionHash hash
```
- Constructor Detail
  - AbstractGatewayConnection
```
protected AbstractGatewayConnection(LaunchContext launchContext)
```
- Method Detail
  - connect
```
public void connect(java.util.List<HttpURL> gatewayURLs)
```
    Description copied from interface: GatewayConnection
    
    Connect to the gateway(s) specified
    
    Specified by:
    
    connect in interface GatewayConnection
  - disconnect
```
public void disconnect()
```
    Specified by:
    
    disconnect in interface GatewayConnection
  - setIndependentAddressList
```
protected void setIndependentAddressList(java.util.List<HttpURL> addresses,
                                         boolean reLogin)
                                  throws AbstractGatewayConnection.UnrecoverableIdpAuthSessionException,
                                         VersionMismatchException
```
    Throws:
    
    AbstractGatewayConnection.UnrecoverableIdpAuthSessionException
    
    VersionMismatchException
  - newGatewayInterface
```
protected GatewayInterface newGatewayInterface(HttpURL addr)
```
    Creates a new GatewayInterface for the given URL, settings its connect and socket timeouts appropriately
  - getScope
```
protected abstract int getScope()
```
    Returns the scope for this connection. Used to create an accurate version hash.
  - updateMasterAddresses
```
public void updateMasterAddresses(java.util.List<HttpURL> list)
```
    Synchronized method
  - updateBackupAddresses
```
public void updateBackupAddresses(java.util.List<HttpURL> list)
```
    Synchronized method
  - fishForAliveServer
```
protected void fishForAliveServer(boolean reLogin)
                           throws AbstractGatewayConnection.UnrecoverableIdpAuthSessionException,
                                  VersionMismatchException
```
    Synchronized method- Tests communication with known servers, and sets the gateway interface to the first gateway that in can connect to. For redundant connections, this method also sets the gateway interface to either the last known master or the last known backup in a connection failure scenario. The connection status of the master and the backup is determined in a separate thread in the RedundancyMonitorTask.
    
    Throws:
    
    AbstractGatewayConnection.UnrecoverableIdpAuthSessionException
    
    VersionMismatchException
  - tryToLogin
```
protected boolean tryToLogin()
                      throws AbstractGatewayConnection.UnrecoverableIdpAuthSessionException
```
    Throws:
    
    AbstractGatewayConnection.UnrecoverableIdpAuthSessionException
  - setGatewayInterface
```
protected void setGatewayInterface(GatewayInterface gi)
```
    Sets the new gateway interface, and adds this as a gateway exception listener and a push notification listener. Also updates the gateway timezone.
  - updateGatewayMetaInfo
```
public void updateGatewayMetaInfo()
```
    Updates the gateway timezone and role info
  - getGatewayNodeRole
```
public java.lang.String getGatewayNodeRole()
```
    Description copied from interface: GatewayConnection
    Returns the string version of the currently connected gateway's "Node Role", which will be one of:
    
    Independent
    
    Master
    
    Backup
    Specified by:
    
    getGatewayNodeRole in interface GatewayConnection
  - doLogin
```
protected abstract AuthenticatedUser doLogin(GatewayInterface gatewayInterface,
                                             java.lang.String projectName,
                                             AuthChallenge challenge)
                                      throws GatewayException
```
    Throws:
    
    GatewayException
  - login
```
public AuthenticatedUser login(java.lang.String projectName,
                               AuthChallenge challenge)
                        throws GatewayException
```
    Specified by:
    
    login in interface GatewayConnection
    
    Throws:
    
    GatewayException
  - doIdpLoginFinish
```
protected abstract AuthenticatedUser doIdpLoginFinish(java.lang.String projectName)
                                               throws GatewayException
```
    Throws:
    
    GatewayException
  - idpLoginFinish
```
@Nullable
public AuthenticatedUser idpLoginFinish(java.lang.String projectName)
                                 throws GatewayException
```
    Specified by:
    
    idpLoginFinish in interface GatewayConnection
    
    Throws:
    
    GatewayException
  - logout
```
public void logout()
```
    Specified by:
    
    logout in interface GatewayConnection
  - setConnectionUp
```
protected void setConnectionUp(boolean connectionUp)
```
    Synchronized method
  - onVersionMismatch
```
protected abstract void onVersionMismatch()
```
    Called when the version is detected to have changed on the gateway. Connection will be closed at this point.
  - onUnrecoverableIdpAuthSession
```
protected abstract void onUnrecoverableIdpAuthSession()
```
  - notifyGatewayException
```
public void notifyGatewayException(GatewayException ex)
```
    Specified by:
    
    notifyGatewayException in interface GatewayInterface.GatewayExceptionMonitor
  - receiveNotification
```
public void receiveNotification(PushNotification notification)
```
    Specified by:
    
    receiveNotification in interface PushNotificationListener
  - isConnectionRelated
```
public static boolean isConnectionRelated(java.lang.Exception ex)
```
  - getConnectionMode
```
public int getConnectionMode()
```
    Description copied from interface: GatewayConnection
    Returns the current connection mode:
    
    MODE_FULL
    
    MODE_READ_ONLY
    
    MODE_DISCONNECTED
    Specified by:
    
    getConnectionMode in interface GatewayConnection
  - setConnectionMode
```
public void setConnectionMode(int connectionMode)
```
    Specified by:
    
    setConnectionMode in interface GatewayConnection
  - getAllAddresses
```
public java.util.List<HttpURL> getAllAddresses()
```
    Description copied from interface: GatewayConnection
    
    Returns a list of all possible Gateway addresses that are known to the client. This list includes redundant master and backup addresses. The list is used for client restarts.
    
    Specified by:
    
    getAllAddresses in interface GatewayConnection
  - getGatewayAddress
```
public HttpURL getGatewayAddress()
```
    Description copied from interface: GatewayConnection
    
    Returns the address of the gateway that is currently being communicated with.
    
    Specified by:
    
    getGatewayAddress in interface GatewayConnection
  - getGatewayInterface
```
public GatewayInterface getGatewayInterface()
```
    Specified by:
    
    getGatewayInterface in interface GatewayConnection
  - getGatewayWebURL
```
public java.lang.String getGatewayWebURL()
```
    Description copied from interface: GatewayConnection
    
    Returns the url to the web portion of the gateway, like "http[s]://<address>:<port>[/context]"
    
    Specified by:
    
    getGatewayWebURL in interface GatewayConnection
  - getScheme
```
public java.lang.String getScheme()
```
    Description copied from interface: GatewayConnection
    
    Returns "http" or "https" depending on our transport scheme
    
    Specified by:
    
    getScheme in interface GatewayConnection
  - getGatewayTimeZone
```
public java.util.TimeZone getGatewayTimeZone()
```
    Specified by:
    
    getGatewayTimeZone in interface GatewayConnection
  - isConnectionUp
```
public boolean isConnectionUp()
```
    Specified by:
    
    isConnectionUp in interface GatewayConnection
  - isSessionValid
```
public boolean isSessionValid()
```
    Specified by:
    
    isSessionValid in interface GatewayConnection
  - isConnected
```
public boolean isConnected()
```
    Whether or not we are currently supposed to be in a connected state. If this is true and connectionUp is false, then we are reconnecting
    
    Specified by:
    
    isConnected in interface GatewayConnection
  - setConnected
```
protected void setConnected(boolean connected)
```
  - toString
```
protected java.lang.String toString(HttpURL url)
```
    Returns the HttpURL with the correct security scheme, like: "https://myserver:443/ContextPath"
  - addPushNotificationListener
```
public void addPushNotificationListener(PushNotificationListener listener)
```
    Specified by:
    
    addPushNotificationListener in interface GatewayConnection
  - removePushNotificationListener
```
public void removePushNotificationListener(PushNotificationListener listener)
```
    Specified by:
    
    removePushNotificationListener in interface GatewayConnection
  - removePushNotificationListeners
```
public void removePushNotificationListeners(java.lang.Class<?> c)
```
    Removes all PushNotificationListeners that are of same class as the passed class.
    
    Specified by:
    
    removePushNotificationListeners in interface GatewayConnection
    
    Parameters:
    
    c - The type of listener to remove
  - firePushNotification
```
protected void firePushNotification(PushNotification n)
```
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
```
    Specified by:
    
    addPropertyChangeListener in interface GatewayConnection
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
```
    Specified by:
    
    removePropertyChangeListener in interface GatewayConnection
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.lang.String propName,
                                      java.beans.PropertyChangeListener l)
```
    Specified by:
    
    addPropertyChangeListener in interface GatewayConnection
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.lang.String propName,
                                         java.beans.PropertyChangeListener l)
```
    Specified by:
    
    removePropertyChangeListener in interface GatewayConnection
  - addConnectionListener
```
public void addConnectionListener(ConnectionListener listener)
```
    Specified by:
    
    addConnectionListener in interface GatewayConnection
  - removeConnectionListener
```
public void removeConnectionListener(ConnectionListener listener)
```
    Specified by:
    
    removeConnectionListener in interface GatewayConnection
  - fireConnectionEvent
```
protected void fireConnectionEvent(java.lang.String messageLookup,
                                   HttpURL gatewayAddr,
                                   boolean appendGatewayAddr)
```
    Overloaded method to allow a gateway's connection status to be updated. A BundleUtil lookup is made to get the actual string from the passed lookup. Be sure that the actual string returned from lookup contains at least one '%s' to display the gateway address. This method will also update the internal masterConnectionStatus and backupConnectionStatus variables for redundant systems, and the connectionStatus variable for independent systems.
  - fireConnectionEvent
```
protected void fireConnectionEvent(java.lang.String messageLookup,
                                   HttpURL gatewayAddr,
                                   java.lang.Exception ex,
                                   boolean appendGatewayAddr)
```
    Overloaded method to allow a gateway's connection status to be updated. A BundleUtil lookup is made to get the actual string from the passed lookup. Be sure that the actual string returned from lookup contains at least one '%s' to display the gateway address. This method will also update the internal masterConnectionStatus and backupConnectionStatus variables for redundant systems, and the connectionStatus variable for independent systems.
    
    Parameters:
    
    messageLookup - the String to pass to BundleUtil.get(), such as "GatewayConnectionManager.TestingWith"
    
    gatewayAddr - the Gateway HttpURL used in the connection event
    
    ex - exception that has just occurred. Pass in null if there were no exceptions thrown.
  - fireConnectionEvent
```
protected void fireConnectionEvent(java.lang.String message)
```
  - isLoggedIn
```
public boolean isLoggedIn()
```
  - getProjectName
```
public java.lang.String getProjectName()
```
    Description copied from interface: GatewayConnection
    
    The name of the project that we are currently logged into, if any.
    
    Specified by:
    
    getProjectName in interface GatewayConnection
  - getUsername
```
public java.lang.String getUsername()
```
    Description copied from interface: GatewayConnection
    
    The username of the actively logged in user, if any.
    
    Specified by:
    
    getUsername in interface GatewayConnection
  - getAuthChallenge
```
public AuthChallenge getAuthChallenge()
```
    Description copied from interface: GatewayConnection
    
    The encrypted auth challenge that was used to log in
    
    Specified by:
    
    getAuthChallenge in interface GatewayConnection
  - getRoles
```
public java.util.List<java.lang.String> getRoles()
```
    Description copied from interface: GatewayConnection
    
    The set of roles that the actively logged in user has, if any.
    
    Specified by:
    
    getRoles in interface GatewayConnection
  - getSecurityZones
```
public java.util.List<java.lang.String> getSecurityZones()
```
    Description copied from interface: GatewayConnection
    
    The set of security zones that the actively logged in user has, if any.
    
    Specified by:
    
    getSecurityZones in interface GatewayConnection
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Specified by:
    
    getConnectTimeout in interface GatewayConnection
  - setConnectTimeout
```
public void setConnectTimeout(int connectTimeout)
```
    Specified by:
    
    setConnectTimeout in interface GatewayConnection
  - getSocketTimeout
```
public int getSocketTimeout()
```
    Specified by:
    
    getSocketTimeout in interface GatewayConnection
  - setSocketTimeout
```
public void setSocketTimeout(int socketTimeout)
```
    Specified by:
    
    setSocketTimeout in interface GatewayConnection
  - getOpcBrowseTimeout
```
public int getOpcBrowseTimeout()
```
    Specified by:
    
    getOpcBrowseTimeout in interface GatewayConnection
  - setOpcBrowseTimeout
```
public void setOpcBrowseTimeout(int opcBrowseTimeout)
```
    Specified by:
    
    setOpcBrowseTimeout in interface GatewayConnection
  - getHttpConcurrency
```
public int getHttpConcurrency()
```
    Description copied from interface: GatewayConnection
    
    The number of concurrent HTTP connections allowed. 0 or less means unlimited.
    
    Specified by:
    
    getHttpConcurrency in interface GatewayConnection
  - setHttpConcurrency
```
public void setHttpConcurrency(int concurrency)
```
    Specified by:
    
    setHttpConcurrency in interface GatewayConnection
  - setProjectName
```
protected void setProjectName(java.lang.String projectName)
```
  - addConnectionStatusListener
```
public void addConnectionStatusListener(ConnectionStatusListener listener)
```
    Description copied from interface: GatewayConnection
    
    Different from the ConnectionListener in the sense that this listener is intended for use in redundant setups, where the status of the inactive connection must be updated along with the status of the active connection. The passed ConnectionStatusListener will be continually updated with master/independent and backup connection status every few seconds.
    
    Specified by:
    
    addConnectionStatusListener in interface GatewayConnection
  - removeConnectionStatusListener
```
public void removeConnectionStatusListener(ConnectionStatusListener listener)
```
    Specified by:
    
    removeConnectionStatusListener in interface GatewayConnection
  - triggerConnectionStatusListeners
```
public void triggerConnectionStatusListeners()
```
    Description copied from interface: GatewayConnection
    
    Manually update the status of all connection listeners. Use this in situations where listeners need an immediate update without waiting for the normal thread task to fire (such as when first displaying a status panel).
    
    Specified by:
    
    triggerConnectionStatusListeners in interface GatewayConnection
  - getPlatformEdition
```
public java.lang.String getPlatformEdition()
```
    Description copied from interface: GatewayConnection
    
    Platform edition. Standard edition = "", Edge edition = "edge"
    
    Specified by:
    
    getPlatformEdition in interface GatewayConnection
  - getEdgeProjectName
```
public java.lang.String getEdgeProjectName()
                                    throws GatewayException
```
    Specified by:
    
    getEdgeProjectName in interface GatewayConnection
    
    Returns:
    
    the name of the Edge project as defined by the user on the edge gateway settings
    
    Throws:
    
    GatewayException
  - isPlatformLicensed
```
public boolean isPlatformLicensed()
```
    Specified by:
    
    isPlatformLicensed in interface GatewayConnection

Class AbstractGatewayConnection

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.inductiveautomation.ignition.client.gateway_interface.GatewayConnection

Field Detail

REDUNDANT_MASTER

REDUNDANT_BACKUP

INDEPENDENT

CONNECT_UNKNOWN

CONNECTING

CONNECT_SUCCESS

CONNECT_FAIL

RELOGIN

NON_ACTIVE

NEW_ADDRESSES

NO_NEW_ADDRESSES

GET_ADDRESSES_ERROR

STATUS_CONNECT_UNKNOWN

STATUS_CONNECTING

STATUS_CONNECTED

STATUS_CONNECT_FAIL

STATUS_CONNECT_INACTIVE

STATUS_CONNECTED_INCOMPATIBLE

STATUS_CONNECT_WARNING

log

LOGGER_STATUS_LOOKUP

connectTimeout

socketTimeout

opcBrowseTimeout

httpConcurrency

changeSupport

listenerList

currentAddress

gatewayAddresses

launchContext

gatewayTimeZone

gatewayNodeRole

hash

Constructor Detail

AbstractGatewayConnection

Method Detail

connect

disconnect

setIndependentAddressList

newGatewayInterface

getScope

updateMasterAddresses

updateBackupAddresses

fishForAliveServer

tryToLogin

setGatewayInterface

updateGatewayMetaInfo

getGatewayNodeRole

doLogin

login

doIdpLoginFinish

idpLoginFinish

logout

setConnectionUp

onVersionMismatch

onUnrecoverableIdpAuthSession

notifyGatewayException

receiveNotification

isConnectionRelated

getConnectionMode

setConnectionMode

getAllAddresses

getGatewayAddress

getGatewayInterface

getGatewayWebURL

getScheme

getGatewayTimeZone

isConnectionUp

isSessionValid

isConnected

setConnected