View Javadoc

1   /*
2    * $Id: AbstractRequestNoCache.java 421119 2006-07-12 04:49:11Z wsmoak $
3    *
4    * Copyright 2003-2005 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *      http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.struts.chain.commands;
19  
20  import org.apache.struts.chain.contexts.ActionContext;
21  import org.apache.struts.config.ModuleConfig;
22  
23  /***
24   * <p>Check to see if the controller is configured to prevent caching, and if
25   * so, request no cache flags to be set.</p>
26   *
27   * @version $Rev: 421119 $ $Date: 2005-06-04 10:58:46 -0400 (Sat, 04 Jun 2005)
28   *          $
29   */
30  public abstract class AbstractRequestNoCache extends ActionCommandBase {
31      // ---------------------------------------------------------- Public Methods
32  
33      /***
34       * <p>Check to see if the controller is configured to prevent caching, and
35       * if so, request no cache flags to be set.</p>
36       *
37       * @param actionCtx The <code>Context</code> for the current request
38       * @return <code>false</code> so that processing continues
39       * @throws Exception if thrown by the Action class
40       */
41      public boolean execute(ActionContext actionCtx)
42          throws Exception {
43          // Retrieve the ModuleConfig instance
44          ModuleConfig moduleConfig = actionCtx.getModuleConfig();
45  
46          // If the module is configured for no caching, request no caching
47          if (moduleConfig.getControllerConfig().getNocache()) {
48              requestNoCache(actionCtx);
49          }
50  
51          return (false);
52      }
53  
54      // ------------------------------------------------------- Protected Methods
55  
56      /***
57       * <p>Request no cache flags are set.</p>
58       *
59       * @param context The <code>Context</code> for this request
60       */
61      protected abstract void requestNoCache(ActionContext context);
62  }