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