Package com.inductiveautomation.ignition.gateway.model

Class GatewayContextDecorator

java.lang.Object

com.inductiveautomation.ignition.gateway.model.GatewayContextDecorator

All Implemented Interfaces:

ExecutionManagerFactory, CommonContext, GatewayContext

public abstract class GatewayContextDecorator
extends Object
implements GatewayContext

Simple abstract decorator for GatewayContext

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.gateway.model.GatewayContext

SERVLET_CONTEXT_KEY

Constructor Summary

Constructors

Constructor	Description
GatewayContextDecorator(GatewayContext gatewayContext)

Method Summary

Modifier and Type	Method	Description
DataSource	createDataSource(Properties connectionProps)	Will create a javax.sql.DataSource that uses connection pooling through apache's DBCP2
XMLDeserializer	createDeserializer()	Returns an instance of the XMLDeserializer that can be used to deserialize project resources.
ExecutionManager	createExecutionManager(String name, int threadCount)	Creates a new, private execution engine.
ExecutionManager	createExecutionManager(String name, int threadCount, ThreadFactory factory)
AlarmManager	getAlarmManager()	The alarm manager is the central hub for alarming.
ApiTokenManager	getApiTokenManager()
AuditManager	getAuditManager()
ConfigurationManager	getConfigurationManager()
DatasourceManager	getDatasourceManager()
List<EdgeEdition>	getEdgeEditions()	Returns a list of currently available Edge editions (either licensed or in trial).
EmailProfileManager	getEmailProfileManager()
EntityManager	getEntityManager()
com.google.common.eventbus.EventBus	getEventBus()	This is a generic event bus that can be used by any part of Ignition within a single scope (jvm)
ExecutionManager	getExecutionManager()	Returns the shared execution manager for the gateway.
ExecutorService	getExecutorService()
FunctionFactory	getExpressionFunctionFactory()	Returns the core function factory used by expressions.
GatewayNetworkManager	getGatewayNetworkManager()
GatewaySessionManager	getGatewaySessionManager()
com.codahale.metrics.health.HealthCheckRegistry	getHealthCheckRegistry()
ImageManager	getImageManager()
UUID	getInstanceToken()	Returns a UUID that is generated fresh every time the context starts up.
LicenseManager	getLicenseManager()
LicenseState	getLicenseState(String moduleId)	Returns the license state for the given module
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.
MetricsDashboardsManager	getMetricsDashboardsManager()
GatewayModuleHook	getModule(String id)	Returns the hook class for another module, used for modules that deal with each other's models.
ModuleManager	getModuleManager()
ModuleServicesManager	getModuleServicesManager()	Returns the ModuleServicesManager, which is responsible for managing the lifecycle of ModuleServices and ModuleServiceConsumers.
NamedQueryManager	getNamedQueryManager()	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()
RestartTasksManager	getRestartTasksManager()
ScheduledExecutorService	getScheduledExecutorService()
ScheduleManager	getScheduleManager()	Get the manager that holds all of the defined schedules.
SchemaUpdater	getSchemaUpdater()
ScriptManager	getScriptManager()	Returns the ScriptManager that can be used to execute Python scripts.
SecretProviderManager	getSecretProviderManager()
SecurityLevelManager	getSecurityLevelManager()
SecurityZoneManager	getSecurityZoneManager()
ServiceConnectorManager	getServiceConnectorManager()
ContextState	getState()
String	getStateMessage()	May return a string describing why the context is in its current state
StoreAndForwardManager	getStoreAndForwardManager()	Returns the StoreAndForwardManager that can be used for storing data to some store and forward engine.
SyncManager	getSyncManager()
SystemEncryptionService	getSystemEncryptionService()
SystemManager	getSystemManager()
SystemPropertiesManager	getSystemPropertiesManager()	The modern way to look up and set gateway system properties.
TagHistoryManager	getTagHistoryManager()
GatewayTagManager	getTagManager()	Returns the manager that provides access to Ignition's tag system.
TelemetryManager	getTelemetryManager()
UserSourceManager	getUserSourceManager()	This manager holds all the configured user sources in the system.
WebResourceManager	getWebResourceManager()

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.gateway.model.GatewayContext

getDiagnosticsManager

Constructor Details

GatewayContextDecorator

public GatewayContextDecorator(@Nonnull
 GatewayContext gatewayContext)

Method Details

getDatasourceManager

public DatasourceManager getDatasourceManager()

Specified by:

getDatasourceManager in interface GatewayContext

getUserSourceManager

