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 GatewayContextpublic UserSourceManager getUserSourceManager()
GatewayContextgetUserSourceManager in interface GatewayContextpublic SecurityZoneManager getSecurityZoneManager()
getSecurityZoneManager in interface GatewayContextpublic ScheduleManager getScheduleManager()
GatewayContextgetScheduleManager in interface GatewayContextpublic AuditManager getAuditManager()
getAuditManager in interface GatewayContextpublic AlarmManager getAlarmManager()
GatewayContextgetAlarmManager in interface GatewayContextpublic org.apache.wicket.request.resource.PackageResourceReference getJQueryUICSSReference()
GatewayContextgetJQueryUICSSReference in interface GatewayContext@Deprecated public AlertStorageManager getAlertStorageManager()
GatewayContextgetAlertStorageManager in interface GatewayContext@Deprecated public AlertNotificationManager getAlertNotificationManager()
GatewayContextgetAlertNotificationManager in interface GatewayContext@Deprecated public BundleUtil getBundle()
GatewayContextgetBundle in interface GatewayContextpublic java.util.UUID getInstanceToken()
getInstanceToken in interface GatewayContextpublic DBInterface getLocalDBInterface()
getLocalDBInterface in interface GatewayContextpublic PersistenceInterface getPersistenceInterface()
GatewayContextgetPersistenceInterface in interface GatewayContextpublic PersistenceInterface getLocalPersistenceInterface()
GatewayContextgetLocalPersistenceInterface in interface GatewayContextpublic java.lang.String getContextName()
GatewayContextgetContextName in interface GatewayContextpublic javax.sql.DataSource createDataSource(java.util.Properties connectionProps)
throws java.lang.Exception
GatewayContextcreateDataSource in interface GatewayContextjava.lang.Exceptionpublic SchemaUpdater getSchemaUpdater()
getSchemaUpdater in interface GatewayContextpublic ExecutionManager getExecutionManager()
GatewayContextgetExecutionManager in interface GatewayContextpublic RedundancyManager getRedundancyManager()
getRedundancyManager in interface GatewayContextpublic GatewaySessionManager getGatewaySessionManager()
getGatewaySessionManager in interface GatewayContextpublic ModuleServicesManager getModuleServicesManager()
getModuleServicesManager in interface GatewayContextpublic SystemPropertiesRecord getSystemProperties()
GatewayContextsession.find(SystemPropertiesRecord.META, SQueryMode.SBASIC, 0L);
getSystemProperties in interface GatewayContext@Deprecated public SystemMap getSystemMap()
getSystemMap in interface GatewayContextpublic OPCManager getOPCManager()
getOPCManager in interface GatewayContextpublic SQLTagsManager getTagManager()
BaseContextgetTagManager in interface BaseContextgetTagManager in interface GatewayContextpublic HistoryManager getHistoryManager()
getHistoryManager in interface GatewayContextpublic SmtpManager getSmtpManager()
getSmtpManager in interface GatewayContextpublic ImageManager getImageManager()
getImageManager in interface GatewayContextpublic NamedQueryRpc getNamedQueryRpc()
GatewayContextgetNamedQueryRpc in interface GatewayContextpublic ContextState getState()
getState in interface GatewayContextpublic java.lang.String getStateMessage()
GatewayContextgetStateMessage in interface GatewayContextpublic ProjectManager getProjectManager()
getProjectManager in interface GatewayContextpublic java.io.File getHome()
GatewayContextgetHome in interface GatewayContextpublic java.io.File getLibDir()
GatewayContextgetLibDir in interface GatewayContextpublic java.io.File getUserlibDir()
GatewayContextuserlib 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 GatewayContextpublic java.io.File getLogsDir()
GatewayContextlogs 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 GatewayContextpublic java.io.File getTempDir()
GatewayContextgetTempDir in interface GatewayContextpublic ModuleManager getModuleManager()
getModuleManager in interface GatewayContextpublic LicenseManager getLicenseManager()
getLicenseManager in interface GatewayContextpublic LaunchManager getLaunchManager()
getLaunchManager in interface GatewayContextpublic PerformanceMonitor getPerformanceMonitor()
getPerformanceMonitor in interface GatewayContextpublic int getHttpPort()
getHttpPort in interface GatewayContextpublic int getHttpsPort()
getHttpsPort in interface GatewayContextpublic int getMetroSSLPort()
getMetroSSLPort in interface GatewayContextpublic java.lang.String getMetroKeystoreAlias()
getMetroKeystoreAlias in interface GatewayContextpublic void addServlet(java.lang.String servletName,
java.lang.Class<? extends javax.servlet.http.HttpServlet> servletClass)
addServlet in interface GatewayContextpublic void removeServlet(java.lang.String servletNname)
removeServlet in interface GatewayContextpublic javax.servlet.ServletContext getServletContext()
GatewayContextgetServletContext in interface GatewayContextpublic int getFrameworkVersion()
GatewayContextgetFrameworkVersion in interface GatewayContextpublic java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> getHomePage()
getHomePage in interface GatewayContextpublic java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> getStatusPage()
getStatusPage in interface GatewayContextpublic java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> getConfigurePage()
getConfigurePage in interface GatewayContextpublic java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> getAppletPage()
getAppletPage in interface GatewayContext@Deprecated public void startActivation()
startActivation in interface GatewayContextpublic void setResponseConfigPanel(ConfigPanel responsePanel)
setResponseConfigPanel in interface GatewayContextpublic GatewayProgressManager getProgressManager()
getProgressManager in interface GatewayContextpublic org.apache.wicket.protocol.http.WebApplication getWebApplication()
GatewayContextgetWebApplication in interface GatewayContextpublic NativeLibraryManager getNativeLibraryManager()
GatewayContextNativeLibraryManager can be used to load gateway-scoped native libraries on a ClassLoader that is
reachable by all modules.getNativeLibraryManager in interface GatewayContextNativeLibraryManager.public void addShutdownHook(java.lang.Thread thread)
GatewayContextRuntime.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 GatewayContextpublic NativeLaunchManager getNativeLaunchManager()
GatewayContextgetNativeLaunchManager in interface GatewayContextpublic MessageDispatchManager getMessageDispatchManager()
GatewayContextgetMessageDispatchManager in interface GatewayContextpublic GatewayAreaNetworkManager getGatewayAreaNetworkManager()
getGatewayAreaNetworkManager in interface GatewayContextpublic TaskManager getTaskManager()
getTaskManager in interface GatewayContextpublic long getContextStartTime()
GatewayContextgetContextStartTime in interface GatewayContextpublic long getInternalDBUpdateCount()
GatewayContextgetInternalDBUpdateCount in interface GatewayContextpublic GatewayLoggingManager getLoggingManager()
getLoggingManager in interface BaseContextgetLoggingManager in interface GatewayContextpublic com.codahale.metrics.MetricRegistry getMetricRegistry()
GatewayContextgetMetricRegistry in interface GatewayContextpublic MetricHistoryManager getMetricHistoryManager()
GatewayContextgetMetricHistoryManager in interface GatewayContextpublic ScriptManager getScriptManager()
BaseContextgetScriptManager in interface BaseContextpublic XMLDeserializer createDeserializer()
BaseContextcreateDeserializer in interface BaseContextpublic FunctionFactory getExpressionFunctionFactory()
BaseContextgetExpressionFunctionFactory in interface BaseContextpublic java.lang.Object getModule(java.lang.String id)
BaseContextgetModule in interface BaseContextpublic LicenseState getLicenseState(java.lang.String moduleId)
BaseContextgetLicenseState in interface BaseContextpublic com.google.common.eventbus.EventBus getEventBus()
BaseContextgetEventBus in interface BaseContextpublic ExecutionManager createExecutionManager(java.lang.String name, int threadCount)
ExecutionManagerFactorycreateExecutionManager in interface ExecutionManagerFactorypublic ExecutionManager createExecutionManager(java.lang.String name, int threadCount, java.util.concurrent.ThreadFactory factory)
createExecutionManager in interface ExecutionManagerFactory