Package com.inductiveautomation.ignition.client.gateway_interface

Class AbstractGatewayConnection

java.lang.Object

com.inductiveautomation.ignition.client.gateway_interface.AbstractGatewayConnection

All Implemented Interfaces:

GatewayConnection, GatewayConstants

Direct Known Subclasses:

ClientGatewayConnection, DesignerGatewayConnection

public abstract class AbstractGatewayConnection
extends Object
implements GatewayConnection, GatewayConstants

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	AbstractGatewayConnection.LoginContext
final class	AbstractGatewayConnection.WebSocketEndpoint	The local endpoint of the WebSocket connection.

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.client.gateway_interface.GatewayConnection

GatewayConnection.Rpc

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.common.gateway.GatewayConstants

GatewayConstants.ClientAuthChallengeDeserializer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONNECT_FAIL
static final String	CONNECT_SUCCESS
static final String	CONNECTING
protected final GatewayConnectionContext	context	The GatewayConnectionContext containing the launch context, thread pools, WebSocket and HTTP clients.
static final String	INDEPENDENT
protected static final LoggerEx	LOG
static final Map<Integer,String>	LOGGER_STATUS_LOOKUP	Used for internal logging ONLY.
protected final ReentrantReadWriteLock	readWriteLock
static final String	REDUNDANT_BACKUP
static final String	REDUNDANT_MASTER
static final int	STATUS_CONNECT_FAIL
static final int	STATUS_CONNECT_INACTIVE
static final int	STATUS_CONNECT_UNKNOWN
static final int	STATUS_CONNECT_WARNING
static final int	STATUS_CONNECTED
static final int	STATUS_CONNECTED_INCOMPATIBLE
static final int	STATUS_CONNECTING

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

CONNECTED, CONNECTION_MODE, CONNECTION_UP, GATEWAY_ADDRESS, GATEWAY_NODE_ROLE, GATEWAY_TIME_ZONE, PROJECT_NAME, ROLES, SESSION_VALID, USERNAME, ZONES

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

BUILD_NUMBER, CONNECT_TIMEOUT, ERRNO_BROWSE_ERROR, ERRNO_COMM_ERROR, ERRNO_CONNECTION_MODE, ERRNO_DBCONNECTION_SQL, ERRNO_INTERNAL, ERRNO_INVALIDARGS, ERRNO_INVOCATION_EXCEPTION, ERRNO_LICENSE_RESTRICTED, ERRNO_LOGIN_CANCELLED, ERRNO_LOGIN_FAILED, ERRNO_LOGIN_FAILED_LICENSING, ERRNO_NO_SESSION, ERRNO_NON_ACTIVE_NODE, ERRNO_NON_MASTER_NODE, ERRNO_NOT_AUTHORIZED, ERRNO_OK, ERRNO_PARSE, ERRNO_PASSWORD_EXPIRED, ERRNO_SQL, ERRNO_TRIAL_EXPIRED, ERRNO_VERSION_INCOMPATIBILITY, ERROR_MESSAGE_TYPE, FUNCTION_NAME, GSON, LOCALE_LIST, MODE_DISCONNECTED, MODE_FULL, MODE_READ_ONLY, MODULE_ID, MTYPE_PUBLIC_PING, OPC_BROWSE_TIMEOUT, PACKAGE_ID, PROJECT_NAME, REMOTE_HOST, SCOPE_HEADER, SESSION_ID_HEADER, SOCKET_TIMEOUT, TIMEZONE_ID, WARNING_MESSAGE_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractGatewayConnection(GatewayConnectionContext context)

Method Summary

