KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > common > StringUtilitiesPlugin


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.common;
32
33 import org.blojsom.blog.Blog;
34 import org.blojsom.blog.Entry;
35 import org.blojsom.plugin.Plugin;
36 import org.blojsom.plugin.PluginException;
37 import org.blojsom.util.BlojsomUtils;
38
39 import javax.servlet.http.HttpServletRequest JavaDoc;
40 import javax.servlet.http.HttpServletResponse JavaDoc;
41 import java.util.Map JavaDoc;
42
43 /**
44  * StringUtilities plugin
45  *
46  * @author David Czarnecki
47  * @version $Id: StringUtilitiesPlugin.java,v 1.1 2006/03/20 21:30:54 czarneckid Exp $
48  * @since blojsom 3.0
49  */
50 public class StringUtilitiesPlugin implements Plugin {
51
52     private static final String JavaDoc BLOJSOM_PLUGIN_STRING_UTILITIES = "BLOJSOM_PLUGIN_STRING_UTILITIES";
53
54     /**
55      * Construct a new StringUtilities plugin
56      */
57     public StringUtilitiesPlugin() {
58     }
59
60     /**
61      * Initialize this plugin. This method only called when the plugin is instantiated.
62      *
63      * @throws org.blojsom.plugin.PluginException
64      * If there is an error initializing the plugin
65      */
66     public void init() throws PluginException {
67     }
68
69     /**
70      * Process the blog entries
71      *
72      * @param httpServletRequest Request
73      * @param httpServletResponse Response
74      * @param blog {@link Blog} instance
75      * @param context Context
76      * @param entries Blog entries retrieved for the particular request
77      * @return Modified set of blog entries
78      * @throws PluginException If there is an error processing the blog entries
79      */
80     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest, HttpServletResponse JavaDoc httpServletResponse, Blog blog, Map JavaDoc context, Entry[] entries) throws PluginException {
81         context.put(BLOJSOM_PLUGIN_STRING_UTILITIES, new StringUtilities());
82
83         return entries;
84     }
85
86     /**
87      * Perform any cleanup for the plugin. Called after {@link #process}.
88      *
89      * @throws org.blojsom.plugin.PluginException
90      * If there is an error performing cleanup for this plugin
91      */
92     public void cleanup() throws PluginException {
93     }
94
95     /**
96      * Called when BlojsomServlet is taken out of service
97      *
98      * @throws org.blojsom.plugin.PluginException
99      * If there is an error in finalizing this plugin
100      */
101     public void destroy() throws PluginException {
102     }
103
104     /**
105      * Utility class for bundling string utility functions to make available to templates
106      */
107     public class StringUtilities {
108
109         /**
110          * Construct a new instance of StringUtilities
111          */
112         public StringUtilities() {
113         }
114
115         /**
116          * Return an escaped string where &, <, >, ", and ' are converted to their HTML equivalents
117          *
118          * @param input Unescaped string
119          * @return Escaped string containing HTML equivalents for &, <, >, ", and '
120          */
121         public String JavaDoc escapeString(String JavaDoc input) {
122             return BlojsomUtils.escapeString(input);
123         }
124     }
125 }
126
Popular Tags