com.inductiveautomation.ignition.gateway.model

Interface ModuleManager

public interface ModuleManager

Manages how modules are installed, restarted, and removed from Ignition

Method Summary

Modifier and Type	Method and Description
void	addModuleObserver(ModuleObserver observer) Register a ModuleObserver that gets notified when modules are added.
java.util.List<GatewayModule>	getGatewayModules() Returns a list of all modules that have Gateway-scope hooks
GatewayModule	getModule(java.lang.String id) Finds a module with the given id string.
int	getModuleCount() The total count of modules currently installed
java.util.List<GatewayModule>	getModules() Returns a list of all modules
ScopeVersionHash	getVersionHash(int scope) Retrieve the current hash for a given scope.
void	installModule(java.lang.String filename, byte[] bytes) Installs a new module.
void	removeModuleObserver(ModuleObserver observer) Remove a previously registered ModuleObserver.
java.lang.Class<?>	resolveClass(java.lang.String className) Loops through each module's classloader, giving it a chance to resolve the given class.
void	restartModule(java.lang.String moduleId) Restarts the given module.
void	uninstallModule(java.lang.String moduleId) Uninstalls the given module.

Method Detail

getGatewayModules

java.util.List<GatewayModule> getGatewayModules()

Returns a list of all modules that have Gateway-scope hooks

getModuleCount

int getModuleCount()

The total count of modules currently installed

getModules

java.util.List<GatewayModule> getModules()

Returns a list of all modules

getModule

GatewayModule getModule(java.lang.String id)

Finds a module with the given id string. Case sensitive. Will return null if the module is not found.

resolveClass

java.lang.Class<?> resolveClass(java.lang.String className)

Loops through each module's classloader, giving it a chance to resolve the given class.

getVersionHash

ScopeVersionHash getVersionHash(int scope)

Retrieve the current hash for a given scope.

See Also:

ApplicationScope

uninstallModule

void uninstallModule(java.lang.String moduleId)
              throws java.lang.Exception

Uninstalls the given module. Any dependent modules will be restarted afterwards.

Throws:

java.lang.Exception

restartModule

void restartModule(java.lang.String moduleId)
            throws java.lang.Exception

Restarts the given module. Any dependent modules will first be shut down, and then restarted afterwards.

Throws:

java.lang.Exception

installModule

void installModule(java.lang.String filename,
                   byte[] bytes)
            throws java.lang.Exception

Installs a new module.

Parameters:

filename - The desired filename for the new module, like "MyModule.modl"

bytes - The *.modl file, as a byte array.

Throws:

java.lang.Exception

addModuleObserver

void addModuleObserver(ModuleObserver observer)

Register a ModuleObserver that gets notified when modules are added.

Parameters:

observer - The observer to register.

removeModuleObserver

void removeModuleObserver(ModuleObserver observer)

Remove a previously registered ModuleObserver.

Parameters:

observer - The observer to unregister.