servlet::ServletResponse Class Reference

#include <ServletResponse.h>

Inheritance diagram for servlet::ServletResponse:

[legend]

List of all members.

Public Member Functions
virtual	~ServletResponse ()
virtual std::string	getCharacterEncoding ()=0
virtual std::string	getContentType ()=0
virtual std::ostream &	getOutputStream ()=0
virtual void	setCharacterEncoding (const std::string &charset)=0
virtual void	setContentLength (int len)=0
virtual void	setContentType (const std::string &type)=0
virtual void	setBufferSize (int size)=0
virtual int	getBufferSize ()=0
virtual void	flushBuffer ()=0
virtual bool	isCommitted ()=0
virtual void	reset ()=0

---

Detailed Description

ServletResponse

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 std::ostream 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 std::ostream and manage the character sections manually.

The charset for the MIME body response can be specified explicitly using the setCharacterEncoding and setContentType methods, or implicitly using the setLocale method. Explicit specifications take precedence over implicit specifications. If no charset is specified, ISO-8859-1 will be used. The setCharacterEncoding, setContentType, or setLocale method must be called before getWriter and before committing the response for the character encoding to be used.

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:

Various

Version:

$Version$

See also:

ServletOutputStream

Definition at line 101 of file ServletResponse.h.

---

Constructor & Destructor Documentation

virtual servlet::ServletResponse::~ServletResponse

(

)

[inline, virtual]

Definition at line 103 of file ServletResponse.h.

---

Member Function Documentation

virtual void servlet::ServletResponse::flushBuffer

(

)

[pure virtual]

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

getBufferSize

isCommitted

reset

Implemented in container::HttpServletResponseImpl, servlet::ServletResponseWrapper, and servlet::NoBodyResponse.

Referenced by servlet::NoBodyResponse::flushBuffer(), and servlet::ServletResponseWrapper::flushBuffer().

virtual int servlet::ServletResponse::getBufferSize

(

)

[pure virtual]

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

flushBuffer

isCommitted

reset

Implemented in container::HttpServletResponseImpl, servlet::ServletResponseWrapper, and servlet::NoBodyResponse.

Referenced by servlet::NoBodyResponse::getBufferSize(), and servlet::ServletResponseWrapper::getBufferSize().

virtual std::string servlet::ServletResponse::getCharacterEncoding

(

)

[pure virtual]

Returns the name of the character encoding (MIME charset) used for the body sent in this response. The character encoding may have been specified explicitly using the setCharacterEncoding or setContentType methods, or implicitly using the setLocale method. Explicit specifications take precedence over implicit specifications. Calls made to these methods after getWriter has been called or after the response has been committed have no effect on the character encoding. If no character encoding has been specified, ISO-8859-1 is returned.

See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information about character encoding and MIME.

Returns:

a String specifying the name of the character encoding, for example, UTF-8

Implemented in container::HttpServletResponseImpl, servlet::ServletResponseWrapper, and servlet::NoBodyResponse.

Referenced by servlet::NoBodyResponse::getCharacterEncoding(), and servlet::ServletResponseWrapper::getCharacterEncoding().

virtual std::string servlet::ServletResponse::getContentType

(

)

[pure virtual]

Returns the content type used for the MIME body sent in this response. The content type proper must have been specified using setContentType before the response is committed. If no content type has been specified, this method returns null. If a content type has been specified and a character encoding has been explicitly or implicitly specified as described in getCharacterEncoding, the charset parameter is included in the string returned. If no character encoding has been specified, the charset parameter is omitted.

Returns:

a String specifying the content type, for example, text/html; charset=UTF-8, or null

Since:

2.4

Implemented in container::HttpServletResponseImpl, servlet::ServletResponseWrapper, and servlet::NoBodyResponse.

Referenced by servlet::NoBodyResponse::getContentType(), and servlet::ServletResponseWrapper::getContentType().

virtual std::ostream& servlet::ServletResponse::getOutputStream

(

)

[pure virtual]

Returns a std::ostream suitable for writing binary data in the response. The servlet container does not encode the binary data.

Calling flush() on the output stream commits the response.

Either this method or getWriter may be called to write the body, not both.

Returns:

a std::ostream for writing binary data

