javax.servlet
Interface ServletResponse

All Known Subinterfaces:

HttpServletResponse

public abstract interface ServletResponse

A servlet can use this class to pass information to the client.

Since:

Servlet API 1.0

Version:

Servlet API 2.1

Method Summary

java.lang.String	getCharacterEncoding() Returns the characterset encoding in use by this Response
ServletOutputStream	getOutputStream() Creates a ServletOutputStream for the servlet to write the data to.
java.io.PrintWriter	getWriter() Creates a PrintWriter for the servlet to print text to.
void	setContentLength(int length) Tells the client how many bytes to expect.
void	setContentType(java.lang.String type) Tells the client what mime type to expect

Method Detail

setContentLength

public void setContentLength(int length)

Tells the client how many bytes to expect.

Parameters:

length - the number of bytes in the reply

Since:

Servlet API 1.0

setContentType

public void setContentType(java.lang.String type)

Tells the client what mime type to expect

Parameters:

type - the mime type of the content

Since:

Servlet API 1.0

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws java.io.IOException

Creates a ServletOutputStream for the servlet to write the data to. setContentLength and setContentType can only be called before anything is written to this stream. It is only possible to call getWriter or getOutputStream on a response, but not both.

Returns:

ServletOutputStream to write binary data

Throws:

java.io.IOException - if a i/o exception occurs

java.lang.IllegalStateException - if getWriter was already called on this response

Since:

Servlet API 1.0

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException

Creates a PrintWriter for the servlet to print text to. The contenttype must be set before calling this method. It is only possible to call getWriter or getOutputStream on a response, but not both.

Returns:

the created PrintWriter

Throws:

java.io.IOException - if a i/o exception occurs

java.lang.IllegalStateException - if getOutputStream was already called on this response

java.io.UnsupportedEncodingException - if no suitable character encoding can be used

Since:

Servlet API 2.0

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Returns the characterset encoding in use by this Response

Returns:

the characterset encoding

Since:

Servlet API 2.0