de.espirit.firstspirit.module

Interface Module

public interface Module

Interface for a FirstSpirit module class.

Since:

4.1

Method Summary

Methods

Modifier and Type	Method and Description
void	init(ModuleDescriptor descriptor, ServerEnvironment env) Initializes this module with the given descriptor and environment.
void	installed() Event method: called after module was successfully installed.
void	uninstalling() Event method: called when module is uninstalled.
void	updated(String oldVersionString) Event method: called after module has been updated.

Method Detail

init

void init(ModuleDescriptor descriptor,
        ServerEnvironment env)

Initializes this module with the given descriptor and environment. If the optional module class is specified, no other method will be called before the module is initialized!

Parameters:

descriptor - module descriptor.

env - server environment.

Since:

4.1

installed

void installed()

Event method: called after module was successfully installed. For update case see method updated(String).

Since:

4.1

uninstalling

void uninstalling()

Event method: called when module is uninstalled.

Since:

4.1

updated

void updated(String oldVersionString)

Event method: called after module has been updated.

Parameters:

oldVersionString - old version, before module was updated

Since:

4.1