Package com.inductiveautomation.factorypmi.application.runtime

Class ClientGatewayConnection

java.lang.Object

com.inductiveautomation.ignition.client.gateway_interface.AbstractGatewayConnection

com.inductiveautomation.factorypmi.application.runtime.ClientGatewayConnection

All Implemented Interfaces:

GatewayConnection, GatewayConstants

public class ClientGatewayConnection
extends AbstractGatewayConnection

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.client.gateway_interface.AbstractGatewayConnection

AbstractGatewayConnection.LoginContext, AbstractGatewayConnection.WebSocketEndpoint

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	ORIGINATING_LICENSE_ATTRIBUTE_KEY

Fields inherited from class com.inductiveautomation.ignition.client.gateway_interface.AbstractGatewayConnection

CONNECT_FAIL, CONNECT_SUCCESS, CONNECTING, context, INDEPENDENT, LOG, LOGGER_STATUS_LOOKUP, readWriteLock, REDUNDANT_BACKUP, REDUNDANT_MASTER, STATUS_CONNECT_FAIL, STATUS_CONNECT_INACTIVE, STATUS_CONNECT_UNKNOWN, STATUS_CONNECT_WARNING, STATUS_CONNECTED, STATUS_CONNECTED_INCOMPATIBLE, 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

Constructor	Description
ClientGatewayConnection(GatewayConnectionContext context)

Method Summary

Modifier and Type	Method	Description
protected void	addPushNotificationListeners()
protected LoginResult	authChallengeLogin(GatewayInterface gatewayInterface, AuthChallenge challenge, @Nullable String projectName)
String	getProjectName()	The name of the project that we are currently logged into, if any.
protected Optional<String>	getProjectNameInternal()	Get the project name bound to this connection.
protected int	getScope()
protected HandshakeExchange	handshake(GatewayInterface gatewayInterface)
protected LoginResult	idpLoginFinish(GatewayInterface gatewayInterface, @Nullable String projectName)
protected @Nullable URI	idpLoginStart(GatewayInterface gatewayInterface, String projectName)
protected void	logout(GatewayInterface gatewayInterface)
protected void	onConnect(GatewayInterface gatewayInterface)
protected void	onUnrecoverableIdpAuthSession()
protected void	onVersionMismatch()
protected void	removePushNotificationListeners()
void	setClientPanel(ClientPanel newClientPanel)
protected LoginResult	tokenLogin(GatewayInterface gatewayInterface, String encodedAuthToken, @Nullable String projectName)

Methods inherited from class com.inductiveautomation.ignition.client.gateway_interface.AbstractGatewayConnection

addConnectionStatusListener, addPropertyChangeListener, addPropertyChangeListener, addPushNotificationListener, authChallengeLogin, connect, disconnect, firePushNotifications, getAllAddresses, getAuthChallenge, getConnectionMode, getConnectTimeout, getEdgeProjectName, getGatewayAddress, getGatewayInterface, getGatewayNodeRole, getGatewayTimeZone, getGatewayWebURL, getHttpConcurrency, getOpcBrowseTimeout, getRoles, getScheme, getSecurityZones, getSocketTimeout, getUsername, idpLoginFinish, idpLoginStart, isConnected, isConnectionRelated, isConnectionUp, isPlatformLicensed, isSessionValid, logout, operateOnPropertyChangeSupport, removeConnectionStatusListener, removePropertyChangeListener, removePropertyChangeListener, removePushNotificationListener, setConnectionMode, setConnectTimeout, setHttpConcurrency, setOpcBrowseTimeout, setSocketTimeout, triggerConnectionStatusListeners, updateLocale

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

ORIGINATING_LICENSE_ATTRIBUTE_KEY

public static final String ORIGINATING_LICENSE_ATTRIBUTE_KEY

See Also:

• Constant Field Values

Constructor Details

ClientGatewayConnection

public ClientGatewayConnection(GatewayConnectionContext context)

Method Details

getScope

protected int getScope()

Specified by:

getScope in class AbstractGatewayConnection

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

Overrides:

getProjectName in class AbstractGatewayConnection

getProjectNameInternal

protected Optional<String> getProjectNameInternal()

Description copied from class: AbstractGatewayConnection

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.

Specified by:

getProjectNameInternal in class AbstractGatewayConnection

Returns:

the project name bound to this connection

addPushNotificationListeners

protected void addPushNotificationListeners()

Overrides:

addPushNotificationListeners in class AbstractGatewayConnection

removePushNotificationListeners

protected void removePushNotificationListeners()

Overrides:

removePushNotificationListeners in class AbstractGatewayConnection

authChallengeLogin

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

Specified by:

authChallengeLogin in class AbstractGatewayConnection

Throws:

GatewayException

tokenLogin

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

Specified by:

tokenLogin in class AbstractGatewayConnection

Throws:

GatewayException

idpLoginStart

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

Specified by:

idpLoginStart in class AbstractGatewayConnection

Throws:

GatewayException

logout

protected void logout(GatewayInterface gatewayInterface)

Specified by:

logout in class AbstractGatewayConnection

idpLoginFinish

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

Specified by:

idpLoginFinish in class AbstractGatewayConnection

Throws:

GatewayException

handshake

protected HandshakeExchange handshake(GatewayInterface gatewayInterface)

Specified by:

handshake in class AbstractGatewayConnection

onUnrecoverableIdpAuthSession

protected void onUnrecoverableIdpAuthSession()

Specified by:

onUnrecoverableIdpAuthSession in class AbstractGatewayConnection

onVersionMismatch

protected void onVersionMismatch()

Specified by:

onVersionMismatch in class AbstractGatewayConnection

onConnect

protected void onConnect(GatewayInterface gatewayInterface)

Overrides:

onConnect in class AbstractGatewayConnection

setClientPanel

public void setClientPanel(ClientPanel newClientPanel)