WebAppModule.java

Mit dieser Klasse kann auf bestimmte Ereignisse, wie Installation, Deinstallation oder Aktualisierung des Modules durch den Benutzer in der Administrationsoberfläche, reagiert werden. Über die Methoden können Änderungen an allen Komponenten des Moduls vorgenommen werden. Da die Beispielimplementierung nur eine Komponente enthält, wurde hier keine Logik implementiert. Wird diese Funktionalität nicht benötigt, kann die Klasse (und der Eintrag in der module.xml) vollständig entfallen.

Listing: Beispiel WebApp – Implementierung WebAppModule

package de.espirit.firstspirit.opt.examples.webapp.configuration;

import de.espirit.firstspirit.module.Module;
import de.espirit.firstspirit.module.ServerEnvironment;
import de.espirit.firstspirit.module.descriptor.ModuleDescriptor;

/**
 * You don't need this class if you just want to create a simple
 * webapp, but it might be useful if your module will contain multiple
 * components.
 */
public class WebAppModule implements Module {

    /*
     *  Initializes this component with the given descriptor and
     * environment.
     */
    public void init(final ModuleDescriptor descriptor,
            final ServerEnvironment env) {
    }

    /*
     * Use this method to install templates or create other elements
     */
    public void installed() {
    }

    /*
     * Use this method to uninstall templates and to perform a cleanup
     */
    public void uninstalling() {
    }

    /*
     * Use this method to update templates or alter configuration
     * settings during an update
     */
    public void updated(final String oldVersionString) {
    }

    @Override
    public String toString() {
        return "FirstSpirit WebApp Example Module";
    }

}