001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/core/StandardHostMapper.java,v 1.4 2002/03/14 20:58:24 remm Exp $
003: * $Revision: 1.4 $
004: * $Date: 2002/03/14 20:58:24 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina.core;
065:
066: import javax.servlet.http.HttpServletRequest;
067: import org.apache.catalina.Container;
068: import org.apache.catalina.Context;
069: import org.apache.catalina.Host;
070: import org.apache.catalina.HttpRequest;
071: import org.apache.catalina.Mapper;
072: import org.apache.catalina.Request;
073: import org.apache.catalina.util.StringManager;
074:
075: /**
076: * Implementation of <code>Mapper</code> for a <code>Host</code>,
077: * designed to process HTTP requests. This mapper selects an appropriate
078: * <code>Context</code> based on the request URI included in the request.
079: * <p>
080: * <b>IMPLEMENTATION NOTE</b>: This Mapper only works with a
081: * <code>StandardHost</code>, because it relies on internal APIs.
082: *
083: * @author Craig R. McClanahan
084: * @version $Revision: 1.4 $ $Date: 2002/03/14 20:58:24 $
085: */
086:
087: public class StandardHostMapper implements Mapper {
088:
089: // ----------------------------------------------------- Instance Variables
090:
091: /**
092: * The Container with which this Mapper is associated.
093: */
094: private StandardHost host = null;
095:
096: /**
097: * The protocol with which this Mapper is associated.
098: */
099: private String protocol = null;
100:
101: /**
102: * The string manager for this package.
103: */
104: private static final StringManager sm = StringManager
105: .getManager(Constants.Package);
106:
107: // ------------------------------------------------------------- Properties
108:
109: /**
110: * Return the Container with which this Mapper is associated.
111: */
112: public Container getContainer() {
113:
114: return (host);
115:
116: }
117:
118: /**
119: * Set the Container with which this Mapper is associated.
120: *
121: * @param container The newly associated Container
122: *
123: * @exception IllegalArgumentException if this Container is not
124: * acceptable to this Mapper
125: */
126: public void setContainer(Container container) {
127:
128: if (!(container instanceof StandardHost))
129: throw new IllegalArgumentException(sm
130: .getString("httpHostMapper.container"));
131: host = (StandardHost) container;
132:
133: }
134:
135: /**
136: * Return the protocol for which this Mapper is responsible.
137: */
138: public String getProtocol() {
139:
140: return (this .protocol);
141:
142: }
143:
144: /**
145: * Set the protocol for which this Mapper is responsible.
146: *
147: * @param protocol The newly associated protocol
148: */
149: public void setProtocol(String protocol) {
150:
151: this .protocol = protocol;
152:
153: }
154:
155: // --------------------------------------------------------- Public Methods
156:
157: /**
158: * Return the child Container that should be used to process this Request,
159: * based upon its characteristics. If no such child Container can be
160: * identified, return <code>null</code> instead.
161: *
162: * @param request Request being processed
163: * @param update Update the Request to reflect the mapping selection?
164: */
165: public Container map(Request request, boolean update) {
166:
167: // Has this request already been mapped?
168: if (update && (request.getContext() != null))
169: return (request.getContext());
170:
171: // Perform mapping on our request URI
172: String uri = ((HttpRequest) request).getDecodedRequestURI();
173: Context context = host.map(uri);
174:
175: // Update the request (if requested) and return the selected Context
176: if (update) {
177: request.setContext(context);
178: if (context != null)
179: ((HttpRequest) request).setContextPath(context
180: .getPath());
181: else
182: ((HttpRequest) request).setContextPath(null);
183: }
184: return (context);
185:
186: }
187:
188: }
|