public interface GatewayAreaNetworkManager
extends com.inductiveautomation.metro.api.CentralManager
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
GAN_SETUP_PROP_KEY |
static java.lang.String |
SYSTAG_AVAILABLE |
static java.lang.String |
SYSTAG_LAST_COMM |
INCOMING_METER_BASE, INCOMING_METER_FORMAT, INTENT_METER_BASE, INTENT_METER_FORMAT, INTENT_SENDING_SERVER, MDC_REMOTE_CONNECTION_ID, MDC_REMOTE_GATEWAY_NAME, METRIC_FAULT, METRIC_PENDING_DOWNLOADS, METRIC_PENDING_DOWNLOADS_MAX, METRIC_PENDING_UPLOAD, METRIC_PENDING_UPLOADS_MAX, METRIC_WAITING_PROCESSING, METRIC_WAITING_PROCESSING_MAX, METRO_METRIC_PREFIX, OUTGOING_METER_BASE, OUTGOING_METER_FORMAT, RPC_RESULT_FORMAT
Modifier and Type | Method and Description |
---|---|
void |
addGanConnection(GanSetupItem ganSetup)
Adds a GAN connection only if there is no existing GAN connection with the host and port specified in the passed
setup.
|
void |
addRouteChangeListener(com.inductiveautomation.metro.api.RouteChangeListener listener)
Add a listener to the internal routing manager that will fire whenever routes change.
|
GanSetupItem |
fromWSSettingsRecord(long settingsId)
Returns a WSConnectionSettings record as a GanSetupItem object.
|
boolean |
ganConnectionExists(java.lang.String host,
int port,
boolean isSSL)
Checks whether a GAN connection exists with the same host, port and SSL settings.
|
java.util.Collection<com.inductiveautomation.metro.impl.ConnectionWatcher> |
getAvailableConnections()
Retrieves all known GAN connection objects.
|
java.util.Optional<com.inductiveautomation.metro.impl.ConnectionWatcher> |
getConnection(java.lang.String connectionId)
Returns a ConnectionWatcher object for the specified connectionId within an Optional.
|
java.util.Collection<com.inductiveautomation.metro.impl.ConnectionWatcher> |
getInboundConnections()
Retrieves all known GAN connection objects that represent inbound connections.
|
java.util.Optional<java.util.Date> |
getLastCommTime(com.inductiveautomation.metro.api.ServerId serverAddress)
Returns a Optional containing a date, which indicates the last time a ping was received from the remote machine.
|
com.inductiveautomation.metro.api.ServerId |
getServerNameForConnection(java.lang.Long connId)
Returns a ServerId for a server whose WSConnectionSettings id matches the passed connId.
|
void |
removeInboundConnections()
Unregisters all inbound connections from the metro system.
|
void |
removeRouteChangeListener(com.inductiveautomation.metro.api.RouteChangeListener listener)
Removes a listener for the internal routing layer.
|
addServerListener, addServerListener, getConnectionForServer, getIntentDescription, getKnownServers, getReadOnlyIntentMap, getRedundancyActivityLevel, getServer, getServerAddress, getServerIfKnown, getServerNameForConnection, getServerState, getServerStatus, getServiceManager, installSecurityPlugin, maybePutIntentDescription, registerConnection, registerIntent, removeSecurityPlugin, removeServerListener, removeServerListener, retrieveIntent, unregisterConnection, unregisterIntent
static final java.lang.String GAN_SETUP_PROP_KEY
static final java.lang.String SYSTAG_AVAILABLE
static final java.lang.String SYSTAG_LAST_COMM
boolean ganConnectionExists(java.lang.String host, int port, boolean isSSL)
host
- port
- isSSL
- void addGanConnection(GanSetupItem ganSetup)
ganSetup
- java.util.Collection<com.inductiveautomation.metro.impl.ConnectionWatcher> getAvailableConnections()
java.util.Collection<com.inductiveautomation.metro.impl.ConnectionWatcher> getInboundConnections()
void removeInboundConnections()
GanSetupItem fromWSSettingsRecord(long settingsId) throws java.lang.Exception
settingsId
- java.lang.Exception
com.inductiveautomation.metro.api.ServerId getServerNameForConnection(java.lang.Long connId)
connId
- java.util.Optional<com.inductiveautomation.metro.impl.ConnectionWatcher> getConnection(java.lang.String connectionId)
connectionId
- void addRouteChangeListener(com.inductiveautomation.metro.api.RouteChangeListener listener)
listener
- void removeRouteChangeListener(com.inductiveautomation.metro.api.RouteChangeListener listener)
listener
- java.util.Optional<java.util.Date> getLastCommTime(com.inductiveautomation.metro.api.ServerId serverAddress)