1 package org.apache.turbine.services.servlet;
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.io.InputStream;
58 import java.net.URL;
59 import javax.servlet.ServletConfig;
60 import javax.servlet.ServletContext;
61 import org.apache.turbine.services.TurbineServices;
62
63 /***
64 * Simple static accessor to the EngineContextService
65 *
66 * @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
67 * @author <a href="mailto:raphael@apache.org">Raphaël Luta</a>
68 * @author <a href="mailto:ekkerbj@netscape.net">Jeff Brekke</a>
69 * @author <a href="mailto:jvanzyl@periapt.com">Jason van Zyl</a>
70 * @version $Id: TurbineServlet.java,v 1.1.1.1 2001/08/16 05:09:21 jvanzyl Exp $
71 */
72 public class TurbineServlet
73 {
74 /***
75 * Utility method for accessing the service
76 * implementation
77 *
78 * @return a ServletService implementation instance
79 */
80 protected static ServletService getService()
81 {
82 return (ServletService)TurbineServices
83 .getInstance().getService(ServletService.SERVICE_NAME);
84 }
85
86 /***
87 * Returns an URL object for a given URI string.
88 * This URI is considered relative to the context.
89 *
90 * @param uri the URI to resolve as an URL
91 * @return an URL object or null is the uri is malformed or can't be resolved
92 */
93 public static URL getResource( String uri )
94 {
95 return getService().getResource(uri);
96 }
97
98 /***
99 * Same as getResource except that it returns an InputStream
100 *
101 * @see javax.servlet.ServletContext#getResourceAsStream
102 * @param uri the URI to resolve
103 * @return an InputStream on the URI content or null
104 */
105 public static InputStream getResourceAsStream( String uri )
106 {
107 return getService().getResourceAsStream(uri);
108 }
109
110 /***
111 * Returns the complete filesystem path for a
112 * given URI
113 *
114 * @see javax.servlet.ServletContext#getRealPath
115 * @param uri the URI to resolve
116 * @return the full system path of this URI
117 */
118 public static String getRealPath( String path )
119 {
120 return getService().getRealPath(path);
121 }
122
123 /***
124 * Returns the servlet config used by this
125 * Turbine web application.
126 *
127 * @return turbine servlet config
128 */
129 public static ServletConfig getServletConfig()
130 {
131 return getService().getServletConfig();
132 }
133
134 /***
135 * Returns the servlet context used by this
136 * Turbine web application.
137 *
138 * @return turbine servlet context
139 */
140 public static ServletContext getServletContext()
141 {
142 return getService().getServletContext();
143 }
144
145 /***
146 * Returns the server scheme for this
147 * Turbine application. This will either
148 * be http or https.
149 *
150 * @return String
151 */
152 public static String getServerScheme()
153 {
154 return getService().getServerScheme();
155 }
156
157 /***
158 * Returns the server name that this
159 * Turbine application is running
160 * on.
161 *
162 * @return String
163 */
164 public static String getServerName()
165 {
166 return getService().getServerName();
167 }
168
169 /***
170 * Returns the port that this Turbine
171 * application is running through
172 * on the server.
173 *
174 * @return String
175 */
176 public static String getServerPort()
177 {
178 return getService().getServerPort();
179 }
180
181 /***
182 * Returns the context path for this
183 * Turbine application.
184 *
185 * @return String
186 */
187 public static String getContextPath()
188 {
189 return getService().getContextPath();
190 }
191 }
This page was automatically generated by Maven