Package com.inductiveautomation.ignition.client.gateway_interface

Interface GatewayConnection

    • Method Detail

      • connect

        void connect​(java.util.List<HttpURL> gatewayURLs)
        Connect to the gateway(s) specified

      • disconnect

        void disconnect()

      • getGatewayAddress

        HttpURL getGatewayAddress()
        Returns the address of the gateway that is currently being communicated with.

      • getAllAddresses

        java.util.List<HttpURL> getAllAddresses()
        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.

      • getGatewayWebURL

        java.lang.String getGatewayWebURL()
        Returns the url to the web portion of the gateway, like "http[s]://<address>:<port>[/context]"

      • getScheme

        java.lang.String getScheme()
        Returns "http" or "https" depending on our transport scheme

      • getGatewayNodeRole

        java.lang.String getGatewayNodeRole()
        Returns the string version of the currently connected gateway's "Node Role", which will be one of:
        • Independent
        • Master
        • Backup

      • getGatewayTimeZone

        java.util.TimeZone getGatewayTimeZone()

      • logout

        void logout()

      • getConnectionMode

        int getConnectionMode()
        Returns the current connection mode:
        • MODE_FULL
        • MODE_READ_ONLY
        • MODE_DISCONNECTED

      • setConnectionMode

        void setConnectionMode​(int connectionMode)

      • isConnected

        boolean isConnected()

      • isConnectionUp

        boolean isConnectionUp()

      • isSessionValid

        boolean isSessionValid()

      • removePushNotificationListeners

        void removePushNotificationListeners​(java.lang.Class<?> c)

      • addPropertyChangeListener

        void addPropertyChangeListener​(java.beans.PropertyChangeListener l)

      • removePropertyChangeListener

        void removePropertyChangeListener​(java.beans.PropertyChangeListener l)

      • addPropertyChangeListener

        void addPropertyChangeListener​(java.lang.String propName,
                               java.beans.PropertyChangeListener l)

      • removePropertyChangeListener

        void removePropertyChangeListener​(java.lang.String propName,
                                  java.beans.PropertyChangeListener l)

      • removeConnectionListener

        void removeConnectionListener​(ConnectionListener listener)

      • getProjectName

        java.lang.String getProjectName()
        The name of the project that we are currently logged into, if any.

      • getUsername

        java.lang.String getUsername()
        The username of the actively logged in user, if any.

      • getAuthChallenge

        AuthChallenge getAuthChallenge()
        The encrypted auth challenge that was used to log in

      • getRoles

        java.util.List<java.lang.String> getRoles()
        The set of roles that the actively logged in user has, if any.

      • getSecurityZones

        java.util.List<java.lang.String> getSecurityZones()
        The set of security zones that the actively logged in user has, if any.

      • getConnectTimeout

        int getConnectTimeout()

      • setConnectTimeout

        void setConnectTimeout​(int connectTimeout)

      • getSocketTimeout

        int getSocketTimeout()

      • setSocketTimeout

        void setSocketTimeout​(int socketTimeout)

      • getOpcBrowseTimeout

        int getOpcBrowseTimeout()

      • setOpcBrowseTimeout

        void setOpcBrowseTimeout​(int opcBrowseTimeout)

      • getHttpConcurrency

        int getHttpConcurrency()
        The number of concurrent HTTP connections allowed. 0 or less means unlimited.

      • setHttpConcurrency

        void setHttpConcurrency​(int concurrency)

      • addConnectionStatusListener

        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. The passed ConnectionStatusListener will be continually updated with master/independent and backup connection status every few seconds.

      • triggerConnectionStatusListeners

        void triggerConnectionStatusListeners()
        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).

      • getPlatformEdition

        java.lang.String getPlatformEdition()
        Platform edition. Standard edition = "", Edge edition = "edge"

      • getEdgeProjectName

        java.lang.String getEdgeProjectName()
                             throws GatewayException
        Returns:
        the name of the Edge project as defined by the user on the edge gateway settings
        Throws:
        GatewayException

      • isPlatformLicensed

        boolean isPlatformLicensed()