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.tools;
031:
032: import org.apache.velocity.tools.generic.RenderTool;
033: import org.blojsom.blog.Blog;
034: import org.blojsom.blog.Entry;
035: import org.blojsom.plugin.Plugin;
036: import org.blojsom.plugin.PluginException;
037:
038: import javax.servlet.http.HttpServletRequest;
039: import javax.servlet.http.HttpServletResponse;
040: import java.util.Map;
041:
042: /**
043: * Render Tool plugin
044: *
045: * @author Chris Phillipson
046: * @version $Id: RenderToolPlugin.java,v 1.2 2007/01/17 02:35:06 czarneckid Exp $
047: * @since blojsom 3.0
048: */
049: public class RenderToolPlugin implements Plugin {
050:
051: private static final String BLOJSOM_PLUGIN_RENDER_TOOL = "BLOJSOM_PLUGIN_RENDER_TOOL";
052:
053: /**
054: * Default constructor.
055: */
056: public RenderToolPlugin() {
057: }
058:
059: /**
060: * Initialize this plugin. This method only called when the plugin is instantiated.
061: *
062: * @throws org.blojsom.plugin.PluginException
063: * If there is an error initializing the plugin
064: */
065: public void init() throws PluginException {
066: }
067:
068: /**
069: * Process the blog entries
070: *
071: * @param httpServletRequest Request
072: * @param httpServletResponse Response
073: * @param blog {@link Blog} instance
074: * @param context Context
075: * @param entries Blog entries retrieved for the particular request
076: * @return Modified set of blog entries
077: * @throws PluginException If there is an error processing the blog entries
078: */
079: public Entry[] process(HttpServletRequest httpServletRequest,
080: HttpServletResponse httpServletResponse, Blog blog,
081: Map context, Entry[] entries) throws PluginException {
082: context.put(BLOJSOM_PLUGIN_RENDER_TOOL, new RenderTool());
083:
084: return entries;
085: }
086:
087: /**
088: * Perform any cleanup for the plugin. Called after {@link #process}.
089: *
090: * @throws org.blojsom.plugin.PluginException
091: * If there is an error performing cleanup for this plugin
092: */
093: public void cleanup() throws PluginException {
094: }
095:
096: /**
097: * Called when BlojsomServlet is taken out of service
098: *
099: * @throws org.blojsom.plugin.PluginException
100: * If there is an error in finalizing this plugin
101: */
102: public void destroy() throws PluginException {
103: }
104: }
|