001: /**
002: * Copyright (c) 2003-2007, David A. Czarnecki
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions are met:
007: *
008: * Redistributions of source code must retain the above copyright notice, this list of conditions and the
009: * following disclaimer.
010: * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
011: * following disclaimer in the documentation and/or other materials provided with the distribution.
012: * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
013: * endorse or promote products derived from this software without specific prior written permission.
014: * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
015: * without prior written permission of David A. Czarnecki.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
018: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
019: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
020: * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
021: * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
022: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
023: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
024: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
025: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026: * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
027: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
028: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
029: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030: */package org.blojsom.plugin.comment;
031:
032: import org.blojsom.plugin.Plugin;
033: import org.blojsom.plugin.PluginException;
034: import org.blojsom.blog.Blog;
035: import org.blojsom.blog.Entry;
036: import org.blojsom.fetcher.Fetcher;
037: import org.blojsom.fetcher.FetcherException;
038: import org.apache.commons.logging.Log;
039: import org.apache.commons.logging.LogFactory;
040:
041: import javax.servlet.http.HttpServletRequest;
042: import javax.servlet.http.HttpServletResponse;
043: import java.util.Map;
044:
045: /**
046: * Recent Comments plugin
047: *
048: * @author David Czarnecki
049: * @since blojsom 3.0
050: * @version $Id: RecentCommentsPlugin.java,v 1.2 2007/01/17 02:35:08 czarneckid Exp $
051: */
052: public class RecentCommentsPlugin implements Plugin {
053:
054: private Log _logger = LogFactory.getLog(RecentCommentsPlugin.class);
055:
056: private static final String BLOJSOM_PLUGIN_RECENT_COMMENTS = "BLOJSOM_PLUGIN_RECENT_COMMENTS";
057:
058: private Fetcher _fetcher;
059:
060: /**
061: * Create a new instance of the Recent Comments plugin
062: */
063: public RecentCommentsPlugin() {
064: }
065:
066: /**
067: * Set the {@link Fetcher}
068: *
069: * @param fetcher {@link Fetcher}
070: */
071: public void setFetcher(Fetcher fetcher) {
072: _fetcher = fetcher;
073: }
074:
075: /**
076: * Initialize this plugin. This method only called when the plugin is instantiated.
077: *
078: * @throws PluginException If there is an error initializing the plugin
079: */
080: public void init() throws PluginException {
081: }
082:
083: /**
084: * Process the blog entries
085: *
086: * @param httpServletRequest Request
087: * @param httpServletResponse Response
088: * @param blog {@link Blog} instance
089: * @param context Context
090: * @param entries Blog entries retrieved for the particular request
091: * @return Modified set of blog entries
092: * @throws PluginException If there is an error processing the blog entries
093: */
094: public Entry[] process(HttpServletRequest httpServletRequest,
095: HttpServletResponse httpServletResponse, Blog blog,
096: Map context, Entry[] entries) throws PluginException {
097: try {
098: context.put(BLOJSOM_PLUGIN_RECENT_COMMENTS, _fetcher
099: .loadRecentComments(blog));
100: } catch (FetcherException e) {
101: if (_logger.isErrorEnabled()) {
102: _logger.error(e);
103: }
104: }
105:
106: return entries;
107: }
108:
109: /**
110: * Perform any cleanup for the plugin. Called after {@link #process}.
111: *
112: * @throws PluginException If there is an error performing cleanup for this plugin
113: */
114: public void cleanup() throws PluginException {
115: }
116:
117: /**
118: * Called when BlojsomServlet is taken out of service
119: *
120: * @throws PluginException If there is an error in finalizing this plugin
121: */
122: public void destroy() throws PluginException {
123: }
124: }
|