1 package org.apache.turbine.modules.navigations;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution,
22 * if any, must include the following acknowledgment:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgment may appear in the software itself,
26 * if and wherever such third-party acknowledgments normally appear.
27 *
28 * 4. The names "Apache" and "Apache Software Foundation" and
29 * "Apache Turbine" must not be used to endorse or promote products
30 * derived from this software without prior written permission. For
31 * written permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache",
34 * "Apache Turbine", nor may "Apache" appear in their name, without
35 * prior written permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57 // ECS Classes
58 import org.apache.ecs.ConcreteElement;
59
60 // Turbine Classes
61 import org.apache.turbine.services.jsp.JspService;
62 import org.apache.turbine.services.TurbineServices;
63 import org.apache.turbine.util.RunData;
64
65
66 /***
67 * Base JSP navigation that should be subclassed by Navigation that want to
68 * use JSP. Subclasses should override the doBuildTemplate() method.
69 *
70 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
71 */
72 public class BaseJspNavigation extends TemplateNavigation
73 {
74 /***
75 * Method that sets up beans and forward the request to the JSP.
76 *
77 * @param RunData
78 * @return null - the JSP sends the information
79 */
80 public ConcreteElement buildTemplate( RunData data ) throws Exception
81 {
82 // set up any data in beans, etc
83 doBuildTemplate( data );
84
85 // get the name of the JSP we want to use
86 String templateName = data.getTemplateInfo().getNavigationTemplate();
87
88 // navigations are used by a layout
89 JspService jsp = (JspService)
90 TurbineServices.getInstance().getService(JspService.SERVICE_NAME);
91 jsp.handleRequest(data, "/navigations/" + templateName);
92
93 return null;
94 }
95
96 /***
97 * Method to be overidden by subclasses to include data in beans, etc.
98 *
99 * @param data, the Rundata object
100 */
101 protected void doBuildTemplate(RunData data) throws Exception
102 {
103 }
104
105 }
This page was automatically generated by Maven