View Javadoc
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.net.URL; 58 import java.io.InputStream; 59 import javax.servlet.ServletConfig; 60 import javax.servlet.ServletContext; 61 import org.apache.turbine.services.Service; 62 63 /*** 64 * <p>This interface exposes methods of the runner context in order 65 * resolve or get access to external resources</p> 66 * 67 * @author <a href="mailto:ekkerbj@netscape.net">Jeff Brekke</a> 68 * @author <a href="mailto:raphael@apache.org">Raphaël Luta</a> 69 * @author <a href="mailto:jvanzyl@periapt.com">Jason van Zyl</a> 70 * @version $Id: ServletService.java,v 1.1.1.1 2001/08/16 05:09:21 jvanzyl Exp $ 71 */ 72 public interface ServletService extends Service 73 { 74 /*** 75 * The service identifier 76 */ 77 public String SERVICE_NAME = "ServletService"; 78 79 /*** 80 * Returns an URL object for a given URI string. 81 * 82 * @param uri the URI to resolve as an URL 83 * @return an URL object or null is the uri is malformed or 84 * can't be resolved 85 */ 86 public URL getResource( String uri ); 87 88 /*** 89 * Same as getResource except that it returns an InputStream 90 * 91 * @param uri the URI to resolve 92 * @return an InputStream on the URI content or null 93 */ 94 public InputStream getResourceAsStream( String uri ); 95 96 /*** 97 * Returns the complete filesystem path for a 98 * given URI 99 * 100 * @param uri the URI to resolve 101 * @return the full system path of this URI 102 */ 103 public String getRealPath( String uri ); 104 105 /*** 106 * Returns the servlet config used by this 107 * Turbine web application. 108 * 109 * @return turbine servlet config 110 */ 111 public ServletConfig getServletConfig(); 112 113 /*** 114 * Returns the servlet context used by this 115 * Turbine web application. 116 * 117 * @return turbine servlet context 118 */ 119 public ServletContext getServletContext(); 120 121 /*** 122 * Returns the server scheme for this 123 * Turbine application. This will either 124 * be http or https. 125 * 126 * @return String 127 */ 128 public String getServerScheme(); 129 130 /*** 131 * Returns the server name that this 132 * Turbine application is running 133 * on. 134 * 135 * @return String 136 */ 137 public String getServerName(); 138 139 /*** 140 * Returns the port that this Turbine 141 * application is running through 142 * on the server. 143 * 144 * @return String 145 */ 146 public String getServerPort(); 147 148 /*** 149 * Returns the context path for this 150 * Turbine application. 151 * 152 * @return String 153 */ 154 public String getContextPath(); 155 }

This page was automatically generated by Maven