KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > Plugin


1 /**
2  * Copyright (c) 2003-2006, David A. Czarnecki
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * Redistributions of source code must retain the above copyright notice, this list of conditions and the
9  * following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
11  * following disclaimer in the documentation and/or other materials provided with the distribution.
12  * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
13  * endorse or promote products derived from this software without specific prior written permission.
14  * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
15  * without prior written permission of David A. Czarnecki.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
18  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
19  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21  * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 package org.blojsom.plugin;
32
33 import org.blojsom.blog.Blog;
34 import org.blojsom.blog.Entry;
35
36 import javax.servlet.http.HttpServletRequest JavaDoc;
37 import javax.servlet.http.HttpServletResponse JavaDoc;
38 import java.util.Map JavaDoc;
39
40 /**
41  * Plugin
42  *
43  * @author David Czarnecki
44  * @since blojsom 3.0
45  * @version $Id: Plugin.java,v 1.1 2006/03/20 21:31:16 czarneckid Exp $
46  */
47 public interface Plugin {
48
49     /**
50      * Initialize this plugin. This method only called when the plugin is instantiated.
51      *
52      * @throws PluginException If there is an error initializing the plugin
53      */
54     public void init() throws PluginException;
55
56     /**
57      * Process the blog entries
58      *
59      * @param httpServletRequest Request
60      * @param httpServletResponse Response
61      * @param blog {@link Blog} instance
62      * @param context Context
63      * @param entries Blog entries retrieved for the particular request
64      * @return Modified set of blog entries
65      * @throws PluginException If there is an error processing the blog entries
66      */
67     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest, HttpServletResponse JavaDoc httpServletResponse, Blog blog, Map JavaDoc context, Entry[] entries) throws PluginException;
68
69     /**
70      * Perform any cleanup for the plugin. Called after {@link #process}.
71      *
72      * @throws PluginException If there is an error performing cleanup for this plugin
73      */
74     public void cleanup() throws PluginException;
75
76     /**
77      * Called when BlojsomServlet is taken out of service
78      *
79      * @throws PluginException If there is an error in finalizing this plugin
80      */
81     public void destroy() throws PluginException;
82 }
83
Popular Tags