1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/org/sonews/plugin/Plugin.java Tue Apr 27 21:51:12 2010 +0200
1.3 @@ -0,0 +1,42 @@
1.4 +/*
1.5 + * SONEWS News Server
1.6 + * see AUTHORS for the list of contributors
1.7 + *
1.8 + * This program is free software: you can redistribute it and/or modify
1.9 + * it under the terms of the GNU General Public License as published by
1.10 + * the Free Software Foundation, either version 3 of the License, or
1.11 + * (at your option) any later version.
1.12 + *
1.13 + * This program is distributed in the hope that it will be useful,
1.14 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
1.15 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1.16 + * GNU General Public License for more details.
1.17 + *
1.18 + * You should have received a copy of the GNU General Public License
1.19 + * along with this program. If not, see <http://www.gnu.org/licenses/>.
1.20 + */
1.21 +
1.22 +package org.sonews.plugin;
1.23 +
1.24 +/**
1.25 + * A generic Plugin for sonews. Implementing classes do not really add new
1.26 + * functionality to sonews but can use this interface as convenient procedure
1.27 + * for installing functionality plugins, e.g. Command-Plugins or Storage-Plugins.
1.28 + * @author Christian Lins
1.29 + * @since sonews/1.1
1.30 + */
1.31 +public interface Plugin
1.32 +{
1.33 +
1.34 + /**
1.35 + * Called when the Plugin is loaded by sonews. This method can be used
1.36 + * by implementing classes to install additional or required plugins.
1.37 + */
1.38 + void load();
1.39 +
1.40 + /**
1.41 + * Called when the Plugin is unloaded by sonews.
1.42 + */
1.43 + void unload();
1.44 +
1.45 +}