public interface ClientModuleHook
<hook scope="C">com.example.module.client.SuperHookClass</hook>Best practice: Instead of implementing this interface directly, subclass your hook class from
AbstractClientModuleHook
instead.Modifier and Type | Method and Description |
---|---|
void |
configureDeserializer(XMLDeserializer deserializer)
Called when an XMLDeserializer is created.
|
void |
configureFunctionFactory(ExpressionFunctionManager factory)
Provides the module with an opportunity to define its own expression functions
|
void |
initializeScriptManager(ScriptManager manager)
Initialize a newly-instantiated script manager.
|
void |
notifyActivationStateChanged(LicenseState licenseState)
Notifies this client module that it's license state has changed.
|
void |
shutdown()
Called when the module is shut down.
|
void |
startup(ClientContext context,
LicenseState activationState)
The main entrypoint for the module hook.
|
void startup(ClientContext context, LicenseState activationState) throws java.lang.Exception
shutdown()
will be called and a new hook will be instantiatedjava.lang.Exception
- if the module was not able to be initialized for the given project.void shutdown()
void configureDeserializer(XMLDeserializer deserializer)
void notifyActivationStateChanged(LicenseState licenseState)
void initializeScriptManager(ScriptManager manager)
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.void configureFunctionFactory(ExpressionFunctionManager factory)