View Javadoc

1   package org.apache.turbine.modules.screens;
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.Turbine;
23  import org.apache.turbine.TurbineConstants;
24  
25  import org.apache.turbine.pipeline.PipelineData;
26  import org.apache.turbine.util.RunData;
27  
28  import org.apache.velocity.context.Context;
29  
30  /**
31   * VelocityErrorScreen screen - directs errors at the velocity
32   * error template defined in template.error.
33   *
34   * @author <a href="mailto:gonzalo.diethelm@sonda.com">Gonzalo Diethelm</a>
35   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
36   * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a>
37   * @version $Id: VelocityErrorScreen.java 938645 2010-04-27 20:57:51Z tv $
38   */
39  public class VelocityErrorScreen
40      extends VelocityScreen
41  {
42      /**
43       * Implement this to add information to the context.
44       *
45       * @deprecated Use PipelineData version instead.
46       * @param data Turbine information.
47       * @param context Context for web pages.
48       * @exception Exception a generic exception.
49       */
50      protected void doBuildTemplate(RunData data, Context context)
51              throws Exception
52      {
53          context.put (TurbineConstants.PROCESSING_EXCEPTION_PLACEHOLDER,
54                       data.getStackTraceException().toString());
55          context.put (TurbineConstants.STACK_TRACE_PLACEHOLDER,
56                       data.getStackTrace());
57  
58          String errorTemplate = Turbine.getConfiguration()
59              .getString(TurbineConstants.TEMPLATE_ERROR_KEY,
60                         TurbineConstants.TEMPLATE_ERROR_VM);
61  
62          setTemplate(data, errorTemplate);
63      }
64  
65      /**
66       * Implement this to add information to the context.
67       *
68       * @param pipelineData Turbine information.
69       * @param context Context for web pages.
70       * @exception Exception a generic exception.
71       */
72      protected void doBuildTemplate(PipelineData pipelineData, Context context)
73              throws Exception
74      {
75          RunData data = getRunData(pipelineData);
76          doBuildTemplate(data);
77      }
78  
79  
80  }