public interface GatewayContext extends CommonContext, ExecutionManagerFactory
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SERVLET_CONTEXT_KEY
The string key where the instance of GatewayContext is stored under the servlet context object object.
|
Modifier and Type | Method and Description |
---|---|
javax.sql.DataSource |
createDataSource(java.util.Properties connectionProps)
Will create a javax.sql.DataSource that uses connection pooling through apache's DBCP
|
AlarmManager |
getAlarmManager()
The alarm manager is the central hub for alarming.
|
AuditManager |
getAuditManager() |
DatasourceManager |
getDatasourceManager() |
ExecutionManager |
getExecutionManager()
Returns the shared execution manager for the gateway.
|
java.util.concurrent.ExecutorService |
getExecutorService() |
GatewayNetworkManager |
getGatewayAreaNetworkManager() |
GatewaySessionManager |
getGatewaySessionManager() |
HistoryManager |
getHistoryManager() |
HttpClientManager |
getHttpClientManager() |
IdpAdapterManager |
getIdpAdapterManager() |
ImageManager |
getImageManager() |
java.util.UUID |
getInstanceToken()
Returns a UUID that is generated fresh every time the context starts up.
|
LaunchManager |
getLaunchManager() |
LicenseManager |
getLicenseManager() |
DBInterface |
getLocalDBInterface() |
PersistenceInterface |
getLocalPersistenceInterface()
Returns an interface to the persistence system that bypasses redundancy, and goes directly to the internal
database.
|
GatewayLoggingManager |
getLoggingManager() |
MessageDispatchManager |
getMessageDispatchManager()
The MessageDispatchManager is used to send script messages to message handlers running on clients and the
Gateway.
|
MetricHistoryManager |
getMetricHistoryManager()
Returns the MetricHistoryManager, which allows system metric history to be stored for a limited amount of time.
|
com.codahale.metrics.MetricRegistry |
getMetricRegistry()
Returns the Gateway MetricRegistry, where various metrics like meters and gauges can be accessed.
|
ModuleManager |
getModuleManager() |
ModuleServicesManager |
getModuleServicesManager() |
NamedQueryRpc |
getNamedQueryRpc()
Returns the appropriate named query rpc for the context.
|
NativeLibraryManager |
getNativeLibraryManager()
The
NativeLibraryManager can be used to load gateway-scoped native libraries on a ClassLoader that is
reachable by all modules. |
OpcConnectionManager |
getOpcManager() |
PerformanceMonitor |
getPerformanceMonitor() |
PersistenceInterface |
getPersistenceInterface()
Returns an interface to the internal database persistence system.
|
GatewayProgressManager |
getProgressManager() |
ProjectManager |
getProjectManager() |
RedundancyManager |
getRedundancyManager() |
java.util.concurrent.ScheduledExecutorService |
getScheduledExecutorService() |
ScheduleManager |
getScheduleManager()
Get the manager that holds all of the defined schedules.
|
SchemaUpdater |
getSchemaUpdater() |
SecurityLevelManager |
getSecurityLevelManager() |
SecurityZoneManager |
getSecurityZoneManager() |
SmtpManager |
getSmtpManager() |
ContextState |
getState() |
java.lang.String |
getStateMessage()
May return a string describing why the context is in its current state
|
SystemManager |
getSystemManager() |
SystemPropertiesRecord |
getSystemProperties()
Convenience function to look up the SystemPropertiesRecord.
|
GatewayTagHistoryManager |
getTagHistoryManager() |
GatewayTagManager |
getTagManager()
Returns the manager that provides access to Ignition's tag system.
|
TaskManager |
getTaskManager() |
UserSourceManager |
getUserSourceManager()
This manager holds all of the configured user sources in the system.
|
java.util.Optional<WebAuthStrategyAdapter> |
getWebAuthStrategyAdapter(java.lang.String type)
Get the
WebAuthStrategyAdapter registered with the given type |
WebResourceManager |
getWebResourceManager() |
createDeserializer, getEventBus, getExpressionFunctionFactory, getLicenseState, getModule, getScriptManager
createExecutionManager, createExecutionManager
static final java.lang.String SERVLET_CONTEXT_KEY
GatewayContext context = (GatewayContext) getServletContext().getAttribute(GatewayContext.SERVLET_CONTEXT_KEY);
DatasourceManager getDatasourceManager()
UserSourceManager getUserSourceManager()
SecurityZoneManager getSecurityZoneManager()
ScheduleManager getScheduleManager()
AuditManager getAuditManager()
AlarmManager getAlarmManager()
java.util.UUID getInstanceToken()
DBInterface getLocalDBInterface()
PersistenceInterface getPersistenceInterface()
PersistenceInterface getLocalPersistenceInterface()
javax.sql.DataSource createDataSource(java.util.Properties connectionProps) throws java.lang.Exception
java.lang.Exception
SchemaUpdater getSchemaUpdater()
ExecutionManager getExecutionManager()
java.util.concurrent.ExecutorService getExecutorService()
java.util.concurrent.ScheduledExecutorService getScheduledExecutorService()
RedundancyManager getRedundancyManager()
GatewaySessionManager getGatewaySessionManager()
ModuleServicesManager getModuleServicesManager()
SystemPropertiesRecord getSystemProperties()
session.find(SystemPropertiesRecord.META, SQueryMode.SBASIC, 0L);
OpcConnectionManager getOpcManager()
GatewayTagManager getTagManager()
CommonContext
getTagManager
in interface CommonContext
GatewayTagHistoryManager getTagHistoryManager()
HistoryManager getHistoryManager()
SmtpManager getSmtpManager()
ImageManager getImageManager()
NamedQueryRpc getNamedQueryRpc()
ContextState getState()
java.lang.String getStateMessage()
ProjectManager getProjectManager()
SystemManager getSystemManager()
ModuleManager getModuleManager()
LicenseManager getLicenseManager()
LaunchManager getLaunchManager()
PerformanceMonitor getPerformanceMonitor()
GatewayProgressManager getProgressManager()
WebResourceManager getWebResourceManager()
NativeLibraryManager getNativeLibraryManager()
NativeLibraryManager
can be used to load gateway-scoped native libraries on a ClassLoader that is
reachable by all modules.NativeLibraryManager
.MessageDispatchManager getMessageDispatchManager()
GatewayNetworkManager getGatewayAreaNetworkManager()
TaskManager getTaskManager()
GatewayLoggingManager getLoggingManager()
getLoggingManager
in interface CommonContext
com.codahale.metrics.MetricRegistry getMetricRegistry()
MetricHistoryManager getMetricHistoryManager()
HttpClientManager getHttpClientManager()
HttpClientManager
SecurityLevelManager getSecurityLevelManager()
SecurityLevelManager
IdpAdapterManager getIdpAdapterManager()
IdpAdapterManager
java.util.Optional<WebAuthStrategyAdapter> getWebAuthStrategyAdapter(@Nonnull java.lang.String type)
WebAuthStrategyAdapter
registered with the given typetype
- the registered adapter type stringOptional
containing the WebAuthStrategyAdapter
registered with the given type or an
empty Optional if there exists no adapter registered with the given type