001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/HttpResponse.java,v 1.5 2001/07/22 20:13:30 pier Exp $
003: * $Revision: 1.5 $
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: import javax.servlet.http.Cookie;
067:
068: /**
069: * An <b>HttpResponse</b> is the Catalina-internal facade for an
070: * <code>HttpServletResponse</code> that is to be produced,
071: * based on the processing of a corresponding <code>HttpRequest</code>.
072: *
073: * @author Craig R. McClanahan
074: * @version $Revision: 1.5 $ $Date: 2001/07/22 20:13:30 $
075: */
076:
077: public interface HttpResponse extends Response {
078:
079: // --------------------------------------------------------- Public Methods
080:
081: /**
082: * Return an array of all cookies set for this response, or
083: * a zero-length array if no cookies have been set.
084: */
085: public Cookie[] getCookies();
086:
087: /**
088: * Return the value for the specified header, or <code>null</code> if this
089: * header has not been set. If more than one value was added for this
090: * name, only the first is returned; use getHeaderValues() to retrieve all
091: * of them.
092: *
093: * @param name Header name to look up
094: */
095: public String getHeader(String name);
096:
097: /**
098: * Return an array of all the header names set for this response, or
099: * a zero-length array if no headers have been set.
100: */
101: public String[] getHeaderNames();
102:
103: /**
104: * Return an array of all the header values associated with the
105: * specified header name, or an zero-length array if there are no such
106: * header values.
107: *
108: * @param name Header name to look up
109: */
110: public String[] getHeaderValues(String name);
111:
112: /**
113: * Return the error message that was set with <code>sendError()</code>
114: * for this Response.
115: */
116: public String getMessage();
117:
118: /**
119: * Return the HTTP status code associated with this Response.
120: */
121: public int getStatus();
122:
123: /**
124: * Reset this response, and specify the values for the HTTP status code
125: * and corresponding message.
126: *
127: * @exception IllegalStateException if this response has already been
128: * committed
129: */
130: public void reset(int status, String message);
131:
132: }
|