Find Usages Diff Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions 
1
  /*
2
   * The Apache Software License, Version 1.1
3
   *
4
   * Copyright (c) 1999 The Apache Software Foundation.  All rights 
5
   * reserved.
6
   *
7
   * Redistribution and use in source and binary forms, with or without
8
   * modification, are permitted provided that the following conditions
9
   * are met:
10
  *
11
  * 1. Redistributions of source code must retain the above copyright
12
  *    notice, this list of conditions and the following disclaimer. 
13
  *
14
  * 2. Redistributions in binary form must reproduce the above copyright
15
  *    notice, this list of conditions and the following disclaimer in
16
  *    the documentation and/or other materials provided with the
17
  *    distribution.
18
  *
19
  * 3. The end-user documentation included with the redistribution, if
20
  *    any, must include the following acknowlegement:  
21
  *       "This product includes software developed by the 
22
  *        Apache Software Foundation (http://www.apache.org/)."
23
  *    Alternately, this acknowlegement may appear in the software itself,
24
  *    if and wherever such third-party acknowlegements normally appear.
25
  *
26
  * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
27
  *    Foundation" must not be used to endorse or promote products derived
28
  *    from this software without prior written permission. For written 
29
  *    permission, please contact apache@apache.org.
30
  *
31
  * 5. Products derived from this software may not be called "Apache"
32
  *    nor may "Apache" appear in their names without prior written
33
  *    permission of the Apache Group.
34
  *
35
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38
  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46
  * SUCH DAMAGE.
47
  * ====================================================================
48
  *
49
  * This software consists of voluntary contributions made by many
50
  * individuals on behalf of the Apache Software Foundation.  For more
51
  * information on the Apache Software Foundation, please see
52
  * <http://www.apache.org/>.
53
  *
54
  * ====================================================================
55
  *
56
  * This source code implements specifications defined by the Java
57
  * Community Process. In order to remain compliant with the specification
58
  * DO NOT add / change / or delete method signatures!
59
  */ 
60
 
61
 package javax.servlet;
62
 
Defines an object to assist a servlet in sending a response to the client. The servlet container creates a ServletResponse object and passes it as an argument to the servlet's service method.

To send binary data in a MIME body response, use the ServletOutputStream returned by getOutputStream(). To send character data, use the PrintWriter object returned by getWriter(). To mix binary and text data, for example, to create a multipart response, use a ServletOutputStream and manage the character sections manually.

The charset for the MIME body response can be specified with setContentType(java.lang.String). For example, "text/html; charset=Shift_JIS". The charset can alternately be set using setLocale(java.util.Locale). If no charset is specified, ISO-8859-1 will be used. The setContentType or setLocale method must be called before getWriter for the charset to affect the construction of the writer.

See the Internet RFCs such as RFC 2045 for more information on MIME. Protocols such as SMTP and HTTP define profiles of MIME, and those standards are still evolving.

Author(s):
Various
Version:
$Version$
See also:
ServletOutputStream
102
 
103
public interface ServletResponse {


    
    
Returns the name of the charset used for the MIME body sent in this response.

If no charset has been assigned, it is implicitly set to ISO-8859-1 (Latin-1).

See RFC 2047 (http://ds.internic.net/rfc/rfc2045.txt) for more information about character encoding and MIME.

Returns:
a String specifying the name of the charset, for example, ISO-8859-1
122
  
123
    public String getCharacterEncoding();
    
    

    
Returns a ServletOutputStream suitable for writing binary data in the response. The servlet container does not encode the binary data. Either this method or getWriter() may be called to write the body, not both.

Returns:
a ServletOutputStream for writing binary data
Throws:
java.lang.IllegalStateException if the getWriter method has been called on this response
java.io.IOException if an input or output exception occurred
See also:
getWriter()
144
    public ServletOutputStream getOutputStream() throws IOException;
    
    

    
Returns a PrintWriter object that can send character text to the client. The character encoding used is the one specified in the charset= property of the setContentType(java.lang.String) method, which must be called before calling this method for the charset to take effect.

If necessary, the MIME type of the response is modified to reflect the character encoding used.

Either this method or getOutputStream() may be called to write the body, not both.

Returns:
a PrintWriter object that can return character data to the client
Throws:
java.io.UnsupportedEncodingException if the charset specified in setContentType cannot be used
java.lang.IllegalStateException if the getOutputStream method has already been called for this response object
java.io.IOException if an input or output exception occurred
See also:
getOutputStream()
setContentType(java.lang.String)
181
    public PrintWriter getWriter() throws IOException;
    
    
    
    

    
Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.

Parameters:
len an integer specifying the length of the content being returned to the client; sets the Content-Length header
198
    public void setContentLength(int len);
    
    

    
Sets the content type of the response being sent to the client. The content type may include the type of character encoding used, for example, text/html; charset=ISO-8859-4.

If obtaining a PrintWriter, this method should be called first.

Parameters:
type a String specifying the MIME type of the content
See also:
getOutputStream()
getWriter()
219
    public void setContentType(String type);
    

    
Sets the preferred buffer size for the body of the response. The servlet container will use a buffer at least as large as the size requested. The actual buffer size used can be found using getBufferSize.

A larger buffer allows more content to be written before anything is actually sent, thus providing the servlet with more time to set appropriate status codes and headers. A smaller buffer decreases server memory load and allows the client to start receiving data more quickly.

This method must be called before any response body content is written; if content has been written, this method throws an IllegalStateException.

Parameters:
size the preferred buffer size
Throws:
java.lang.IllegalStateException if this method is called after content has been written
See also:
getBufferSize()
flushBuffer()
isCommitted()
reset()
250
    public void setBufferSize(int size);
    
    

    
Returns the actual buffer size used for the response. If no buffering is used, this method returns 0.

Returns:
the actual buffer size used
See also:
setBufferSize(int)
flushBuffer()
isCommitted()
reset()
267
    public int getBufferSize();
    
    

    
Forces any content in the buffer to be written to the client. A call to this method automatically commits the response, meaning the status code and headers will be written.

See also:
setBufferSize(int)
getBufferSize()
isCommitted()
reset()
283
    public void flushBuffer() throws IOException;
    
    

    
Returns a boolean indicating if the response has been committed. A commited response has already had its status code and headers written.

Returns:
a boolean indicating if the response has been committed
See also:
setBufferSize(int)
getBufferSize()
flushBuffer()
reset()
302
    public boolean isCommitted();
    
    

    
Clears any data that exists in the buffer as well as the status code and headers. If the response has been committed, this method throws an IllegalStateException.

Throws:
java.lang.IllegalStateException if the response has already been committed
See also:
setBufferSize(int)
getBufferSize()
flushBuffer()
isCommitted()
321
    public void reset();
    
    

    
Sets the locale of the response, setting the headers (including the Content-Type's charset) as appropriate. This method should be called before a call to getWriter(). By default, the response locale is the default locale for the server.

Parameters:
loc the locale of the response
See also:
getLocale()
337
    public void setLocale(Locale loc);
    
    

    
Returns the locale assigned to the response.

See also:
setLocale(java.util.Locale)
349
    public Locale getLocale();
New to GrepCode? Check out our FAQ X