1 package org.apache.turbine.services.jsp.util;
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 import org.apache.turbine.util.DynamicURI;
58 import org.apache.turbine.util.RunData;
59
60 /***
61 * A customized version of the DynamicURI to be used in JSP templates.
62 * This is automatically inserted into the request so page authors
63 * can create links in templates.
64 * Here's an example of its use:<br>
65 * <code>
66 * <jsp:useBean id="link" class="JspLink" scope="request"/%>
67 * <%= link.setPage("index.jsp").setPathInfo("key", "value") %>
68 * This would return:
69 * http://foo.com/myapp/servlet/Turbine/key/value/template/index.jsp
70 * </code>
71 *
72 * @author <a href="john.mcnally@clearink.com">John McNally</a>
73 * @author Dave Bryson<a href="mbryson@mont.mindspring.com">mbryson@mont.mindspring.com</a>
74 * @author Jon S. Stevens <a href="mailto:jon@latchkey.com">jon@latchkey.com</a>
75 */
76 public class JspLink extends DynamicURI
77 {
78 /***
79 Constructor
80 */
81 public JspLink(RunData data)
82 {
83 super(data);
84 }
85
86 /***
87 * Returns the URI
88 * @return String the uri http://foo.com/...
89 */
90 public String toString()
91 {
92 String output = super.toString();
93
94 // This was added to allow multilple $link variables in one
95 // WebMacro template
96 removePathInfo();
97 removeQueryData();
98
99 return output;
100 }
101
102 /***
103 * Sets the template variable used by the WebMacroSite Service
104 * @param String the template name
105 * @return JspLink
106 */
107 public JspLink setPage(String t)
108 {
109 return (JspLink) addPathInfo("template",t);
110 }
111 }
This page was automatically generated by Maven