Modifier and Type	Method	Description
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(PropertyChangeListener l)
void	addPropertyChangeListener(String propName, PropertyChangeListener l)
<T> void	addPushNotificationListener(PushNotificationListener<T> listener, PushNotificationDeserializer<T> deserializer)	Adds a handler for push notifications.
protected void	addPushNotificationListeners()
protected abstract LoginResult	authChallengeLogin(GatewayInterface gatewayInterface, AuthChallenge challenge, String projectName)
AuthenticatedUser	authChallengeLogin(String projectName, AuthChallenge challenge)
void	connect(List<HttpURL> gatewayURLs)	Connect to the gateway(s) specified
void	disconnect()
protected CompletableFuture<Void>	firePushNotification(WebsocketProtoMessage.PushNotification n)	Fire a collection of push notifications to all listeners.
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
int	getConnectTimeout()
String	getEdgeProjectName()
HttpURL	getGatewayAddress()	Returns the address of the gateway that is currently being communicated with.
GatewayInterface	getGatewayInterface()
String	getGatewayNodeRole()	Returns the string version of the currently connected gateway's "Node Role", which will be one of: Independent Master Backup
TimeZone	getGatewayTimeZone()
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()
String	getProjectName()	The name of the project that we are currently logged into, if any.
protected abstract Optional<String>	getProjectNameInternal()	Get the project name bound to this connection.
List<String>	getRoles()	The set of roles that the actively logged in user has, if any.
String	getScheme()	Returns "http" or "https" depending on our transport scheme
protected abstract int	getScope()
List<String>	getSecurityZones()	The set of security zones that the actively logged in user has, if any.
int	getSocketTimeout()
String	getUsername()	The username of the actively logged in user, if any.
protected abstract HandshakeExchange	handshake(GatewayInterface gatewayInterface)
protected abstract LoginResult	idpLoginFinish(GatewayInterface gatewayInterface, String projectName)
AuthenticatedUser	idpLoginFinish(String projectName)
protected abstract URI	idpLoginStart(GatewayInterface gatewayInterface, String projectName)
URI	idpLoginStart(String projectName)
boolean	isConnected()
static boolean	isConnectionRelated(Exception ex)
boolean	isConnectionUp()
boolean	isPlatformLicensed()
boolean	isSessionValid()
void	logout()
protected abstract void	logout(GatewayInterface gatewayInterface)
protected void	onConnect(GatewayInterface gatewayInterface)
protected abstract void	onUnrecoverableIdpAuthSession()
protected abstract void	onVersionMismatch()
protected void	operateOnPropertyChangeSupport(Consumer<PropertyChangeSupport> propertyChangeSupportOperation)	Fire an operation against the propertyChangeSupport instance on the executionQueue.
void	removeConnectionStatusListener(ConnectionStatusListener listener)
void	removePropertyChangeListener(PropertyChangeListener l)
void	removePropertyChangeListener(String propName, PropertyChangeListener l)
void	removePushNotificationListener(PushNotificationListener<?> listener)
protected void	removePushNotificationListeners()
void	setConnectionMode(int newConnectionMode)
void	setConnectTimeout(int newConnectTimeout)
void	setHttpConcurrency(int newHttpConcurrency)
void	setOpcBrowseTimeout(int newOpcBrowseTimeout)
void	setSocketTimeout(int newSocketTimeout)
protected abstract LoginResult	tokenLogin(GatewayInterface gatewayInterface, String encodedAuthToken, String projectName)
void	triggerConnectionStatusListeners()	Manually update the status of all connection listeners.
void	updateLocale(Locale newLocale)	Sends a message to the gateway indicating that the session's locale changed due to some client action.

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

addPushNotificationListener

Field Details

REDUNDANT_MASTER

public static final String REDUNDANT_MASTER

REDUNDANT_BACKUP

public static final String REDUNDANT_BACKUP

INDEPENDENT

public static final String INDEPENDENT

See Also:

• Constant Field Values

CONNECTING

public static final String CONNECTING

See Also:

• Constant Field Values

CONNECT_SUCCESS

public static final String CONNECT_SUCCESS

See Also:

• Constant Field Values

CONNECT_FAIL

public static final String CONNECT_FAIL

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 LoggerEx LOG

LOGGER_STATUS_LOOKUP

public static final Map<Integer,String> LOGGER_STATUS_LOOKUP

Used for internal logging ONLY. Do not use to display messages to the user, as these strings are not internationalized.

readWriteLock

protected final ReentrantReadWriteLock readWriteLock

context

protected final GatewayConnectionContext context

The GatewayConnectionContext containing the launch context, thread pools, WebSocket and HTTP clients.

Constructor Details

AbstractGatewayConnection

protected AbstractGatewayConnection(GatewayConnectionContext context)

Method Details

getScope

protected abstract int getScope()

updateLocale

public void updateLocale(Locale newLocale)

Sends a message to the gateway indicating that the session's locale changed due to some client action.

operateOnPropertyChangeSupport

protected void operateOnPropertyChangeSupport(Consumer<PropertyChangeSupport> propertyChangeSupportOperation)

Fire an operation against the propertyChangeSupport instance on the executionQueue.

Parameters:

propertyChangeSupportOperation - Consumer of PropertyChangeSupport which operates on the propertyChangeSupport instance while running on the executionQueue

getProjectNameInternal

protected abstract Optional<String> getProjectNameInternal()

Get the project name bound to this connection. Any time we need to log into the Gateway, we need to pass the project name bound to this connection. This method exposes the project name in a scope-dependent way assuming the read or write lock is already held by the caller.

Returns:

the project name bound to this connection

authChallengeLogin

protected abstract LoginResult authChallengeLogin(GatewayInterface gatewayInterface,
 AuthChallenge challenge,
 @Nullable
 String projectName)
                                           throws GatewayException

Throws:

GatewayException

tokenLogin

protected abstract LoginResult tokenLogin(GatewayInterface gatewayInterface,
 String encodedAuthToken,
 @Nullable
 String projectName)
                                   throws GatewayException

Throws:

GatewayException

idpLoginFinish

protected abstract LoginResult idpLoginFinish(GatewayInterface gatewayInterface,
 @Nullable
 String projectName)
                                       throws GatewayException

Throws:

GatewayException

authChallengeLogin

public AuthenticatedUser authChallengeLogin(String projectName,
 AuthChallenge challenge)
                                     throws GatewayException

Specified by:

authChallengeLogin in interface GatewayConnection

Throws:

GatewayException

onConnect

protected void onConnect(GatewayInterface gatewayInterface)

onUnrecoverableIdpAuthSession

protected abstract void onUnrecoverableIdpAuthSession()

