KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > pingback > RecentPingbacksPlugin


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.pingback;
32
33 import org.blojsom.plugin.Plugin;
34 import org.blojsom.plugin.PluginException;
35 import org.blojsom.blog.Blog;
36 import org.blojsom.blog.Entry;
37 import org.blojsom.fetcher.Fetcher;
38 import org.blojsom.fetcher.FetcherException;
39 import org.apache.commons.logging.Log;
40 import org.apache.commons.logging.LogFactory;
41
42 import javax.servlet.http.HttpServletRequest JavaDoc;
43 import javax.servlet.http.HttpServletResponse JavaDoc;
44 import java.util.Map JavaDoc;
45
46 /**
47  * Recent Pingbacks plugin
48  *
49  * @author David Czarnecki
50  * @since blojsom 3.0
51  * @version $Id: RecentPingbacksPlugin.java,v 1.1 2006/03/28 04:30:48 czarneckid Exp $
52  */

53 public class RecentPingbacksPlugin implements Plugin {
54
55     private Log _logger = LogFactory.getLog(RecentPingbacksPlugin.class);
56
57     private static final String JavaDoc BLOJSOM_PLUGIN_RECENT_PINGBACKS = "BLOJSOM_PLUGIN_RECENT_PINGBACKS";
58
59     private Fetcher _fetcher;
60
61     /**
62      * Create a new instance of the Recent Comments plugin
63      */

64     public RecentPingbacksPlugin() {
65     }
66
67     /**
68      * Set the {@link Fetcher}
69      *
70      * @param fetcher {@link Fetcher}
71      */

72     public void setFetcher(Fetcher fetcher) {
73         _fetcher = fetcher;
74     }
75
76     /**
77      * Initialize this plugin. This method only called when the plugin is instantiated.
78      *
79      * @throws PluginException If there is an error initializing the plugin
80      */

81     public void init() throws PluginException {
82     }
83
84     /**
85      * Process the blog entries
86      *
87      * @param httpServletRequest Request
88      * @param httpServletResponse Response
89      * @param blog {@link Blog} instance
90      * @param context Context
91      * @param entries Blog entries retrieved for the particular request
92      * @return Modified set of blog entries
93      * @throws PluginException If there is an error processing the blog entries
94      */

95     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest, HttpServletResponse JavaDoc httpServletResponse, Blog blog, Map JavaDoc context, Entry[] entries) throws PluginException {
96         try {
97             context.put(BLOJSOM_PLUGIN_RECENT_PINGBACKS, _fetcher.loadRecentPingbacks(blog));
98         } catch (FetcherException e) {
99             if (_logger.isErrorEnabled()) {
100                 _logger.error(e);
101             }
102         }
103
104         return entries;
105     }
106
107     /**
108      * Perform any cleanup for the plugin. Called after {@link #process}.
109      *
110      * @throws PluginException If there is an error performing cleanup for this plugin
111      */

112     public void cleanup() throws PluginException {
113     }
114
115     /**
116      * Called when BlojsomServlet is taken out of service
117      *
118      * @throws PluginException If there is an error in finalizing this plugin
119      */

120     public void destroy() throws PluginException {
121     }
122 }
123
Popular Tags