KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jpublish > module > Module


1 /*--
2
3  Copyright (C) 2001-2003 Aetrion LLC.
4  All rights reserved.
5  
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions
8  are met:
9  
10  1. Redistributions of source code must retain the above copyright
11     notice, this list of conditions, and the following disclaimer.
12  
13  2. Redistributions in binary form must reproduce the above copyright
14     notice, this list of conditions, and the disclaimer that follows
15     these conditions in the documentation and/or other materials
16     provided with the distribution.
17
18  3. The name "JPublish" must not be used to endorse or promote products
19     derived from this software without prior written permission. For
20     written permission, please contact info@aetrion.com.
21  
22  4. Products derived from this software may not be called "JPublish", nor
23     may "JPublish" appear in their name, without prior written permission
24     from Aetrion LLC (info@aetrion.com).
25  
26  In addition, the authors of this software request (but do not require)
27  that you include in the end-user documentation provided with the
28  redistribution and/or in the software itself an acknowledgement equivalent
29  to the following:
30      "This product includes software developed by
31       Aetrion LLC (http://www.aetrion.com/)."
32
33  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
37  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
42  IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43  POSSIBILITY OF SUCH DAMAGE.
44
45  For more information on JPublish, please see <http://www.jpublish.org/>.
46  
47  */
48
49 package org.jpublish.module;
50
51 import java.util.Map JavaDoc;
52
53 import com.anthonyeden.lib.config.Configuration;
54 import org.jpublish.SiteContext;
55
56 /**
57  * Standard interface implement by pluggable JPublish modules. Modules have access to the SiteContext during the init()
58  * method. Module actions follow the same rules as other JPublish actions.
59  *
60  * <p>A JPublish module is essentially a collection of actions which are related in some fashion.</p>
61  *
62  * @author Anthony Eden
63  */
64
65 public interface Module {
66
67     /**
68      * Initialize the module. This corresponds with the Servlet.init() method, except that it includes a reference to
69      * the JPublish SiteContext.
70      *
71      * @param site The SiteContext
72      * @param configuration The configuration object
73      */
74
75     public void init(SiteContext site, Configuration configuration);
76
77     /**
78      * Get a map of defined actions.
79      *
80      * @return The defined actions
81      */
82
83     public Map JavaDoc getDefinedActions();
84
85     /**
86      * Invoked when the module is destroyed. This corresponds to the Servlet.destroy() method.
87      */
88
89     public void destroy();
90
91 }
92
Popular Tags