View Javadoc

1   package org.apache.turbine.modules.layouts;
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.modules.Layout;
23  import org.apache.turbine.util.RunData;
24  import org.apache.turbine.util.TurbineException;
25  
26  /***
27   * This layout allows an action to manipulate the ServletOutputStream directly.
28   * It requires that data.declareDirectResponse() has been called to indicate
29   * that the OutputStream is being handled elsewhere.
30   *
31   * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a>
32   * @version $Id: DirectResponseLayout.java 534527 2007-05-02 16:10:59Z tv $
33   */
34  public class DirectResponseLayout extends Layout
35  {
36      /***
37       * Ensures that a direct response has been declared.
38       *
39       * @param data Turbine information.
40       * @exception TurbineException if a direct response has not been declared.
41       */
42      public void doBuild(RunData data)
43          throws Exception
44      {
45          if (!data.isOutSet())
46          {
47              throw new TurbineException(
48                  "data.declareDirectResponse() has not been called");
49          }
50      }
51  
52  }