001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/Mapper.java,v 1.3 2001/07/22 20:13:30 pier Exp $
003: * $Revision: 1.3 $
004: * $Date: 2001/07/22 20:13:30 $
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;
065:
066: /**
067: * Interface defining methods that a parent Container may implement to select
068: * a subordinate Container to process a particular Request, optionally
069: * modifying the properties of the Request to reflect the selections made.
070: * <p>
071: * A typical Container may be associated with a single Mapper that processes
072: * all requests to that Container, or a Mapper per request protocol that allows
073: * the same Container to support multiple protocols at once.
074: *
075: * @author Craig R. McClanahan
076: * @version $Revision: 1.3 $ $Date: 2001/07/22 20:13:30 $
077: */
078:
079: public interface Mapper {
080:
081: // ------------------------------------------------------------- Properties
082:
083: /**
084: * Return the Container with which this Mapper is associated.
085: */
086: public Container getContainer();
087:
088: /**
089: * Set the Container with which this Mapper is associated.
090: *
091: * @param container The newly associated Container
092: *
093: * @exception IllegalArgumentException if this Container is not
094: * acceptable to this Mapper
095: */
096: public void setContainer(Container container);
097:
098: /**
099: * Return the protocol for which this Mapper is responsible.
100: */
101: public String getProtocol();
102:
103: /**
104: * Set the protocol for which this Mapper is responsible.
105: *
106: * @param protocol The newly associated protocol
107: */
108: public void setProtocol(String protocol);
109:
110: // --------------------------------------------------------- Public Methods
111:
112: /**
113: * Return the child Container that should be used to process this Request,
114: * based upon its characteristics. If no such child Container can be
115: * identified, return <code>null</code> instead.
116: *
117: * @param request Request being processed
118: * @param update Update the Request to reflect the mapping selection?
119: */
120: public Container map(Request request, boolean update);
121:
122: }
|