KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > wiki > WikiPlugin


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.wiki;
32
33 import org.apache.commons.logging.Log;
34 import org.apache.commons.logging.LogFactory;
35 import org.blojsom.blog.Blog;
36 import org.blojsom.blog.Entry;
37 import org.blojsom.plugin.Plugin;
38 import org.blojsom.plugin.PluginException;
39 import org.blojsom.util.BlojsomUtils;
40 import org.radeox.EngineManager;
41 import org.radeox.api.engine.RenderEngine;
42 import org.radeox.api.engine.context.RenderContext;
43 import org.radeox.engine.context.BaseRenderContext;
44
45 import javax.servlet.http.HttpServletRequest JavaDoc;
46 import javax.servlet.http.HttpServletResponse JavaDoc;
47 import java.util.Map JavaDoc;
48
49 /**
50  * WikiPlugin
51  *
52  * @author David Czarnecki
53  * @version $Id: WikiPlugin.java,v 1.1 2006/03/23 06:53:18 czarneckid Exp $
54  * @since blojsom 3.0
55  */
56 public class WikiPlugin implements Plugin {
57
58     private Log _logger = LogFactory.getLog(WikiPlugin.class);
59
60     /**
61      * Entry extension of a Wiki post
62      */
63     private static final String JavaDoc WIKI_EXTENSION = ".wiki";
64
65     /**
66      * MetaData Key to identify a Wiki post
67      */
68     public static final String JavaDoc METADATA_RUN_WIKI = "run-wiki";
69
70     /**
71      * Initialize this plugin. This method only called when the plugin is instantiated.
72      *
73      * @throws PluginException If there is an error initializing the plugin
74      */
75     public void init() throws PluginException {
76     }
77
78     /**
79      * Process the blog entries
80      *
81      * @param httpServletRequest Request
82      * @param httpServletResponse Response
83      * @param blog {@link Blog} instance
84      * @param context Context
85      * @param entries Blog entries retrieved for the particular request
86      * @return Modified set of blog entries
87      * @throws PluginException If there is an error processing the blog entries
88      */
89     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest, HttpServletResponse JavaDoc httpServletResponse, Blog blog, Map JavaDoc context, Entry[] entries) throws PluginException {
90         RenderEngine engine = EngineManager.getInstance();
91         RenderContext renderContext = new BaseRenderContext();
92
93         for (int i = 0; i < entries.length; i++) {
94             Entry entry = entries[i];
95             if (entry.getPostSlug().endsWith(WIKI_EXTENSION) || BlojsomUtils.checkMapForKey(entry.getMetaData(), METADATA_RUN_WIKI)) {
96                 if (_logger.isDebugEnabled()) {
97                     _logger.debug("Wiki processing: " + entry.getId());
98                 }
99
100                 String JavaDoc description = entry.getDescription();
101                 entry.setDescription(engine.render(description, renderContext));
102             }
103         }
104
105         return entries;
106     }
107
108     /**
109      * Perform any cleanup for the plugin. Called after {@link #process}.
110      *
111      * @throws PluginException If there is an error performing cleanup for this plugin
112      */
113     public void cleanup() throws PluginException {
114     }
115
116     /**
117      * Called when BlojsomServlet is taken out of service
118      *
119      * @throws PluginException If there is an error in finalizing this plugin
120      */
121     public void destroy() throws PluginException {
122     }
123 }
124
Popular Tags