01: /*
02: JSPWiki - a JSP-based WikiWiki clone.
03:
04: Copyright (C) 2001-2004 Janne Jalkanen (Janne.Jalkanen@iki.fi)
05:
06: This program is free software; you can redistribute it and/or modify
07: it under the terms of the GNU Lesser General Public License as published by
08: the Free Software Foundation; either version 2.1 of the License, or
09: (at your option) any later version.
10:
11: This program is distributed in the hope that it will be useful,
12: but WITHOUT ANY WARRANTY; without even the implied warranty of
13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: GNU Lesser General Public License for more details.
15:
16: You should have received a copy of the GNU Lesser General Public License
17: along with this program; if not, write to the Free Software
18: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19: */
20: package com.ecyrd.jspwiki.plugin;
21:
22: import com.ecyrd.jspwiki.WikiEngine;
23:
24: /**
25: * If a plugin defines this interface, it is called exactly once
26: * prior to the actual execute() routine. If the plugin has its
27: * own declaration in jspwiki_modules.xml, then it is called during
28: * startup - otherwise it is called the first time the plugin is
29: * encountered.
30: * <p>
31: * This method did not actually work until 2.5.30. The method signature
32: * has been changed in 2.6 to reflect the new operation.
33: *
34: * @since 2.2
35: *
36: * @author Janne Jalkanen
37: */
38: public interface InitializablePlugin {
39: /**
40: * Called whenever the plugin is being instantiated for
41: * the first time.
42: */
43:
44: public void initialize(WikiEngine engine) throws PluginException;
45: }
|