Exceptions:

	IllegalStateException	if the getWriter method has been called on this response
	IOException	if an input or output exception occurred

See also:

getWriter

Implemented in container::HttpServletResponseImpl, servlet::ServletResponseWrapper, and servlet::NoBodyResponse.

Referenced by container::ServletContainer::forward(), and servlet::ServletResponseWrapper::getOutputStream().

virtual bool servlet::ServletResponse::isCommitted

(

)

[pure virtual]

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

Returns:

a boolean indicating if the response has been committed

See also:

setBufferSize

getBufferSize

flushBuffer

reset

Implemented in container::HttpServletResponseImpl, servlet::ServletResponseWrapper, and servlet::NoBodyResponse.

Referenced by container::ServletContainer::forward(), servlet::NoBodyResponse::isCommitted(), and servlet::ServletResponseWrapper::isCommitted().

virtual void servlet::ServletResponse::reset

(

)

[pure virtual]

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.

Exceptions:

IllegalStateException

if the response has already been committed

See also:

setBufferSize

getBufferSize

flushBuffer

isCommitted

Implemented in container::HttpServletResponseImpl, servlet::ServletResponseWrapper, and servlet::NoBodyResponse.

Referenced by servlet::NoBodyResponse::reset(), and servlet::ServletResponseWrapper::reset().

virtual void servlet::ServletResponse::setBufferSize

(

int

size

)

[pure virtual]

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 or the response object has been committed, this method throws an IllegalStateException.

Parameters:

size

the preferred buffer size

Exceptions:

IllegalStateException

if this method is called after content has been written

See also:

getBufferSize

flushBuffer

isCommitted

reset

Implemented in container::HttpServletResponseImpl, servlet::ServletResponseWrapper, and servlet::NoBodyResponse.

Referenced by servlet::NoBodyResponse::setBufferSize(), and servlet::ServletResponseWrapper::setBufferSize().

virtual void servlet::ServletResponse::setCharacterEncoding

(

const std::string &

charset

)

[pure virtual]

Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8. If the character encoding has already been set by setContentType or setLocale, this method overrides it. Calling setContentType with the String of text/html and calling this method with the String of UTF-8 is equivalent with calling setContentType with the String of text/html; charset=UTF-8.

This method can be called repeatedly to change the character encoding. This method has no effect if it is called after getWriter has been called or after the response has been committed.

Containers must communicate the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the character encoding is communicated as part of the Content-Type header for text media types. Note that the character encoding cannot be communicated via HTTP headers if the servlet does not specify a content type; however, it is still used to encode text written via the servlet response's writer.

Parameters:

charset

a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)

See also:

setContentType setLocale

Since:

2.4

Implemented in container::HttpServletResponseImpl, container::IncludedResponseWrapper, servlet::ServletResponseWrapper, and servlet::NoBodyResponse.

Referenced by servlet::NoBodyResponse::setCharacterEncoding(), and servlet::ServletResponseWrapper::setCharacterEncoding().

virtual void servlet::ServletResponse::setContentLength

(

int

len

)

[pure virtual]

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

Implemented in container::HttpServletResponseImpl, container::IncludedResponseWrapper, servlet::ServletResponseWrapper, and servlet::NoBodyResponse.

Referenced by servlet::NoBodyResponse::setContentLength(), and servlet::ServletResponseWrapper::setContentLength().

virtual void servlet::ServletResponse::setContentType

(

const std::string &

type

)

[pure virtual]

Sets the content type of the response being sent to the client, if the response has not been committed yet. The given content type may include a character encoding specification, for example, text/html;charset=UTF-8. The response's character encoding is only set from the given content type if this method is called before getWriter is called.

This method may be called repeatedly to change content type and character encoding. This method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after getWriter has been called or after the response has been committed.

Containers must communicate the content type and the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the Content-Type header is used.

Parameters:

type

a String specifying the MIME type of the content

See also:

setLocale

setCharacterEncoding

getOutputStream

getWriter

Implemented in container::HttpServletResponseImpl, container::IncludedResponseWrapper, servlet::ServletResponseWrapper, and servlet::NoBodyResponse.

Referenced by servlet::NoBodyResponse::setContentType(), and servlet::ServletResponseWrapper::setContentType().

---

The documentation for this class was generated from the following file:

• include/servlet/ServletResponse.h