1 package org.apache.turbine.modules; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import org.apache.turbine.pipeline.PipelineData; 23 import org.apache.turbine.util.RunData; 24 25 /** 26 * Generic Action class. 27 * 28 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a> 29 * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a> 30 * @version $Id: Action.java 717934 2008-11-15 21:48:47Z tv $ 31 */ 32 public abstract class Action extends Assembler 33 { 34 /** Prefix for action related classes and templates */ 35 public static final String PREFIX = "actions"; 36 37 /** Property for the size of the module cache if caching is on */ 38 public static final String CACHE_SIZE_KEY = "action.cache.size"; 39 40 /** The default size for the action cache */ 41 public static final int CACHE_SIZE_DEFAULT = 20; 42 43 /** Represents Action Objects */ 44 public static final String NAME = "action"; 45 46 /** 47 * @see org.apache.turbine.modules.Assembler#getPrefix() 48 */ 49 public String getPrefix() 50 { 51 return PREFIX; 52 } 53 54 /** 55 * A subclass must override this method to perform itself. The 56 * Action can also set the screen that is associated with RunData. 57 * 58 * @deprecated Use PipelineData version instead. 59 * @param data Turbine information. 60 * @exception Exception a generic exception. 61 */ 62 public abstract void doPerform(RunData data) throws Exception; 63 64 /** 65 * Subclasses can override this method to add additional 66 * functionality. This method is protected to force clients to 67 * use ActionLoader to perform an Action. 68 * @deprecated Use PipelineData version instead. 69 * @param data Turbine information. 70 * @exception Exception a generic exception. 71 */ 72 protected void perform(RunData data) throws Exception 73 { 74 doPerform(data); 75 } 76 77 /** 78 * A subclass must override this method to perform itself. The 79 * Action can also set the screen that is associated with RunData. 80 * 81 * @param data Turbine information. 82 * @exception Exception a generic exception. 83 */ 84 public void doPerform(PipelineData pipelineData) throws Exception 85 { 86 RunData data = getRunData(pipelineData); 87 doPerform(data); 88 } 89 90 /** 91 * Subclasses can override this method to add additional 92 * functionality. This method is protected to force clients to 93 * use ActionLoader to perform an Action. 94 * 95 * @param data Turbine information. 96 * @exception Exception a generic exception. 97 */ 98 protected void perform(PipelineData pipelineData) throws Exception 99 { 100 doPerform(pipelineData); 101 } 102 103 104 }