home *** CD-ROM | disk | FTP | other *** search
/ PC World 2000 November / PCWorld_2000-11_cd.bin / Komunik / sambar444 / _SETUP.1 / javaeng.jar / javax / servlet / ServletResponse.java < prev    next >
Text File  |  2000-08-09  |  3KB  |  141 lines
  1. /*
  2.  * ServletResponse.java -- Class used to store servlet response
  3.  *
  4.  * Copyright (c) 1998, 1999 by Free Software Foundation, Inc.
  5.  * Written by Paul Siegmann (pauls@euronet.nl)
  6.  *
  7.  * This program is free software; you can redistribute it and/or modify
  8.  * it under the terms of the GNU Library General Public License as published
  9.  * by the Free Software Foundation, version 2. (see COPYING.LIB)
  10.  *
  11.  * This program is distributed in the hope that it will be useful, but
  12.  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License
  17.  * along with this program; if not, write to the Free Software Foundation
  18.  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307 USA
  19.  */
  20.  
  21. package javax.servlet;
  22.  
  23. import java.io.IOException;
  24. import java.io.PrintWriter;
  25. import java.util.Locale;
  26.  
  27.  
  28. /**
  29.  * A servlet can use this class to pass information to the client.
  30.  *
  31.  * @version Servlet API 2.2
  32.  * @since Servlet API 1.0
  33.  * @author Paul Siegmann (pauls@euronet.nl)
  34.  */
  35. public interface ServletResponse
  36. {
  37.     /**
  38.      * Tells the client how many bytes to expect.
  39.      *
  40.      * @since Servlet API 1.0
  41.      *
  42.      * @param length the number of bytes in the reply
  43.      */
  44.     void setContentLength(int length);
  45.     
  46.     /**
  47.      * Tells the client what mime type to expect
  48.      *
  49.      * @since Servlet API 1.0
  50.      *
  51.      * @param type the mime type of the content
  52.      */
  53.     void setContentType(String type);
  54.  
  55.  
  56.     /**
  57.      * Creates a ServletOutputStream for the servlet to write the data to.
  58.      * <code>setContentLength</code> and <code>setContentType</code> can
  59.      * only be called before anything is written to this stream.
  60.      * It is only possible to call <code>getWriter</code> or
  61.      * <code>getOutputStream</code> on a response, but not both.
  62.      *
  63.      * @since Servlet API 1.0
  64.      *
  65.      * @return ServletOutputStream to write binary data
  66.      * @exception IOException if a i/o exception occurs
  67.      * @exception IllegalStateException if <code>getWriter</code> was already
  68.      * called on this response
  69.      */
  70.     ServletOutputStream getOutputStream() throws IOException;
  71.  
  72.  
  73.     /**
  74.      * Creates a PrintWriter for the servlet to print text to.
  75.      * The contenttype must be set before calling this method.
  76.      * It is only possible to call <code>getWriter</code> or
  77.      * <code>getOutputStream</code> on a response, but not both.
  78.      *
  79.      * @since Servlet API 2.0
  80.      *
  81.      * @return the created PrintWriter
  82.      * @exception IOException if a i/o exception occurs
  83.      * @exception IllegalStateException if <code>getOutputStream</code> was
  84.      * already called on this response
  85.      * @exception java.io.UnsupportedEncodingException if no suitable character
  86.      * encoding can be used
  87.      */
  88.     PrintWriter getWriter() throws IOException;
  89.  
  90.  
  91.  
  92.     /**
  93.      * Returns the characterset encoding in use by this Response
  94.      *
  95.      * @since Servlet API 2.0
  96.      * @return the characterset encoding
  97.      */
  98.     String getCharacterEncoding();
  99.  
  100.     /**
  101.      * XXX
  102.      */
  103.     void setBufferSize(int size);
  104.  
  105.  
  106.     /**
  107.      * XXX
  108.      */
  109.     int getBufferSize();
  110.  
  111.  
  112.     /**
  113.      * XXX
  114.      */
  115.     void reset();
  116.  
  117.  
  118.     /**
  119.      * XXX
  120.      */
  121.     boolean isCommitted();
  122.  
  123.  
  124.     /**
  125.      * XXX
  126.      */
  127.     void flushBuffer();
  128.  
  129.  
  130.     /**
  131.      * XXX
  132.      */
  133.     void setLocale(Locale locale);
  134.  
  135.  
  136.     /**
  137.      * XXX
  138.      */
  139.     Locale getLocale();
  140. }
  141.