001: package org.apache.turbine.services.servlet;
002:
003: /*
004: * Licensed to the Apache Software Foundation (ASF) under one
005: * or more contributor license agreements. See the NOTICE file
006: * distributed with this work for additional information
007: * regarding copyright ownership. The ASF licenses this file
008: * to you under the Apache License, Version 2.0 (the
009: * "License"); you may not use this file except in compliance
010: * with the License. You may obtain a copy of the License at
011: *
012: * http://www.apache.org/licenses/LICENSE-2.0
013: *
014: * Unless required by applicable law or agreed to in writing,
015: * software distributed under the License is distributed on an
016: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017: * KIND, either express or implied. See the License for the
018: * specific language governing permissions and limitations
019: * under the License.
020: */
021:
022: import java.io.InputStream;
023: import java.net.URL;
024: import javax.servlet.ServletConfig;
025: import javax.servlet.ServletContext;
026:
027: import org.apache.turbine.services.TurbineServices;
028:
029: /**
030: * Simple static accessor to the EngineContextService
031: *
032: * @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
033: * @author <a href="mailto:raphael@apache.org">Raphaël Luta</a>
034: * @author <a href="mailto:ekkerbj@netscape.net">Jeff Brekke</a>
035: * @author <a href="mailto:jvanzyl@periapt.com">Jason van Zyl</a>
036: * @version $Id: TurbineServlet.java 534527 2007-05-02 16:10:59Z tv $
037: */
038: public class TurbineServlet {
039: /**
040: * Utility method for accessing the service
041: * implementation
042: *
043: * @return a ServletService implementation instance
044: */
045: protected static ServletService getService() {
046: return (ServletService) TurbineServices.getInstance()
047: .getService(ServletService.SERVICE_NAME);
048: }
049:
050: /**
051: * Returns an URL object for a given URI string.
052: * This URI is considered relative to the context.
053: *
054: * @param uri the URI to resolve as an URL
055: * @return an URL object or null is the uri is malformed or can't be resolved
056: */
057: public static URL getResource(String uri) {
058: return getService().getResource(uri);
059: }
060:
061: /**
062: * Same as getResource except that it returns an InputStream
063: *
064: * @see javax.servlet.ServletContext#getResourceAsStream
065: * @param uri the URI to resolve
066: * @return an InputStream on the URI content or null
067: */
068: public static InputStream getResourceAsStream(String uri) {
069: return getService().getResourceAsStream(uri);
070: }
071:
072: /**
073: * Returns the complete filesystem path for a
074: * given URI
075: *
076: * @see javax.servlet.ServletContext#getRealPath
077: * @param uri the URI to resolve
078: * @return the full system path of this URI
079: */
080: public static String getRealPath(String path) {
081: return getService().getRealPath(path);
082: }
083:
084: /**
085: * Returns the servlet config used by this
086: * Turbine web application.
087: *
088: * @return turbine servlet config
089: */
090: public static ServletConfig getServletConfig() {
091: return getService().getServletConfig();
092: }
093:
094: /**
095: * Returns the servlet context used by this
096: * Turbine web application.
097: *
098: * @return turbine servlet context
099: */
100: public static ServletContext getServletContext() {
101: return getService().getServletContext();
102: }
103:
104: /**
105: * Returns the server scheme for this
106: * Turbine application. This will either
107: * be http or https.
108: *
109: * @return String
110: */
111: public static String getServerScheme() {
112: return getService().getServerScheme();
113: }
114:
115: /**
116: * Returns the server name that this
117: * Turbine application is running
118: * on.
119: *
120: * @return String
121: */
122: public static String getServerName() {
123: return getService().getServerName();
124: }
125:
126: /**
127: * Returns the port that this Turbine
128: * application is running through
129: * on the server.
130: *
131: * @return String
132: */
133: public static String getServerPort() {
134: return getService().getServerPort();
135: }
136:
137: /**
138: * Returns the context path for this
139: * Turbine application.
140: *
141: * @return String
142: */
143: public static String getContextPath() {
144: return getService().getContextPath();
145: }
146: }
|