public abstract class AbstractGatewayModuleHook extends java.lang.Object implements GatewayModuleHook
Base class for all gateway module hook implementations. All methods are given empty implementations. It is expected that subclasses will override any methods that they wish to give real implementations.
Best practice is to subclass this class rather than implement GatewayModuleHook
directly, so that when new
methods get added to the interface, your module automatically inherits an empty implementation of the new method
rather than breaking with a NoSuchMethodError
.
Constructor and Description |
---|
AbstractGatewayModuleHook() |
Modifier and Type | Method and Description |
---|---|
void |
configureDeserializer(XMLDeserializer deserializer)
Provides the module a chance to configure the deserializer with any custom handlers
|
void |
configureFunctionFactory(ExpressionFunctionManager factory)
Provides the module with an opportunity to define its own expression functions
|
void |
configureSerializer(XMLSerializer serializer)
Provides the module a chance to add serialization delegates to the serializer custom for
classes that might be
encountered when serializing objects provided by this module
|
java.util.List<? extends IHomepagePanelDescriptor> |
getHomepagePanels()
A list (may be null or empty) of homepage panels that this module provides
|
java.lang.Object |
getRPCHandler(ClientReqSession session,
java.lang.Long projectId)
A class whose functions will become exposed automatically through reflection to the Designer
and the Client
through RPC
|
java.util.List<? extends INamedTab> |
getStatusPanels()
A list (may be null or empty) of panels to display in the status section
|
void |
initializeScriptManager(ScriptManager manager)
Initialize a newly-instantiated script manager.
|
void |
notifyLicenseStateChanged(LicenseState licenseState)
Notify module hook when the license state has changed.
|
void |
updateSystemMap(SystemMap map)
Gives the module a chance to update the system map with any map elements that are pertinent.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
isFreeModule, setup, shutdown, startup
public java.lang.Object getRPCHandler(ClientReqSession session, java.lang.Long projectId)
GatewayModuleHook
getRPCHandler
in interface GatewayModuleHook
public java.util.List<? extends IHomepagePanelDescriptor> getHomepagePanels()
GatewayModuleHook
getHomepagePanels
in interface GatewayModuleHook
public java.util.List<? extends INamedTab> getStatusPanels()
GatewayModuleHook
getStatusPanels
in interface GatewayModuleHook
public void configureDeserializer(XMLDeserializer deserializer)
GatewayModuleHook
configureDeserializer
in interface GatewayModuleHook
public void configureSerializer(XMLSerializer serializer)
GatewayModuleHook
configureSerializer
in interface GatewayModuleHook
public void configureFunctionFactory(ExpressionFunctionManager factory)
GatewayModuleHook
configureFunctionFactory
in interface GatewayModuleHook
public void notifyLicenseStateChanged(LicenseState licenseState)
GatewayModuleHook
notifyLicenseStateChanged
in interface GatewayModuleHook
public void updateSystemMap(SystemMap map)
GatewayModuleHook
updateSystemMap
in interface GatewayModuleHook
public void initializeScriptManager(ScriptManager manager)
GatewayModuleHook
ScriptManager
instance. Usually this will involve calling
ScriptManager.addScriptModule(String, Object)
, which reflectively loads the public
(instance and static) java functions from the given object into the scripting environment, at
the provided path.
This function may be called before GatewayModuleHook.startup(LicenseState)
, but never before
GatewayModuleHook.setup(GatewayContext)
.initializeScriptManager
in interface GatewayModuleHook