public UserSourceManager getUserSourceManager()

Description copied from interface: GatewayContext

This manager holds all the configured user sources in the system. User sources are used for authentication and managing users' contact info, schedules, etc.

Specified by:

getUserSourceManager in interface GatewayContext

getSecurityZoneManager

public SecurityZoneManager getSecurityZoneManager()

Specified by:

getSecurityZoneManager in interface GatewayContext

getScheduleManager

public ScheduleManager getScheduleManager()

Description copied from interface: GatewayContext

Get the manager that holds all of the defined schedules. Schedules are used in alarm notification.

Specified by:

getScheduleManager in interface GatewayContext

getAuditManager

public AuditManager getAuditManager()

Specified by:

getAuditManager in interface GatewayContext

getAlarmManager

public AlarmManager getAlarmManager()

Description copied from interface: GatewayContext

The alarm manager is the central hub for alarming. It is generally used for querying, both status and historical, but can also be used to register new alarm events, and subscribe to alarm events.

Specified by:

getAlarmManager in interface GatewayContext

getInstanceToken

public UUID getInstanceToken()

Description copied from interface: GatewayContext

Returns a UUID that is generated fresh every time the context starts up.

Specified by:

getInstanceToken in interface GatewayContext

getLocalDBInterface

public DBInterface getLocalDBInterface()

Specified by:

getLocalDBInterface in interface GatewayContext

getPersistenceInterface

public PersistenceInterface getPersistenceInterface()

Description copied from interface: GatewayContext

Returns an interface to the internal database persistence system. This version of the function (as compared to getLocalPersistenceInterface()) handles additional tasks, such as replicating data to the redundant backup, and is the version that should be used for most tasks.

Specified by:

getPersistenceInterface in interface GatewayContext

getLocalPersistenceInterface

public PersistenceInterface getLocalPersistenceInterface()

Description copied from interface: GatewayContext

Returns an interface to the persistence system that bypasses redundancy, and goes directly to the internal database. In general, this should NOT be used. Instead, most module authors will want to use getPersistenceInterface(). This

Specified by:

getLocalPersistenceInterface in interface GatewayContext

createDataSource

public DataSource createDataSource(Properties connectionProps)
                            throws Exception

Description copied from interface: GatewayContext

Will create a javax.sql.DataSource that uses connection pooling through apache's DBCP2

Specified by:

createDataSource in interface GatewayContext

Throws:

Exception

getSchemaUpdater

public SchemaUpdater getSchemaUpdater()

Specified by:

getSchemaUpdater in interface GatewayContext

getExecutionManager

public ExecutionManager getExecutionManager()

Description copied from interface: GatewayContext

Returns the shared execution manager for the gateway. Only schedule tasks in here that will not block, which could cause thread starvation.

Specified by:

getExecutionManager in interface GatewayContext

getExecutorService

public ExecutorService getExecutorService()

Specified by:

getExecutorService in interface GatewayContext

getScheduledExecutorService

public ScheduledExecutorService getScheduledExecutorService()

Specified by:

getScheduledExecutorService in interface GatewayContext

getRedundancyManager

public RedundancyManager getRedundancyManager()

Specified by:

getRedundancyManager in interface GatewayContext

getGatewaySessionManager

public GatewaySessionManager getGatewaySessionManager()

Specified by:

getGatewaySessionManager in interface GatewayContext

getModuleServicesManager

public ModuleServicesManager getModuleServicesManager()

Description copied from interface: GatewayContext

Returns the ModuleServicesManager, which is responsible for managing the lifecycle of ModuleServices and ModuleServiceConsumers. This system is used to allow modules to provide services to other modules. The typical pattern is that a dependant module will know about an interface that it wants to use, and it will request that interface from the ModuleServicesManager. The ModuleServicesManager will then notify the dependant module when the service is available.

Specified by:

getModuleServicesManager in interface GatewayContext

getApiTokenManager

public ApiTokenManager getApiTokenManager()

Specified by:

getApiTokenManager in interface GatewayContext

getOpcManager

public OpcConnectionManager getOpcManager()

Specified by:

getOpcManager in interface GatewayContext

getTagHistoryManager

public TagHistoryManager getTagHistoryManager()

Specified by:

getTagHistoryManager in interface GatewayContext

getStoreAndForwardManager

public StoreAndForwardManager getStoreAndForwardManager()

Description copied from interface: GatewayContext

Returns the StoreAndForwardManager that can be used for storing data to some store and forward engine. This manager is also useful for registering different engines, sinks, and stores as well as data serializers.

