View Javadoc
1 package org.apache.turbine.modules.actions; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 import org.apache.turbine.util.RunData; 58 59 import org.apache.velocity.context.Context; 60 61 /*** 62 * VelocitySecure action. 63 * 64 * Always performs a Security Check that you've defined before 65 * executing the doBuildtemplate(). You should extend this class and 66 * add the specific security check needed. If you have a number of 67 * screens that need to perform the same check, you could make a base 68 * screen by extending this class and implementing the isAuthorized(). 69 * Then each action that needs to perform the same check could extend 70 * your base action. 71 * 72 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a> 73 * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a> 74 * @author <a href="mailto:jvanzyl@periapt.com">Jason van Zyl</a> 75 * @version $Id: VelocitySecureAction.java,v 1.1.1.1 2001/08/16 05:08:31 jvanzyl Exp $ 76 */ 77 public abstract class VelocitySecureAction extends VelocityAction 78 { 79 /*** 80 * Implement this to add information to the context. 81 * 82 * @param data Turbine information. 83 * @param context Context for web pages. 84 * @exception Exception, a generic exception. 85 */ 86 public abstract void doPerform( RunData data, Context context ) 87 throws Exception; 88 89 /*** 90 * This method overrides the method in WebMacroSiteAction to 91 * perform a security check first. 92 * 93 * @param data Turbine information. 94 * @exception Exception, a generic exception. 95 */ 96 protected void perform( RunData data ) throws Exception 97 { 98 if ( isAuthorized( data ) ) 99 { 100 super.perform(data); 101 } 102 } 103 104 /*** 105 * Implement this method to perform the security check needed. 106 * You should set the template in this method that you want the 107 * user to be sent to if they're unauthorized. See the 108 * WebMacroSecurityCheck utility. 109 * 110 * @param data Turbine information. 111 * @return True if the user is authorized to access the screen. 112 * @exception Exception, a generic exception. 113 */ 114 protected abstract boolean isAuthorized( RunData data ) 115 throws Exception; 116 }

This page was automatically generated by Maven