001: /**
002: * Copyright (c) 2003-2007, David A. Czarnecki
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions are met:
007: *
008: * Redistributions of source code must retain the above copyright notice, this list of conditions and the
009: * following disclaimer.
010: * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
011: * following disclaimer in the documentation and/or other materials provided with the distribution.
012: * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
013: * endorse or promote products derived from this software without specific prior written permission.
014: * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
015: * without prior written permission of David A. Czarnecki.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
018: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
019: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
020: * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
021: * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
022: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
023: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
024: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
025: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026: * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
027: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
028: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
029: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030: */package org.blojsom.plugin.permission;
031:
032: import org.blojsom.authorization.AuthorizationProvider;
033: import org.blojsom.blog.Blog;
034: import org.blojsom.blog.Entry;
035: import org.blojsom.plugin.Plugin;
036: import org.blojsom.plugin.PluginException;
037:
038: import javax.servlet.http.HttpServletRequest;
039: import javax.servlet.http.HttpServletResponse;
040: import java.util.Map;
041:
042: /**
043: * Permission Check plugin
044: *
045: * @author David Czarnecki
046: * @version $Id: PermissionCheckPlugin.java,v 1.3 2007/01/17 02:35:12 czarneckid Exp $
047: * @since blojsom 3.0
048: */
049: public class PermissionCheckPlugin implements Plugin {
050:
051: public static final String BLOJSOM_PERMISSION_CHECKER = "BLOJSOM_PERMISSION_CHECKER";
052:
053: private AuthorizationProvider _authorizationProvider;
054:
055: /**
056: * Create a new instance of the Permission Check plugin
057: */
058: public PermissionCheckPlugin() {
059: }
060:
061: /**
062: * Initialize this plugin. This method only called when the plugin is instantiated.
063: *
064: * @throws PluginException If there is an error initializing the plugin
065: */
066: public void init() throws PluginException {
067: }
068:
069: /**
070: * Set the {@link AuthorizationProvider}
071: *
072: * @param authorizationProvider {@link AuthorizationProvider}
073: */
074: public void setAuthorizationProvider(
075: AuthorizationProvider authorizationProvider) {
076: _authorizationProvider = authorizationProvider;
077: }
078:
079: /**
080: * Process the blog entries
081: *
082: * @param httpServletRequest Request
083: * @param httpServletResponse Response
084: * @param user {@link org.blojsom.blog.BlogUser} instance
085: * @param context Context
086: * @param entries Blog entries retrieved for the particular request
087: * @return Modified set of blog entries
088: * @throws PluginException If there is an error processing the blog entries
089: */
090: public Entry[] process(HttpServletRequest httpServletRequest,
091: HttpServletResponse httpServletResponse, Blog blog,
092: Map context, Entry[] entries) throws PluginException {
093: PermissionChecker permissionChecker = new PermissionChecker(
094: blog, _authorizationProvider, context);
095: context.put(BLOJSOM_PERMISSION_CHECKER, permissionChecker);
096:
097: return entries;
098: }
099:
100: /**
101: * Perform any cleanup for the plugin. Called after {@link #process}.
102: *
103: * @throws PluginException If there is an error performing cleanup for this plugin
104: */
105: public void cleanup() throws PluginException {
106: }
107:
108: /**
109: * Called when BlojsomServlet is taken out of service
110: *
111: * @throws PluginException If there is an error in finalizing this plugin
112: */
113: public void destroy() throws PluginException {
114: }
115: }
|