public interface GatewayContext extends BaseContext, ExecutionManagerFactory
Modifier and Type | Field and Description |
---|---|
static org.apache.wicket.request.resource.JavaScriptResourceReference |
DEPLOYMENT_TK
Shared resource name for the java deployment toolkit.
|
static java.lang.String |
PLATFORM_LOGO
Shared resource name for a 32x32 platform logo.
|
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 |
---|---|
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
|
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() |
ExecutionManager |
getExecutionManager()
Returns the shared execution manager for the gateway.
|
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() |
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() |
ModuleManager |
getModuleManager() |
ModuleServicesManager |
getModuleServicesManager() |
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() |
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()
Returns the current map of the system.
|
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) |
default void |
startActivation()
Deprecated.
|
createDeserializer, getEventBus, getExpressionFunctionFactory, getLicenseState, getModule, getScriptManager
createExecutionManager, createExecutionManager
static final org.apache.wicket.request.resource.JavaScriptResourceReference DEPLOYMENT_TK
add(JavascriptPackageResource.getHeaderContribution(new ResourceReference(GatewayContext.DEPLOYMENT_TOOLKIT)));
SharedResources
static final java.lang.String PLATFORM_LOGO
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()
org.apache.wicket.request.resource.PackageResourceReference getJQueryUICSSReference()
@Deprecated AlertStorageManager getAlertStorageManager()
@Deprecated AlertNotificationManager getAlertNotificationManager()
@Deprecated BundleUtil getBundle()
java.util.UUID getInstanceToken()
DBInterface getLocalDBInterface()
PersistenceInterface getPersistenceInterface()
PersistenceInterface getLocalPersistenceInterface()
java.lang.String getContextName()
javax.sql.DataSource createDataSource(java.util.Properties connectionProps) throws java.lang.Exception
java.lang.Exception
SchemaUpdater getSchemaUpdater()
ExecutionManager getExecutionManager()
RedundancyManager getRedundancyManager()
GatewaySessionManager getGatewaySessionManager()
ModuleServicesManager getModuleServicesManager()
SystemPropertiesRecord getSystemProperties()
session.find(SystemPropertiesRecord.META, SQueryMode.SBASIC, 0L);
SystemMap getSystemMap()
OPCManager getOPCManager()
SQLTagsManager getTagManager()
BaseContext
getTagManager
in interface BaseContext
HistoryManager getHistoryManager()
SmtpManager getSmtpManager()
ImageManager getImageManager()
ContextState getState()
java.lang.String getStateMessage()
ProjectManager getProjectManager()
java.io.File getHome()
java.io.File getLibDir()
java.io.File getUserlibDir()
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.java.io.File getLogsDir()
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.java.io.File getTempDir()
ModuleManager getModuleManager()
LicenseManager getLicenseManager()
LaunchManager getLaunchManager()
PerformanceMonitor getPerformanceMonitor()
int getHttpPort()
int getHttpsPort()
int getMetroSSLPort()
java.lang.String getMetroKeystoreAlias()
void addServlet(java.lang.String servletName, java.lang.Class<? extends javax.servlet.http.HttpServlet> servletClass)
void removeServlet(java.lang.String servletNname)
javax.servlet.ServletContext getServletContext()
int getFrameworkVersion()
java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> getHomePage()
java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> getStatusPage()
java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> getConfigurePage()
java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> getAppletPage()
@Deprecated default void startActivation()
void setResponseConfigPanel(ConfigPanel responsePanel)
GatewayProgressManager getProgressManager()
org.apache.wicket.protocol.http.WebApplication getWebApplication()
NativeLibraryManager getNativeLibraryManager()
NativeLibraryManager
can be used to load gateway-scoped native libraries on a ClassLoader that is
reachable by all modules.NativeLibraryManager
.void addShutdownHook(java.lang.Thread thread)
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.thread
- NativeLaunchManager getNativeLaunchManager()
MessageDispatchManager getMessageDispatchManager()
GatewayAreaNetworkManager getGatewayAreaNetworkManager()
TaskManager getTaskManager()
long getContextStartTime()
long getInternalDBUpdateCount()
GatewayLoggingManager getLoggingManager()
getLoggingManager
in interface BaseContext
com.codahale.metrics.MetricRegistry getMetricRegistry()
MetricHistoryManager getMetricHistoryManager()