KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > textile > TextilePlugin


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.textile;
32
33 import net.sf.textile4j.Textile;
34 import org.apache.commons.logging.Log;
35 import org.apache.commons.logging.LogFactory;
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 import org.blojsom.util.BlojsomUtils;
41
42 import javax.servlet.http.HttpServletRequest JavaDoc;
43 import javax.servlet.http.HttpServletResponse JavaDoc;
44 import java.util.Map JavaDoc;
45
46 /**
47  * Textile Plugin
48  *
49  * An implementation of the Textism's Textile. See http://www.textism.com/tools/textile
50  *
51  * @author David Czarnecki
52  * @author Mark Lussier
53  * @since blojsom 3.0
54  * @version $Id: TextilePlugin.java,v 1.2 2006/03/20 22:51:04 czarneckid Exp $
55  */

56 public class TextilePlugin implements Plugin {
57
58     private static final String JavaDoc PLUGIN_TEXTILE_PROCESS_ALL_ENTRIES = "plugin-textile-process-all-entries";
59
60     /**
61      * MetaData Key to identify a Textile post
62      */

63     public static final String JavaDoc METADATA_RUN_TEXTILE = "run-textile";
64
65     /**
66      * Extension of Textile Post
67      */

68     public static final String JavaDoc TEXTILE_EXTENSION = ".textile";
69
70     /**
71      * Textile Instance
72      */

73     private Textile _textile;
74
75     /**
76      * Logger instance
77      */

78     private Log _logger = LogFactory.getLog(TextilePlugin.class);
79
80     /**
81      * Initialize this plugin. This method only called when the plugin is instantiated.
82      *
83      * @throws PluginException If there is an error initializing the plugin
84      */

85     public void init() throws PluginException {
86         _textile = new Textile();
87     }
88
89     /**
90      * Process the blog entries
91      *
92      * @param httpServletRequest Request
93      * @param httpServletResponse Response
94      * @param blog {@link Blog} instance
95      * @param context Context
96      * @param entries Blog entries retrieved for the particular request
97      * @return Modified set of blog entries
98      * @throws PluginException If there is an error processing the blog entries
99      */

100     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest,
101                                HttpServletResponse JavaDoc httpServletResponse,
102                                Blog blog,
103                                Map JavaDoc context,
104                                Entry[] entries) throws PluginException {
105         for (int x = 0; x < entries.length; x++) {
106             Entry entry = entries[x];
107             if (entry.getPostSlug().endsWith(TEXTILE_EXTENSION) || BlojsomUtils.checkMapForKey(entry.getMetaData(), METADATA_RUN_TEXTILE)
108                     || Boolean.valueOf(blog.getProperty(PLUGIN_TEXTILE_PROCESS_ALL_ENTRIES)).booleanValue()) {
109                 if (_logger.isDebugEnabled()) {
110                     _logger.debug("Textile processing: " + entry.getId());
111                 }
112                 entry.setDescription(_textile.process(entry.getDescription()));
113             }
114         }
115
116         return entries;
117     }
118
119     /**
120      * Perform any cleanup for the plugin. Called after {@link #process}.
121      *
122      * @throws PluginException If there is an error performing cleanup for this plugin
123      */

124     public void cleanup() throws PluginException {
125     }
126
127     /**
128      * Called when BlojsomServlet is taken out of service
129      *
130      * @throws PluginException If there is an error in finalizing this plugin
131      */

132     public void destroy() throws PluginException {
133     }
134 }
135
Popular Tags