Package com.inductiveautomation.ignition.client.gateway_interface

Interface GatewayConnection

All Known Implementing Classes:
AbstractGatewayConnection, ClientGatewayConnection, DesignerGatewayConnection
public interface GatewayConnection

  • Method Details

    • connect

      void connect(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

      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.

    • getGatewayInterface

      GatewayInterface getGatewayInterface()

    • getGatewayWebURL

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

    • getScheme

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

    • getGatewayNodeRole

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

    • getGatewayTimeZone

      TimeZone getGatewayTimeZone()

    • login

      AuthenticatedUser login(String projectName, AuthChallenge challenge) throws GatewayException
      Throws:
      GatewayException

    • tokenLogin

      AuthenticatedUser tokenLogin(String projectName, String encodedAuthToken) throws GatewayException
      Throws:
      GatewayException

    • idpLoginStart

      @Nullable URI idpLoginStart(String projectName) throws GatewayException
      Throws:
      GatewayException

    • idpLoginFinish

      @Nullable AuthenticatedUser idpLoginFinish(String projectName) throws GatewayException
      Throws:
      GatewayException

    • 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()

    • addPushNotificationListener

      void addPushNotificationListener(PushNotificationListener listener)

    • removePushNotificationListener

      void removePushNotificationListener(PushNotificationListener listener)

    • removePushNotificationListeners

      void removePushNotificationListeners(Class<?> c)

    • addPropertyChangeListener

      void addPropertyChangeListener(PropertyChangeListener l)

    • removePropertyChangeListener

      void removePropertyChangeListener(PropertyChangeListener l)

    • addPropertyChangeListener

      void addPropertyChangeListener(String propName, PropertyChangeListener l)

    • removePropertyChangeListener

      void removePropertyChangeListener(String propName, PropertyChangeListener l)

    • addConnectionListener

      void addConnectionListener(ConnectionListener listener)

    • removeConnectionListener

      void removeConnectionListener(ConnectionListener listener)

    • getProjectName

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

    • getUsername

      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

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

    • getSecurityZones

      List<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.

    • removeConnectionStatusListener

      void removeConnectionStatusListener(ConnectionStatusListener listener)

    • 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

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

    • getEdgeProjectName

      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()