Specified by:

getStoreAndForwardManager in interface GatewayContext

Returns:

The StoreAndForwardManager.

getEmailProfileManager

public EmailProfileManager getEmailProfileManager()

Specified by:

getEmailProfileManager in interface GatewayContext

getImageManager

public ImageManager getImageManager()

Specified by:

getImageManager in interface GatewayContext

getNamedQueryManager

public NamedQueryManager getNamedQueryManager()

Description copied from interface: GatewayContext

Returns the appropriate named query rpc for the context. In the gateway and client, we only want to use named queries that have been saved. In the designer, we want to use the current version so that reports and bindings can be seen and used for testing before the project is saved.

Specified by:

getNamedQueryManager in interface GatewayContext

Returns:

The correct NamedQueryManager implementation for the scope.

getState

public ContextState getState()

Specified by:

getState in interface GatewayContext

getStateMessage

public String getStateMessage()

Description copied from interface: GatewayContext

May return a string describing why the context is in its current state

Specified by:

getStateMessage in interface GatewayContext

getProjectManager

public ProjectManager getProjectManager()

Specified by:

getProjectManager in interface GatewayContext

getModuleManager

public ModuleManager getModuleManager()

Specified by:

getModuleManager in interface GatewayContext

getConfigurationManager

public ConfigurationManager getConfigurationManager()

Specified by:

getConfigurationManager in interface GatewayContext

getLicenseManager

public LicenseManager getLicenseManager()

Specified by:

getLicenseManager in interface GatewayContext

getPerformanceMonitor

public PerformanceMonitor getPerformanceMonitor()

Specified by:

getPerformanceMonitor in interface GatewayContext

getProgressManager

public GatewayProgressManager getProgressManager()

Specified by:

getProgressManager in interface GatewayContext

getNativeLibraryManager

public NativeLibraryManager getNativeLibraryManager()

Description copied from interface: GatewayContext

The NativeLibraryManager can be used to load gateway-scoped native libraries on a ClassLoader that is reachable by all modules.

Specified by:

getNativeLibraryManager in interface GatewayContext

Returns:

The NativeLibraryManager.

getMessageDispatchManager

public MessageDispatchManager getMessageDispatchManager()

Description copied from interface: GatewayContext

The MessageDispatchManager is used to send script messages to message handlers running on clients and the Gateway.

Specified by:

getMessageDispatchManager in interface GatewayContext

getGatewayNetworkManager

public GatewayNetworkManager getGatewayNetworkManager()

Specified by:

getGatewayNetworkManager in interface GatewayContext

getLoggingManager

public GatewayLoggingManager getLoggingManager()

Specified by:

getLoggingManager in interface CommonContext

Specified by:

getLoggingManager in interface GatewayContext

getMetricRegistry

public com.codahale.metrics.MetricRegistry getMetricRegistry()

Description copied from interface: GatewayContext

Returns the Gateway MetricRegistry, where various metrics like meters and gauges can be accessed. *NOTE* if you have registered a metric in MetricHistoryManager, do not delete it directly from MetricRegistry! Use MetricHistoryManager.unregister() instead.

Specified by:

getMetricRegistry in interface GatewayContext

getHealthCheckRegistry

public com.codahale.metrics.health.HealthCheckRegistry getHealthCheckRegistry()

Specified by:

getHealthCheckRegistry in interface GatewayContext

getMetricHistoryManager

public MetricHistoryManager getMetricHistoryManager()

Description copied from interface: GatewayContext

Returns the MetricHistoryManager, which allows system metric history to be stored for a limited amount of time.

Specified by:

getMetricHistoryManager in interface GatewayContext

getScriptManager

public ScriptManager getScriptManager()

Description copied from interface: CommonContext

Returns the ScriptManager that can be used to execute Python scripts.

Specified by:

getScriptManager in interface CommonContext

createDeserializer

public XMLDeserializer createDeserializer()

Description copied from interface: CommonContext

Returns an instance of the XMLDeserializer that can be used to deserialize project resources. Note that this is the only safe way to obtain an instance of XMLDeserializer, because the context will pass the new deserializer around to all loaded modules, giving them a chance to initialize any custom deserialization deletes on it first.

Specified by:

createDeserializer in interface CommonContext

getExpressionFunctionFactory

public FunctionFactory getExpressionFunctionFactory()

Description copied from interface: CommonContext

Returns the core function factory used by expressions. Includes extension functions registered by modules.

Specified by:

getExpressionFunctionFactory in interface CommonContext

getModule

