KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > meta > MetaPlugin


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.meta;
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
41 import javax.servlet.http.HttpServletRequest JavaDoc;
42 import javax.servlet.http.HttpServletResponse JavaDoc;
43 import java.io.BufferedReader JavaDoc;
44 import java.io.IOException JavaDoc;
45 import java.io.StringReader JavaDoc;
46 import java.util.HashMap JavaDoc;
47 import java.util.Map JavaDoc;
48
49 /**
50  * MetaPlugin
51  *
52  * @author David Czarnecki
53  * @version $Id: MetaPlugin.java,v 1.1 2006/03/20 21:30:57 czarneckid Exp $
54  * @since blojsom 3.0
55  */
56 public class MetaPlugin implements Plugin {
57
58     private Log _logger = LogFactory.getLog(MetaPlugin.class);
59
60     private String JavaDoc _metaPrefix = "meta-";
61
62     /**
63      * Default constructor
64      */
65     public MetaPlugin() {
66     }
67
68     /**
69      * Initialize this plugin. This method only called when the plugin is instantiated.
70      *
71      * @throws PluginException If there is an error initializing the plugin
72      */
73     public void init() throws PluginException {
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         String JavaDoc description;
89         Entry entry;
90         BufferedReader JavaDoc br;
91         StringReader JavaDoc sr;
92         String JavaDoc line;
93         StringBuffer JavaDoc noMetaDescription;
94
95         for (int i = 0; i < entries.length; i++) {
96             entry = entries[i];
97             description = entry.getDescription();
98             sr = new StringReader JavaDoc(description);
99             br = new BufferedReader JavaDoc(sr);
100
101             try {
102                 int equalIndex;
103                 String JavaDoc key;
104                 String JavaDoc value;
105                 Map JavaDoc metadata;
106                 noMetaDescription = new StringBuffer JavaDoc();
107
108                 while ((line = br.readLine()) != null) {
109                     if (line.trim().startsWith(_metaPrefix)) {
110                         equalIndex = line.indexOf("=", _metaPrefix.length());
111                         if (equalIndex != -1) {
112                             key = line.substring(_metaPrefix.length(), equalIndex);
113                             value = line.substring(equalIndex + 1);
114                             metadata = entry.getMetaData();
115                             if (metadata != null) {
116                                 metadata.put(key, value);
117                                 entry.setMetaData(metadata);
118                             } else {
119                                 metadata = new HashMap JavaDoc();
120                                 metadata.put(key, value);
121                                 entry.setMetaData(metadata);
122                             }
123                         } else {
124                             noMetaDescription.append(line).append(BlojsomUtils.LINE_SEPARATOR);
125                         }
126                     } else {
127                         noMetaDescription.append(line).append(BlojsomUtils.LINE_SEPARATOR);
128                     }
129                 }
130
131                 entry.setDescription(noMetaDescription.toString());
132             } catch (IOException JavaDoc e) {
133                 if (_logger.isErrorEnabled()) {
134                     _logger.error(e);
135                 }
136             }
137         }
138
139         return entries;
140     }
141
142     /**
143      * Perform any cleanup for the plugin. Called after {@link #process}.
144      *
145      * @throws PluginException If there is an error performing cleanup for this plugin
146      */
147     public void cleanup() throws PluginException {
148     }
149
150     /**
151      * Called when BlojsomServlet is taken out of service
152      *
153      * @throws PluginException If there is an error in finalizing this plugin
154      */
155     public void destroy() throws PluginException {
156     }
157 }
158
Popular Tags