org/sonews/plugin/Plugin.java
author cli
Mon Aug 24 14:40:37 2009 +0200 (2009-08-24)
changeset 21 4b2c8bedb094
permissions -rw-r--r--
Refactoring in CommandSelector to allow manually loading of plugins.
     1 /*
     2  *   SONEWS News Server
     3  *   see AUTHORS for the list of contributors
     4  *
     5  *   This program is free software: you can redistribute it and/or modify
     6  *   it under the terms of the GNU General Public License as published by
     7  *   the Free Software Foundation, either version 3 of the License, or
     8  *   (at your option) any later version.
     9  *
    10  *   This program is distributed in the hope that it will be useful,
    11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  *   GNU General Public License for more details.
    14  *
    15  *   You should have received a copy of the GNU General Public License
    16  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
    17  */
    18 
    19 package org.sonews.plugin;
    20 
    21 /**
    22  * A generic Plugin for sonews. Implementing classes do not really add new
    23  * functionality to sonews but can use this interface as convenient procedure
    24  * for installing functionality plugins, e.g. Command-Plugins or Storage-Plugins.
    25  * @author Christian Lins
    26  * @since sonews/1.1
    27  */
    28 public interface Plugin
    29 {
    30 
    31   /**
    32    * Called when the Plugin is loaded by sonews. This method can be used
    33    * by implementing classes to install additional or required plugins.
    34    */
    35   void load();
    36 
    37   /**
    38    * Called when the Plugin is unloaded by sonews.
    39    */
    40   void unload();
    41 
    42 }