View Javadoc

    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
    24  /**
    25   * Generic Action class.
    26   *
    27   * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
    28   * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a>
    29   * @version $Id: Action.java 1773378 2016-12-09 13:19:59Z tv $
    30   */
    31  public abstract class Action extends Assembler
    32  {
    33      /** Prefix for action related classes and templates */
    34      public static final String PREFIX = "actions";
    35
    36      /** Property for the size of the module cache if caching is on */
    37      public static final String CACHE_SIZE_KEY = "action.cache.size";
    38
    39      /** The default size for the action cache */
    40      public static final int CACHE_SIZE_DEFAULT = 20;
    41
    42      /** Represents Action Objects */
    43      public static final String NAME = "action";
    44
    45      /**
    46       * @see org.apache.turbine.modules.Assembler#getPrefix()
    47       */
    48      @Override
    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 {@link PipelineData}.
    57       *
    58       * @param pipelineData Turbine information.
    59       * @throws Exception a generic exception.
    60       */
    61      public abstract void doPerform(PipelineData pipelineData) throws Exception;
    62
    63      /**
    64       * Subclasses can override this method to add additional
    65       * functionality.  This method is protected to force clients to
    66       * use ActionLoader to perform an Action.
    67       *
    68       * @param pipelineData Turbine information.
    69       * @throws Exception a generic exception.
    70       */
    71      protected void perform(PipelineData pipelineData) throws Exception
    72      {
    73          doPerform(pipelineData);
    74      }
    75
    76
    77  }