KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > tools > ImportToolPlugin


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.tools;
32
33 import org.apache.commons.logging.Log;
34 import org.apache.commons.logging.LogFactory;
35 import org.apache.velocity.tools.view.tools.ImportTool;
36 import org.blojsom.blog.Blog;
37 import org.blojsom.blog.Entry;
38 import org.blojsom.plugin.Plugin;
39 import org.blojsom.plugin.PluginException;
40
41 import javax.servlet.http.HttpServletRequest JavaDoc;
42 import javax.servlet.http.HttpServletResponse JavaDoc;
43 import java.util.Map JavaDoc;
44
45 /**
46  * Import Tool plugin
47  *
48  * @author David Czarnecki
49  * @since blojsom 3.0
50  * @version $Id: ImportToolPlugin.java,v 1.1 2006/03/23 06:48:01 czarneckid Exp $
51  */
52 public class ImportToolPlugin implements Plugin {
53
54     private Log _logger = LogFactory.getLog(ImportToolPlugin.class);
55
56     private static final String JavaDoc BLOJSOM_PLUGIN_IMPORT_TOOL = "BLOJSOM_PLUGIN_IMPORT_TOOL";
57
58     /**
59      * Default constructor.
60      */
61     public ImportToolPlugin() {
62     }
63
64     /**
65      * Initialize this plugin. This method only called when the plugin is instantiated.
66      *
67      * @param servletConfig Servlet config object for the plugin to retrieve any initialization parameters
68      * @param blojsomConfiguration {@link org.blojsom.blog.BlojsomConfiguration} information
69      * @throws org.blojsom.plugin.PluginException
70      * If there is an error initializing the plugin
71      */
72     public void init() throws PluginException {
73         _logger.debug("Initialized Import Tool plugin");
74     }
75
76     /**
77      * Process the blog entries
78      *
79      * @param httpServletRequest Request
80      * @param httpServletResponse Response
81      * @param blog {@link Blog} instance
82      * @param context Context
83      * @param entries Blog entries retrieved for the particular request
84      * @return Modified set of blog entries
85      * @throws PluginException If there is an error processing the blog entries
86      */
87     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest, HttpServletResponse JavaDoc httpServletResponse, Blog blog, Map JavaDoc context, Entry[] entries) throws PluginException {
88         context.put(BLOJSOM_PLUGIN_IMPORT_TOOL, new ImportTool());
89
90         return entries;
91     }
92
93     /**
94      * Perform any cleanup for the plugin. Called after {@link #process}.
95      *
96      * @throws org.blojsom.plugin.PluginException
97      * If there is an error performing cleanup for this plugin
98      */
99     public void cleanup() throws PluginException {
100     }
101
102     /**
103      * Called when BlojsomServlet is taken out of service
104      *
105      * @throws org.blojsom.plugin.PluginException
106      * If there is an error in finalizing this plugin
107      */
108     public void destroy() throws PluginException {
109     }
110 }
Popular Tags