handshake

protected abstract HandshakeExchange handshake(GatewayInterface gatewayInterface)

onVersionMismatch

protected abstract void onVersionMismatch()

addPushNotificationListeners

protected void addPushNotificationListeners()

connect

public void connect(List<HttpURL> gatewayURLs)

Description copied from interface: GatewayConnection

Connect to the gateway(s) specified

Specified by:

connect in interface GatewayConnection

removePushNotificationListeners

protected void removePushNotificationListeners()

disconnect

public void disconnect()

Specified by:

disconnect 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

getAllAddresses

public 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

getGatewayInterface

public GatewayInterface getGatewayInterface()

Specified by:

getGatewayInterface in interface GatewayConnection

getGatewayWebURL

public 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 String getScheme()

Description copied from interface: GatewayConnection

Returns "http" or "https" depending on our transport scheme

Specified by:

getScheme in interface GatewayConnection

getGatewayNodeRole

public 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

getGatewayTimeZone

public TimeZone getGatewayTimeZone()

Specified by:

getGatewayTimeZone in interface GatewayConnection

idpLoginStart

@Nullable
protected abstract URI idpLoginStart(GatewayInterface gatewayInterface,
 String projectName)
                              throws GatewayException

Throws:

GatewayException

idpLoginStart

@Nullable
public URI idpLoginStart(String projectName)
                  throws GatewayException

Specified by:

idpLoginStart in interface GatewayConnection

Throws:

GatewayException

idpLoginFinish

@Nullable
public AuthenticatedUser idpLoginFinish(String projectName)
                                 throws GatewayException

Specified by:

idpLoginFinish in interface GatewayConnection

Throws:

GatewayException

logout

protected abstract void logout(GatewayInterface gatewayInterface)

logout

public void logout()

Specified by:

logout in interface GatewayConnection

getConnectionMode

public int getConnectionMode()

Description copied from interface: GatewayConnection

Returns the current connection mode

Specified by:

getConnectionMode in interface GatewayConnection

See Also:

• GatewayConstants.MODE_FULL
• GatewayConstants.MODE_DISCONNECTED
• GatewayConstants.MODE_READ_ONLY

setConnectionMode

public void setConnectionMode(int newConnectionMode)

Specified by:

setConnectionMode in interface GatewayConnection

isConnected

public boolean isConnected()

Specified by:

isConnected in interface GatewayConnection

isConnectionUp

public boolean isConnectionUp()

Specified by:

isConnectionUp in interface GatewayConnection

isSessionValid

public boolean isSessionValid()

Specified by:

isSessionValid in interface GatewayConnection

addPushNotificationListener

public <T> void addPushNotificationListener(PushNotificationListener<T> listener,
 PushNotificationDeserializer<T> deserializer)

Description copied from interface: GatewayConnection

Adds a handler for push notifications. The provided deserializer is used to convert incoming raw binary bytes into your handler's expected message type.

Specified by:

addPushNotificationListener in interface GatewayConnection

Parameters:

listener - The listener to add.

deserializer - The deserializer to use.

removePushNotificationListener

public void removePushNotificationListener(PushNotificationListener<?> listener)

Specified by:

removePushNotificationListener in interface GatewayConnection

firePushNotification

protected CompletableFuture<Void> firePushNotification(WebsocketProtoMessage.PushNotification n)

Fire a collection of push notifications to all listeners. Takes care of firing these on the executionQueue.

Parameters:

n - the push notifications to fire

Returns:

a CompletableFuture representing the future completion of firing these notification on the executionQueue

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Specified by:

addPropertyChangeListener in interface GatewayConnection

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Specified by:

removePropertyChangeListener in interface GatewayConnection

addPropertyChangeListener

public void addPropertyChangeListener(String propName,
 PropertyChangeListener l)

Specified by:

addPropertyChangeListener in interface GatewayConnection

removePropertyChangeListener

public void removePropertyChangeListener(String propName,
 PropertyChangeListener l)

Specified by:

removePropertyChangeListener in interface GatewayConnection

getProjectName

public 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 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 List<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 List<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 newConnectTimeout)

Specified by:

setConnectTimeout in interface GatewayConnection

getSocketTimeout

public int getSocketTimeout()

Specified by:

getSocketTimeout in interface GatewayConnection

setSocketTimeout

public void setSocketTimeout(int newSocketTimeout)

Specified by:

setSocketTimeout in interface GatewayConnection

getOpcBrowseTimeout

public int getOpcBrowseTimeout()

Specified by:

getOpcBrowseTimeout in interface GatewayConnection

setOpcBrowseTimeout

public void setOpcBrowseTimeout(int newOpcBrowseTimeout)

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

Specified by:

setHttpConcurrency in interface GatewayConnection

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

getEdgeProjectName

public String getEdgeProjectName()

Specified by:

getEdgeProjectName in interface GatewayConnection

Returns:

the name of the Edge project as defined by the user on the edge gateway settings

isPlatformLicensed

public boolean isPlatformLicensed()

Specified by:

isPlatformLicensed in interface GatewayConnection

isConnectionRelated

public static boolean isConnectionRelated(Exception ex)