public GatewayModuleHook getModule(String id)

Description copied from interface: CommonContext

Returns the hook class for another module, used for modules that deal with each other's models. Example: The Reporting module's Designer hook uses this to get the Vision module's hook, in order to add components to the Vision module's palette.

Note that the type of object you get back from this method is very scope specific. In the Gateway, you'll get a GatewayModuleHook, in the Designer you'll get a DesignerModuleHook, etc.

Specified by:

getModule in interface CommonContext

Specified by:

getModule in interface GatewayContext

Parameters:

id - The module ID of the module you want to get the hook for.

Returns:

The hook class for the given module, or null if the module is not installed or not present in the given scope.

getLicenseState

public LicenseState getLicenseState(String moduleId)

Description copied from interface: CommonContext

Returns the license state for the given module

Specified by:

getLicenseState in interface CommonContext

getEventBus

public com.google.common.eventbus.EventBus getEventBus()

Description copied from interface: CommonContext

This is a generic event bus that can be used by any part of Ignition within a single scope (jvm)

Specified by:

getEventBus in interface CommonContext

createExecutionManager

public ExecutionManager createExecutionManager(String name,
 int threadCount)

Description copied from interface: ExecutionManagerFactory

Creates a new, private execution engine. Use this if you have tasks that may block waiting for other things to complete, so that you don't clog up the shared execution engine.

Specified by:

createExecutionManager in interface ExecutionManagerFactory

createExecutionManager

public ExecutionManager createExecutionManager(String name,
 int threadCount,
 ThreadFactory factory)

Specified by:

createExecutionManager in interface ExecutionManagerFactory

getTagManager

public GatewayTagManager getTagManager()

Description copied from interface: CommonContext

Returns the manager that provides access to Ignition's tag system.

Specified by:

getTagManager in interface CommonContext

Specified by:

getTagManager in interface GatewayContext

getSystemManager

public SystemManager getSystemManager()

Specified by:

getSystemManager in interface GatewayContext

getWebResourceManager

public WebResourceManager getWebResourceManager()

Specified by:

getWebResourceManager in interface GatewayContext

getSecurityLevelManager

public SecurityLevelManager getSecurityLevelManager()

Specified by:

getSecurityLevelManager in interface GatewayContext

Returns:

the SecurityLevelManager

getSyncManager

public SyncManager getSyncManager()

Specified by:

getSyncManager in interface GatewayContext

Returns:

the SyncManager that handles syncing data between two systems.

getEdgeEditions

public List<EdgeEdition> getEdgeEditions()

Description copied from interface: CommonContext

Returns a list of currently available Edge editions (either licensed or in trial). Does not check if any required modules are installed and running.

Specified by:

getEdgeEditions in interface CommonContext

getTelemetryManager

public TelemetryManager getTelemetryManager()

Specified by:

getTelemetryManager in interface GatewayContext

Returns:

the TelemetryManager used to gather statistics about the os, vm, and Ignition configuration.

getMetricsDashboardsManager

public MetricsDashboardsManager getMetricsDashboardsManager()

Specified by:

getMetricsDashboardsManager in interface GatewayContext

getSystemPropertiesManager

public SystemPropertiesManager getSystemPropertiesManager()

Description copied from interface: GatewayContext

The modern way to look up and set gateway system properties. This method replaces getSystemProperties(), which had a dangerous dependency on a global ORM record holding gateway system properties.

Available gateway system properties are listed in the GatewaySystemProperties object. Use one of the Properties in that class to get and set gateway system properties.

Specified by:

getSystemPropertiesManager in interface GatewayContext

Returns:

the SystemPropertiesManager that can be used to get and set gateway system properties safely.

getSystemEncryptionService

public SystemEncryptionService getSystemEncryptionService()

Specified by:

getSystemEncryptionService in interface GatewayContext

getSecretProviderManager

public SecretProviderManager getSecretProviderManager()

Specified by:

getSecretProviderManager in interface GatewayContext

getRestartTasksManager

public RestartTasksManager getRestartTasksManager()

Specified by:

getRestartTasksManager in interface GatewayContext

getEntityManager

public EntityManager getEntityManager()

Specified by:

getEntityManager in interface GatewayContext

Returns:

The Gateway-wide, shared EntityManager, which is used to register diagnostic entities. An entity is an abstraction that can be used to represent a configuration and/or diagnostic object in a generic way.

getServiceConnectorManager

public ServiceConnectorManager getServiceConnectorManager()

Specified by:

getServiceConnectorManager in interface GatewayContext