View Javadoc

1   /*
2    * $Id: AbstractSetContentType.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 content type is set, and if so, set it for this
25   * response.</p>
26   *
27   * @version $Rev: 421119 $ $Date: 2005-11-12 13:01:44 -0500 (Sat, 12 Nov 2005)
28   *          $
29   */
30  public abstract class AbstractSetContentType extends ActionCommandBase {
31      // ---------------------------------------------------------- Public Methods
32  
33      /***
34       * <p>Check to see if the content type is set, and if so, set it for this
35       * response.</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 content type is configured, set it for the response
47          String contentType =
48              moduleConfig.getControllerConfig().getContentType();
49  
50          if (contentType != null) {
51              setContentType(actionCtx, contentType);
52          }
53  
54          return (false);
55      }
56  
57      // ------------------------------------------------------- Protected Methods
58  
59      /***
60       * <p>Request no cache flags are set.</p>
61       *
62       * @param context     The <code>Context</code> for this request
63       * @param contentType The content type for the response
64       */
65      protected abstract void setContentType(ActionContext context,
66          String contentType);
67  }