KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > admin > WebAdminPlugin


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.admin;
32
33 import org.blojsom.blog.Blog;
34 import org.blojsom.blog.Entry;
35 import org.blojsom.plugin.PluginException;
36 import org.blojsom.util.BlojsomConstants;
37
38 import javax.servlet.http.HttpServletRequest JavaDoc;
39 import javax.servlet.http.HttpServletResponse JavaDoc;
40 import java.util.Map JavaDoc;
41
42 /**
43  * Web Admin Plugin
44  *
45  * @author David Czarnecki
46  * @since blojsom 3.0
47  * @version $Id: WebAdminPlugin.java,v 1.1 2006/03/20 21:30:44 czarneckid Exp $
48  */
49 public abstract class WebAdminPlugin extends BaseAdminPlugin {
50
51     /**
52      * Return the display name for the plugin
53      *
54      * @return Display name for the plugin
55      */
56     public abstract String JavaDoc getDisplayName();
57
58     /**
59      * Return the name of the initial editing page for the plugin
60      *
61      * @return Name of the initial editing page for the plugin
62      */
63     public abstract String JavaDoc getInitialPage();
64
65     /**
66      * Process the blog entries
67      *
68      * @param httpServletRequest Request
69      * @param httpServletResponse Response
70      * @param blog {@link Blog} instance
71      * @param context Context
72      * @param entries Blog entries retrieved for the particular request
73      * @return Modified set of blog entries
74      * @throws PluginException If there is an error processing the blog entries
75      */
76     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest, HttpServletResponse JavaDoc httpServletResponse, Blog blog, Map JavaDoc context, Entry[] entries) throws PluginException {
77         if (!authenticateUser(httpServletRequest, httpServletResponse, context, blog)) {
78             httpServletRequest.setAttribute(BlojsomConstants.PAGE_PARAM, ADMIN_LOGIN_PAGE);
79         } else {
80             httpServletRequest.setAttribute(BlojsomConstants.PAGE_PARAM, getInitialPage());
81         }
82
83         return entries;
84     }
85 }
Popular Tags