01: /**
02: * Copyright (c) 2003-2007, David A. Czarnecki
03: * All rights reserved.
04: *
05: * Redistribution and use in source and binary forms, with or without
06: * modification, are permitted provided that the following conditions are met:
07: *
08: * Redistributions of source code must retain the above copyright notice, this list of conditions and the
09: * 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: */package org.blojsom.plugin.admin;
31:
32: import org.blojsom.blog.Blog;
33: import org.blojsom.blog.Entry;
34: import org.blojsom.plugin.PluginException;
35: import org.blojsom.util.BlojsomConstants;
36:
37: import javax.servlet.http.HttpServletRequest;
38: import javax.servlet.http.HttpServletResponse;
39: import java.util.Map;
40:
41: /**
42: * Web Admin Plugin
43: *
44: * @author David Czarnecki
45: * @since blojsom 3.0
46: * @version $Id: WebAdminPlugin.java,v 1.2 2007/01/17 02:35:05 czarneckid Exp $
47: */
48: public abstract class WebAdminPlugin extends BaseAdminPlugin {
49:
50: /**
51: * Return the display name for the plugin
52: *
53: * @return Display name for the plugin
54: */
55: public abstract String getDisplayName();
56:
57: /**
58: * Return the name of the initial editing page for the plugin
59: *
60: * @return Name of the initial editing page for the plugin
61: */
62: public abstract String getInitialPage();
63:
64: /**
65: * Process the blog entries
66: *
67: * @param httpServletRequest Request
68: * @param httpServletResponse Response
69: * @param blog {@link Blog} instance
70: * @param context Context
71: * @param entries Blog entries retrieved for the particular request
72: * @return Modified set of blog entries
73: * @throws PluginException If there is an error processing the blog entries
74: */
75: public Entry[] process(HttpServletRequest httpServletRequest,
76: HttpServletResponse httpServletResponse, Blog blog,
77: Map context, Entry[] entries) throws PluginException {
78: if (!authenticateUser(httpServletRequest, httpServletResponse,
79: context, blog)) {
80: httpServletRequest.setAttribute(
81: BlojsomConstants.PAGE_PARAM, ADMIN_LOGIN_PAGE);
82: } else {
83: httpServletRequest.setAttribute(
84: BlojsomConstants.PAGE_PARAM, getInitialPage());
85: }
86:
87: return entries;
88: }
89: }
|