View Javadoc
1   /*
2    * $Id$
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  package org.apache.struts.chain.commands;
22  
23  import org.apache.struts.chain.contexts.ActionContext;
24  import org.apache.struts.config.ModuleConfig;
25  
26  /**
27   * <p>Check to see if the controller is configured to prevent caching, and if
28   * so, request no cache flags to be set.</p>
29   *
30   * @version $Rev$ $Date: 2005-06-04 10:58:46 -0400 (Sat, 04 Jun 2005)
31   *          $
32   */
33  public abstract class AbstractRequestNoCache extends ActionCommandBase {
34      // ---------------------------------------------------------- Public Methods
35  
36      /**
37       * <p>Check to see if the controller is configured to prevent caching, and
38       * if so, request no cache flags to be set.</p>
39       *
40       * @param actionCtx The <code>Context</code> for the current request
41       * @return <code>false</code> so that processing continues
42       * @throws Exception if thrown by the Action class
43       */
44      @Override
45      protected boolean execute_(ActionContext actionCtx)
46          throws Exception {
47          // Retrieve the ModuleConfig instance
48          ModuleConfig moduleConfig = actionCtx.getModuleConfig();
49  
50          // If the module is configured for no caching, request no caching
51          if (moduleConfig.getControllerConfig().getNocache()) {
52              requestNoCache(actionCtx);
53          }
54  
55          return CONTINUE_PROCESSING;
56      }
57  
58      // ------------------------------------------------------- Protected Methods
59  
60      /**
61       * <p>Request no cache flags are set.</p>
62       *
63       * @param context The <code>Context</code> for this request
64       */
65      protected abstract void requestNoCache(ActionContext context);
66  }