KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > turbine > tool > ContentURI


1 package org.apache.turbine.tool;
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 java.lang.reflect.Method JavaDoc;
58 import org.apache.turbine.RunData;
59 import org.apache.turbine.DynamicURI;
60 import org.apache.turbine.services.pull.ApplicationTool;
61
62 /**
63  * Utility class to allow the easy inclusion of
64  * images in templates: &lt;img SRC="$content.getURI("image.jpg")">
65  *
66  * @author <a HREF="mailto:criley@ekmail.com">Cameron Riley</a>
67  * @author <a HREF="mailto:jvanzyl@periapt.com">Jason van Zyl</a>
68  * @author <a HREF="mailto:jon@latchkey.com">Jon S. Stevens</a>
69  * @version $Id: ContentURI.java,v 1.1 2002/06/01 22:05:28 jvanzyl Exp $
70  */
71 public class ContentURI
72     extends DynamicURI
73     implements ApplicationTool
74 {
75     /** stores the context path for servlet 2.1+ compliant containers */
76     private String JavaDoc contextPath;
77
78     /**
79      * Constructor
80      *
81      * @param data a RunData instance
82      */
83     public ContentURI (RunData data)
84     {
85         super(data);
86         init(data);
87     }
88
89     /**
90      * Default constructor
91      */
92     public ContentURI ()
93     {
94     }
95
96     /**
97      * Initialize this object using the data given (ApplicationTool
98      * method).
99      *
100      * @param data assumed to be a RunData instance
101      */
102     public void init(Object JavaDoc data)
103     {
104         // we blithely cast to RunData as the runtime error thrown
105 // if data is null or another type is appropriate.
106 init((RunData)data);
107     }
108
109     /**
110      * Refresh method - does nothing
111      */
112     public void refresh()
113     {
114         // empty
115 }
116
117     /**
118      * Initialize this object using the given RunData object
119      *
120      * @param data a RunData instance
121      */
122     public void init(RunData data)
123     {
124         super.init(data);
125         try
126         {
127             Class JavaDoc runDataClass = RunData.class;
128             Method JavaDoc meth = runDataClass.getDeclaredMethod("getContextPath", null);
129             contextPath = (String JavaDoc)meth.invoke(data, null);
130         }
131         catch (Exception JavaDoc e)
132         {
133             /*
134              * Ignore a NoSuchMethodException because it means we are
135              * using Servlet API 2.0. Make sure scriptName is not
136              * null.
137              */
138             contextPath = "";
139         }
140     }
141
142     /**
143      * Returns a URI pointing to the given content (where content is a
144      * path relative to the webapp root.
145      *
146      * @param pathToContent a path relative to the webapp root
147      */
148     public String JavaDoc getURI(String JavaDoc pathToContent)
149     {
150         StringBuffer JavaDoc sb = new StringBuffer JavaDoc();
151         sb.append (getServerScheme()); //http
152 sb.append ("://");
153         sb.append (getServerName()); //www.foo.com
154 sb.append (':');
155         sb.append (getServerPort()); //port webserver running on (8080 for TDK)
156 //the context for tomcat adds a / so no need to add another
157 sb.append (contextPath); //the tomcat context
158 sb.append ('/');
159         sb.append (pathToContent);
160         return (sb.toString());
161     }
162 }
163
Popular Tags