public abstract class GatewayContextDecorator extends java.lang.Object implements GatewayContext
DEPLOYMENT_TK, PLATFORM_LOGO, SERVLET_CONTEXT_KEY
Modifier | Constructor and Description |
---|---|
protected |
GatewayContextDecorator(GatewayContext delegate) |
Modifier and Type | Method and Description |
---|---|
void |
addServlet(java.lang.String servletName,
java.lang.Class<? extends javax.servlet.http.HttpServlet> servletClass) |
void |
addShutdownHook(java.lang.Thread thread)
Much like Java's
Runtime.addShutdownHook(Thread) , adds an initialized, but non-running, thread to a list
that will be run when the system shuts down. |
javax.sql.DataSource |
createDataSource(java.util.Properties connectionProps)
Will create a javax.sql.DataSource that uses connection pooling through apache's DBCP
|
XMLDeserializer |
createDeserializer()
Returns an instance of the XMLDeserializer that can be used to deserialize project resources.
|
ExecutionManager |
createExecutionManager(java.lang.String name,
int threadCount)
Creates a new, private execution engine.
|
ExecutionManager |
createExecutionManager(java.lang.String name,
int threadCount,
java.util.concurrent.ThreadFactory factory) |
AlarmManager |
getAlarmManager()
The alarm manager is the central hub for alarming.
|
AlertNotificationManager |
getAlertNotificationManager()
Deprecated.
|
AlertStorageManager |
getAlertStorageManager()
Deprecated.
|
java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> |
getAppletPage() |
AuditManager |
getAuditManager() |
BundleUtil |
getBundle()
Deprecated.
|
java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> |
getConfigurePage() |
java.lang.String |
getContextName()
Returns the context name, with a leading slash.
|
long |
getContextStartTime()
Returns an epoch milliseconds timestamp of when the gateway was started.
|
DatasourceManager |
getDatasourceManager() |
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.
|
FunctionFactory |
getExpressionFunctionFactory()
Returns the core function factory used by expressions.
|
int |
getFrameworkVersion()
Returns the overall version for the Framework API.
|
GatewayAreaNetworkManager |
getGatewayAreaNetworkManager() |
GatewaySessionManager |
getGatewaySessionManager() |
HistoryManager |
getHistoryManager() |
java.io.File |
getHome()
Returns the home directory for the system.
|
java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> |
getHomePage() |
int |
getHttpPort() |
int |
getHttpsPort() |
ImageManager |
getImageManager() |
java.util.UUID |
getInstanceToken() |
long |
getInternalDBUpdateCount()
Returns how many updates have occurred in the internal database since the gateway was started.
|
org.apache.wicket.request.resource.PackageResourceReference |
getJQueryUICSSReference()
Returns the resource reference for the jquery-ui css reference
|
LaunchManager |
getLaunchManager() |
java.io.File |
getLibDir()
* Provides the path to the lib folder, which holds all the jars used by Ignition.
|
LicenseManager |
getLicenseManager() |
LicenseState |
getLicenseState(java.lang.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() |
java.io.File |
getLogsDir()
Provides the path to the
logs folder. |
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.
|
java.lang.String |
getMetroKeystoreAlias() |
int |
getMetroSSLPort() |
java.lang.Object |
getModule(java.lang.String id)
Returns the hook class for another module, used for modules that deal with each other's models.
|
ModuleManager |
getModuleManager() |
ModuleServicesManager |
getModuleServicesManager() |
NamedQueryRpc |
getNamedQueryRpc()
Returns the appropriate named query rpc for the context.
|
NativeLaunchManager |
getNativeLaunchManager()
NativeLaunchManager is used for management of native Client Launcher executables.
|
NativeLibraryManager |
getNativeLibraryManager()
The
NativeLibraryManager can be used to load gateway-scoped native libraries on a ClassLoader that is
reachable by all modules. |
OPCManager |
getOPCManager() |
PerformanceMonitor |
getPerformanceMonitor() |
PersistenceInterface |
getPersistenceInterface()
Returns an interface to the internal database persistence system.
|
GatewayProgressManager |
getProgressManager() |
ProjectManager |
getProjectManager() |
RedundancyManager |
getRedundancyManager() |
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.
|
SecurityZoneManager |
getSecurityZoneManager() |
javax.servlet.ServletContext |
getServletContext()
Returns the ServletContext that is associated with this context.
|
SmtpManager |
getSmtpManager() |
ContextState |
getState() |
java.lang.String |
getStateMessage()
May return a string describing why the context is in its current state
|
java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> |
getStatusPage() |
SystemMap |
getSystemMap()
Deprecated.
|
SystemPropertiesRecord |
getSystemProperties()
Convenience function to look up the SystemPropertiesRecord.
|
SQLTagsManager |
getTagManager()
Returns the TagManager that can be used to read,write,browse, and subscribe to SQLTags from this context.
|
TaskManager |
getTaskManager() |
java.io.File |
getTempDir()
Returns a temp dir that is managed by the context (cleaned out on startup.)
|
java.io.File |
getUserlibDir()
Provides the path to the
userlib folder. |
UserSourceManager |
getUserSourceManager()
This manager holds all of the configured user sources in the system.
|
org.apache.wicket.protocol.http.WebApplication |
getWebApplication()
Get the WebApplication (root of Wicket) for the gateway.
|
void |
removeServlet(java.lang.String servletNname) |
void |
setResponseConfigPanel(ConfigPanel responsePanel) |
void |
startActivation()
Deprecated.
|
protected GatewayContextDecorator(GatewayContext delegate)
public DatasourceManager getDatasourceManager()
getDatasourceManager
in interface GatewayContext
public UserSourceManager getUserSourceManager()
GatewayContext
getUserSourceManager
in interface GatewayContext
public SecurityZoneManager getSecurityZoneManager()
getSecurityZoneManager
in interface GatewayContext
public ScheduleManager getScheduleManager()
GatewayContext
getScheduleManager
in interface GatewayContext
public AuditManager getAuditManager()
getAuditManager
in interface GatewayContext
public AlarmManager getAlarmManager()
GatewayContext
getAlarmManager
in interface GatewayContext
public org.apache.wicket.request.resource.PackageResourceReference getJQueryUICSSReference()
GatewayContext
getJQueryUICSSReference
in interface GatewayContext
@Deprecated public AlertStorageManager getAlertStorageManager()
GatewayContext
getAlertStorageManager
in interface GatewayContext
@Deprecated public AlertNotificationManager getAlertNotificationManager()
GatewayContext
getAlertNotificationManager
in interface GatewayContext
@Deprecated public BundleUtil getBundle()
GatewayContext
getBundle
in interface GatewayContext
public java.util.UUID getInstanceToken()
getInstanceToken
in interface GatewayContext
public DBInterface getLocalDBInterface()
getLocalDBInterface
in interface GatewayContext
public PersistenceInterface getPersistenceInterface()
GatewayContext
getPersistenceInterface
in interface GatewayContext
public PersistenceInterface getLocalPersistenceInterface()
GatewayContext
getLocalPersistenceInterface
in interface GatewayContext
public java.lang.String getContextName()
GatewayContext
getContextName
in interface GatewayContext
public javax.sql.DataSource createDataSource(java.util.Properties connectionProps) throws java.lang.Exception
GatewayContext
createDataSource
in interface GatewayContext
java.lang.Exception
public SchemaUpdater getSchemaUpdater()
getSchemaUpdater
in interface GatewayContext
public ExecutionManager getExecutionManager()
GatewayContext
getExecutionManager
in interface GatewayContext
public RedundancyManager getRedundancyManager()
getRedundancyManager
in interface GatewayContext
public GatewaySessionManager getGatewaySessionManager()
getGatewaySessionManager
in interface GatewayContext
public ModuleServicesManager getModuleServicesManager()
getModuleServicesManager
in interface GatewayContext
public SystemPropertiesRecord getSystemProperties()
GatewayContext
session.find(SystemPropertiesRecord.META, SQueryMode.SBASIC, 0L);
getSystemProperties
in interface GatewayContext
@Deprecated public SystemMap getSystemMap()
getSystemMap
in interface GatewayContext
public OPCManager getOPCManager()
getOPCManager
in interface GatewayContext
public SQLTagsManager getTagManager()
BaseContext
getTagManager
in interface BaseContext
getTagManager
in interface GatewayContext
public HistoryManager getHistoryManager()
getHistoryManager
in interface GatewayContext
public SmtpManager getSmtpManager()
getSmtpManager
in interface GatewayContext
public ImageManager getImageManager()
getImageManager
in interface GatewayContext
public NamedQueryRpc getNamedQueryRpc()
GatewayContext
getNamedQueryRpc
in interface GatewayContext
public ContextState getState()
getState
in interface GatewayContext
public java.lang.String getStateMessage()
GatewayContext
getStateMessage
in interface GatewayContext
public ProjectManager getProjectManager()
getProjectManager
in interface GatewayContext
public java.io.File getHome()
GatewayContext
getHome
in interface GatewayContext
public java.io.File getLibDir()
GatewayContext
getLibDir
in interface GatewayContext
public java.io.File getUserlibDir()
GatewayContext
userlib
folder. The userlib folder contains binaries that can be changed by
the user. These binaries include the modules and the jdbc jars. The value is taken from the
userlib.dir
context parameter in webserver/webapps/main/WEB-INF/web.xml.getUserlibDir
in interface GatewayContext
public java.io.File getLogsDir()
GatewayContext
logs
folder. The logs folder holds all the important log files used by
Ignition. The value is taken from the logs.dir
context parameter in
webserver/webapps/main/WEB-INF/web.xml.getLogsDir
in interface GatewayContext
public java.io.File getTempDir()
GatewayContext
getTempDir
in interface GatewayContext
public ModuleManager getModuleManager()
getModuleManager
in interface GatewayContext
public LicenseManager getLicenseManager()
getLicenseManager
in interface GatewayContext
public LaunchManager getLaunchManager()
getLaunchManager
in interface GatewayContext
public PerformanceMonitor getPerformanceMonitor()
getPerformanceMonitor
in interface GatewayContext
public int getHttpPort()
getHttpPort
in interface GatewayContext
public int getHttpsPort()
getHttpsPort
in interface GatewayContext
public int getMetroSSLPort()
getMetroSSLPort
in interface GatewayContext
public java.lang.String getMetroKeystoreAlias()
getMetroKeystoreAlias
in interface GatewayContext
public void addServlet(java.lang.String servletName, java.lang.Class<? extends javax.servlet.http.HttpServlet> servletClass)
addServlet
in interface GatewayContext
public void removeServlet(java.lang.String servletNname)
removeServlet
in interface GatewayContext
public javax.servlet.ServletContext getServletContext()
GatewayContext
getServletContext
in interface GatewayContext
public int getFrameworkVersion()
GatewayContext
getFrameworkVersion
in interface GatewayContext
public java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> getHomePage()
getHomePage
in interface GatewayContext
public java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> getStatusPage()
getStatusPage
in interface GatewayContext
public java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> getConfigurePage()
getConfigurePage
in interface GatewayContext
public java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> getAppletPage()
getAppletPage
in interface GatewayContext
@Deprecated public void startActivation()
startActivation
in interface GatewayContext
public void setResponseConfigPanel(ConfigPanel responsePanel)
setResponseConfigPanel
in interface GatewayContext
public GatewayProgressManager getProgressManager()
getProgressManager
in interface GatewayContext
public org.apache.wicket.protocol.http.WebApplication getWebApplication()
GatewayContext
getWebApplication
in interface GatewayContext
public NativeLibraryManager getNativeLibraryManager()
GatewayContext
NativeLibraryManager
can be used to load gateway-scoped native libraries on a ClassLoader that is
reachable by all modules.getNativeLibraryManager
in interface GatewayContext
NativeLibraryManager
.public void addShutdownHook(java.lang.Thread thread)
GatewayContext
Runtime.addShutdownHook(Thread)
, adds an initialized, but non-running, thread to a list
that will be run when the system shuts down. Threads are started in the order that they're added, and are given 5
seconds to run before the next one is started. In other words, a shutdown hook can assume it has 5 seconds to
perform its work before gateway subsystems are shut down. The shutdown hook threads will all be set to daemon, so
they cannot prevent the system from shutting down.addShutdownHook
in interface GatewayContext
public NativeLaunchManager getNativeLaunchManager()
GatewayContext
getNativeLaunchManager
in interface GatewayContext
public MessageDispatchManager getMessageDispatchManager()
GatewayContext
getMessageDispatchManager
in interface GatewayContext
public GatewayAreaNetworkManager getGatewayAreaNetworkManager()
getGatewayAreaNetworkManager
in interface GatewayContext
public TaskManager getTaskManager()
getTaskManager
in interface GatewayContext
public long getContextStartTime()
GatewayContext
getContextStartTime
in interface GatewayContext
public long getInternalDBUpdateCount()
GatewayContext
getInternalDBUpdateCount
in interface GatewayContext
public GatewayLoggingManager getLoggingManager()
getLoggingManager
in interface BaseContext
getLoggingManager
in interface GatewayContext
public com.codahale.metrics.MetricRegistry getMetricRegistry()
GatewayContext
getMetricRegistry
in interface GatewayContext
public MetricHistoryManager getMetricHistoryManager()
GatewayContext
getMetricHistoryManager
in interface GatewayContext
public ScriptManager getScriptManager()
BaseContext
getScriptManager
in interface BaseContext
public XMLDeserializer createDeserializer()
BaseContext
createDeserializer
in interface BaseContext
public FunctionFactory getExpressionFunctionFactory()
BaseContext
getExpressionFunctionFactory
in interface BaseContext
public java.lang.Object getModule(java.lang.String id)
BaseContext
getModule
in interface BaseContext
public LicenseState getLicenseState(java.lang.String moduleId)
BaseContext
getLicenseState
in interface BaseContext
public com.google.common.eventbus.EventBus getEventBus()
BaseContext
getEventBus
in interface BaseContext
public ExecutionManager createExecutionManager(java.lang.String name, int threadCount)
ExecutionManagerFactory
createExecutionManager
in interface ExecutionManagerFactory
public ExecutionManager createExecutionManager(java.lang.String name, int threadCount, java.util.concurrent.ThreadFactory factory)
createExecutionManager
in interface ExecutionManagerFactory