servlet::HttpServletResponse Class Reference

#include <HttpServletResponse.h>

Inheritance diagram for servlet::HttpServletResponse:

Collaboration diagram for servlet::HttpServletResponse:


Public Member Functions
	HttpServletResponse ()
virtual	~HttpServletResponse ()
virtual void	addCookie (const Cookie &cookie)=0
virtual bool	containsHeader (const std::string &name) const =0
virtual std::string	encodeURL (const std::string &url)=0
virtual std::string	encodeRedirectURL (const std::string &url)=0
virtual void	sendError (int sc, const std::string &msg)=0
virtual void	sendError (int sc)=0
virtual void	sendRedirect (const std::string &location)=0
virtual void	setDateHeader (const std::string &name, long date)=0
virtual void	addDateHeader (const std::string &name, long date)=0
virtual void	setHeader (const std::string &name, const std::string &value)=0
virtual void	addHeader (const std::string &name, const std::string &value)=0
virtual void	setIntHeader (const std::string &name, int value)=0
virtual void	addIntHeader (const std::string &name, int value)=0
virtual void	setStatus (int sc)=0
Public Attributes
int	SC_REQUEST_URI_TOO_LONG
Static Public Attributes
static const int	SC_CONTINUE = 100
static const int	SC_SWITCHING_PROTOCOLS = 101
static const int	SC_OK = 200
static const int	SC_CREATED = 201
static const int	SC_ACCEPTED = 202
static const int	SC_NON_AUTHORITATIVE_INFORMATION = 203
static const int	SC_NO_CONTENT = 204
static const int	SC_RESET_CONTENT = 205
static const int	SC_PARTIAL_CONTENT = 206
static const int	SC_MULTIPLE_CHOICES = 300
static const int	SC_MOVED_PERMANENTLY = 301
static const int	SC_MOVED_TEMPORARILY = 302
static const int	SC_FOUND = 302
static const int	SC_SEE_OTHER = 303
static const int	SC_NOT_MODIFIED = 304
static const int	SC_USE_PROXY = 305
static const int	SC_TEMPORARY_REDIRECT = 307
static const int	SC_BAD_REQUEST = 400
static const int	SC_UNAUTHORIZED = 401
static const int	SC_PAYMENT_REQUIRED = 402
static const int	SC_FORBIDDEN = 403
static const int	SC_NOT_FOUND = 404
static const int	SC_METHOD_NOT_ALLOWED = 405
static const int	SC_NOT_ACCEPTABLE = 406
static const int	SC_PROXY_AUTHENTICATION_REQUIRED = 407
static const int	SC_REQUEST_TIMEOUT = 408
static const int	SC_CONFLICT = 409
static const int	SC_GONE = 410
static const int	SC_LENGTH_REQUIRED = 411
static const int	SC_PRECONDITION_FAILED = 412
static const int	SC_REQUEST_ENTITY_TOO_LARGE = 413
static const int	SC_UNSUPPORTED_MEDIA_TYPE = 415
static const int	SC_REQUESTED_RANGE_NOT_SATISFIABLE = 416
static const int	SC_EXPECTATION_FAILED = 417
static const int	SC_INTERNAL_SERVER_ERROR = 500
static const int	SC_NOT_IMPLEMENTED = 501
static const int	SC_BAD_GATEWAY = 502
static const int	SC_SERVICE_UNAVAILABLE = 503
static const int	SC_GATEWAY_TIMEOUT = 504
static const int	SC_HTTP_VERSION_NOT_SUPPORTED = 505

Detailed Description

HttpServletResponse

Extends the servlet::ServletResponse interface to provide HTTP-specific functionality in sending a response. For example, it has methods to access HTTP headers and cookies.

The servlet container creates an HttpServletResponse object and passes it as an argument to the servlet's service methods (doGet, doPost, etc).

Author:: Various

Version:: $Version$

See also:: javax.servlet.ServletResponse

Definition at line 81 of file HttpServletResponse.h.

Constructor & Destructor Documentation

servlet::HttpServletResponse::HttpServletResponse ( )

The default constructor. Does nothing.

Definition at line 59 of file HttpServletResponse.cpp.

virtual servlet::HttpServletResponse::~HttpServletResponse ( ) [inline, virtual]

Definition at line 87 of file HttpServletResponse.h.

Member Function Documentation

virtual void servlet::HttpServletResponse::addCookie ( const Cookie & cookie ) [pure virtual]

Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.

Parameters:

cookie

the Cookie to return to the client

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

Referenced by servlet::NoBodyResponse::addCookie(), and servlet::HttpServletResponseWrapper::addCookie().

virtual void servlet::HttpServletResponse::addDateHeader	(	const std::string &	name,
		long	date
	)			`[pure virtual]`

Adds a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. This method allows response headers to have multiple values.

Parameters:

	name	the name of the header to set
	date	the additional date value

See also:: setDateHeader

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

Referenced by servlet::NoBodyResponse::addDateHeader(), and servlet::HttpServletResponseWrapper::addDateHeader().

virtual void servlet::HttpServletResponse::addHeader	(	const std::string &	name,
		const std::string &	value
	)			`[pure virtual]`

Adds a response header with the given name and value. This method allows response headers to have multiple values.

Parameters:

	name	the name of the header
	value	the additional header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)

See also:: setHeader

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

Referenced by servlet::NoBodyResponse::addHeader(), and servlet::HttpServletResponseWrapper::addHeader().

virtual void servlet::HttpServletResponse::addIntHeader	(	const std::string &	name,
		int	value
	)			`[pure virtual]`

Adds a response header with the given name and integer value. This method allows response headers to have multiple values.

Parameters:

	name	the name of the header
	value	the assigned integer value

See also:: setIntHeader

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

Referenced by servlet::NoBodyResponse::addIntHeader(), and servlet::HttpServletResponseWrapper::addIntHeader().

virtual bool servlet::HttpServletResponse::containsHeader ( const std::string & name ) const [pure virtual]

Returns a boolean indicating whether the named response header has already been set.

Parameters:

name

the header name

Returns:: true if the named response header has already been set; false otherwise

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

Referenced by servlet::NoBodyResponse::containsHeader(), servlet::HttpServletResponseWrapper::containsHeader(), and servlet::HttpServlet::maybeSetLastModified().

virtual std::string servlet::HttpServletResponse::encodeRedirectURL ( const std::string & url ) [pure virtual]

Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. Because the rules for making this determination can differ from those used to decide whether to encode a normal link, this method is separated from the encodeURL method.

All URLs sent to the HttpServletResponse.sendRedirect method should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

Parameters:

url

the url to be encoded.

Returns:: the encoded URL if encoding is needed; the unchanged URL otherwise.

See also:: sendRedirect
encodeURL

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

Referenced by servlet::NoBodyResponse::encodeRedirectURL(), and servlet::HttpServletResponseWrapper::encodeRedirectURL().

virtual std::string servlet::HttpServletResponse::encodeURL ( const std::string & url ) [pure virtual]

Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. For example, if the browser supports cookies, or session tracking is turned off, URL encoding is unnecessary.

For robust session tracking, all URLs emitted by a servlet should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

Parameters:

url

the url to be encoded.

Returns:: the encoded URL if encoding is needed; the unchanged URL otherwise.

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

Referenced by servlet::NoBodyResponse::encodeURL(), and servlet::HttpServletResponseWrapper::encodeURL().

virtual void servlet::HttpServletResponse::sendError ( int sc ) [pure virtual]

Sends an error response to the client using the specified status code and clearing the buffer.

If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

Parameters:

sc

the error status code

Exceptions:

	IOException	If an input or output exception occurs
	IllegalStateException	If the response was committed before this method call

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

virtual void servlet::HttpServletResponse::sendError	(	int	sc,
		const std::string &	msg
	)			`[pure virtual]`

Sends an error response to the client using the specified status. The server defaults to creating the response to look like an HTML-formatted server error page containing the specified message, setting the content type to "text/html", leaving cookies and other headers unmodified.

If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back in preference to the suggested msg parameter.

If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

Parameters:

	sc	the error status code
	msg	the descriptive message

Exceptions:

	IOException	If an input or output exception occurs
	IllegalStateException	If the response was committed

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

Referenced by servlet::not_supported(), servlet::NoBodyResponse::sendError(), servlet::HttpServletResponseWrapper::sendError(), and servlet::HttpServlet::service().

virtual void servlet::HttpServletResponse::sendRedirect ( const std::string & location ) [pure virtual]

Sends a temporary redirect response to the client using the specified redirect location URL. This method can accept relative URLs; the servlet container must convert the relative URL to an absolute URL before sending the response to the client. If the location is relative without a leading '/' the container interprets it as relative to the current request URI. If the location is relative with a leading '/' the container interprets it as relative to the servlet container root.

If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

Parameters:

location

the redirect location URL

Exceptions:

	IOException	If an input or output exception occurs
	IllegalStateException	If the response was committed or if a partial URL is given and cannot be converted into a valid URL

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

Referenced by servlet::NoBodyResponse::sendRedirect(), and servlet::HttpServletResponseWrapper::sendRedirect().

virtual void servlet::HttpServletResponse::setDateHeader	(	const std::string &	name,
		long	date
	)			`[pure virtual]`

Sets a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.

Parameters:

	name	the name of the header to set
	date	the assigned date value

See also:: containsHeader
addDateHeader

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

Referenced by servlet::HttpServlet::maybeSetLastModified(), servlet::NoBodyResponse::setDateHeader(), and servlet::HttpServletResponseWrapper::setDateHeader().

virtual void servlet::HttpServletResponse::setHeader	(	const std::string &	name,
		const std::string &	value
	)			`[pure virtual]`

Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.

Parameters:

	name	the name of the header
	value	the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)

See also:: containsHeader
addHeader

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

Referenced by servlet::NoBodyResponse::setHeader(), and servlet::HttpServletResponseWrapper::setHeader().

virtual void servlet::HttpServletResponse::setIntHeader	(	const std::string &	name,
		int	value
	)			`[pure virtual]`

Sets a response header with the given name and integer value. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.

Parameters:

	name	the name of the header
	value	the assigned integer value

See also:: containsHeader
addIntHeader

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

Referenced by servlet::NoBodyResponse::setIntHeader(), and servlet::HttpServletResponseWrapper::setIntHeader().

virtual void servlet::HttpServletResponse::setStatus ( int sc ) [pure virtual]

Sets the status code for this response. This method is used to set the return status code when there is no error (for example, for the status codes SC_OK or SC_MOVED_TEMPORARILY). If there is an error, and the caller wishes to invoke an error-page defined in the web application, the sendError method should be used instead.

The container clears the buffer and sets the Location header, preserving cookies and other headers.

Parameters:

sc

the status code

See also:: sendError

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

Referenced by servlet::HttpServlet::service(), servlet::NoBodyResponse::setStatus(), and servlet::HttpServletResponseWrapper::setStatus().

Member Data Documentation

const int servlet::HttpServletResponse::SC_ACCEPTED = 202 [static]

Status code (202) indicating that a request was accepted for processing, but was not completed.

Definition at line 347 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_BAD_GATEWAY = 502 [static]

Status code (502) indicating that the HTTP server received an invalid response from a server it consulted when acting as a proxy or gateway.

Definition at line 566 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_BAD_REQUEST = 400 [static]

Status code (400) indicating the request sent by the client was syntactically incorrect.

Definition at line 437 of file HttpServletResponse.h.

Referenced by servlet::not_supported().

const int servlet::HttpServletResponse::SC_CONFLICT = 409 [static]

Status code (409) indicating that the request could not be completed due to a conflict with the current state of the resource.

Definition at line 494 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_CONTINUE = 100 [static]

Status code (100) indicating the client can continue.

Definition at line 323 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_CREATED = 201 [static]

Status code (201) indicating the request succeeded and created a new resource on the server.

Definition at line 341 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_EXPECTATION_FAILED = 417 [static]

Status code (417) indicating that the server could not meet the expectation given in the Expect request header.

Definition at line 547 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_FORBIDDEN = 403 [static]

Status code (403) indicating the server understood the request but refused to fulfill it.

Definition at line 454 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_FOUND = 302 [static]

Status code (302) indicating that the resource reside temporarily under a different URI. Since the redirection might be altered on occasion, the client should continue to use the Request-URI for future requests.(HTTP/1.1) To represent the status code (302), it is recommended to use this variable.

Definition at line 404 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_GATEWAY_TIMEOUT = 504 [static]

Status code (504) indicating that the server did not receive a timely response from the upstream server while acting as a gateway or proxy.

Definition at line 579 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_GONE = 410 [static]

Status code (410) indicating that the resource is no longer available at the server and no forwarding address is known. This condition SHOULD be considered permanent.

Definition at line 501 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_HTTP_VERSION_NOT_SUPPORTED = 505 [static]

Status code (505) indicating that the server does not support or refuses to support the HTTP protocol version that was used in the request message.

Definition at line 586 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_INTERNAL_SERVER_ERROR = 500 [static]

Status code (500) indicating an error inside the HTTP server which prevented it from fulfilling the request.

Definition at line 553 of file HttpServletResponse.h.

Referenced by container::ServletContainer::invalidRequest().

const int servlet::HttpServletResponse::SC_LENGTH_REQUIRED = 411 [static]

Status code (411) indicating that the request cannot be handled without a defined Content-Length.

Definition at line 507 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_METHOD_NOT_ALLOWED = 405 [static]

Status code (405) indicating that the method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

Definition at line 467 of file HttpServletResponse.h.

Referenced by servlet::not_supported().

const int servlet::HttpServletResponse::SC_MOVED_PERMANENTLY = 301 [static]

Status code (301) indicating that the resource has permanently moved to a new location, and that future references should use a new URI with their requests.

Definition at line 385 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_MOVED_TEMPORARILY = 302 [static]

Status code (302) indicating that the resource has temporarily moved to another location, but that future references should still use the original URI to access the resource.

This definition is being retained for backwards compatibility. SC_FOUND is now the preferred definition.

Definition at line 395 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_MULTIPLE_CHOICES = 300 [static]

Status code (300) indicating that the requested resource corresponds to any one of a set of representations, each with its own specific location.

Definition at line 378 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_NO_CONTENT = 204 [static]

Status code (204) indicating that the request succeeded but that there was no new information to return.

Definition at line 359 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_NON_AUTHORITATIVE_INFORMATION = 203 [static]

Status code (203) indicating that the meta information presented by the client did not originate from the server.

Definition at line 353 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_NOT_ACCEPTABLE = 406 [static]

Status code (406) indicating that the resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

Definition at line 475 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_NOT_FOUND = 404 [static]

Status code (404) indicating that the requested resource is not available.

Definition at line 460 of file HttpServletResponse.h.

Referenced by container::HttpServletResponseImpl::getStatusMessage(), and container::RequestHandler::noSuchServlet().

const int servlet::HttpServletResponse::SC_NOT_IMPLEMENTED = 501 [static]

Status code (501) indicating the HTTP server does not support the functionality needed to fulfill the request.

Definition at line 559 of file HttpServletResponse.h.

Referenced by servlet::HttpServlet::service().

const int servlet::HttpServletResponse::SC_NOT_MODIFIED = 304 [static]

Status code (304) indicating that a conditional GET operation found that the resource was available and not modified.

Definition at line 416 of file HttpServletResponse.h.

Referenced by servlet::HttpServlet::service().

const int servlet::HttpServletResponse::SC_OK = 200 [static]

Status code (200) indicating the request succeeded normally.

Definition at line 335 of file HttpServletResponse.h.

Referenced by container::HttpServletResponseImpl::getStatusMessage().

const int servlet::HttpServletResponse::SC_PARTIAL_CONTENT = 206 [static]

Status code (206) indicating that the server has fulfilled the partial GET request for the resource.

Definition at line 371 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_PAYMENT_REQUIRED = 402 [static]

Status code (402) reserved for future use.

Definition at line 448 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_PRECONDITION_FAILED = 412 [static]

Status code (412) indicating that the precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.

Definition at line 514 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_PROXY_AUTHENTICATION_REQUIRED = 407 [static]

Status code (407) indicating that the client MUST first authenticate itself with the proxy.

Definition at line 481 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_REQUEST_ENTITY_TOO_LARGE = 413 [static]

Status code (413) indicating that the server is refusing to process the request because the request entity is larger than the server is willing or able to process.

Definition at line 521 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_REQUEST_TIMEOUT = 408 [static]

Status code (408) indicating that the client did not produce a request within the time that the server was prepared to wait.

Definition at line 487 of file HttpServletResponse.h.

int servlet::HttpServletResponse::SC_REQUEST_URI_TOO_LONG

Status code (414) indicating that the server is refusing to service the request because the Request-URI is longer than the server is willing to static const interpret = 414.

Definition at line 528 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_REQUESTED_RANGE_NOT_SATISFIABLE = 416 [static]

Status code (416) indicating that the server cannot serve the requested byte range.

Definition at line 541 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_RESET_CONTENT = 205 [static]

Status code (205) indicating that the agent SHOULD reset the document view which caused the request to be sent.

Definition at line 365 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_SEE_OTHER = 303 [static]

Status code (303) indicating that the response to the request can be found under a different URI.

Definition at line 410 of file HttpServletResponse.h.

Referenced by container::HttpServletResponseImpl::sendRedirect().

const int servlet::HttpServletResponse::SC_SERVICE_UNAVAILABLE = 503 [static]

Status code (503) indicating that the HTTP server is temporarily overloaded, and unable to handle the request.

Definition at line 572 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_SWITCHING_PROTOCOLS = 101 [static]

Status code (101) indicating the server is switching protocols according to Upgrade header.

Definition at line 330 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_TEMPORARY_REDIRECT = 307 [static]

Status code (307) indicating that the requested resource resides temporarily under a different URI. The temporary URI SHOULD be given by the Location field in the response.

Definition at line 431 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_UNAUTHORIZED = 401 [static]

Status code (401) indicating that the request requires HTTP authentication.

Definition at line 443 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_UNSUPPORTED_MEDIA_TYPE = 415 [static]

Status code (415) indicating that the server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.

Definition at line 535 of file HttpServletResponse.h.

const int servlet::HttpServletResponse::SC_USE_PROXY = 305 [static]

Status code (305) indicating that the requested resource MUST be accessed through the proxy given by the Location field.

Definition at line 423 of file HttpServletResponse.h.

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

include/servlet/HttpServletResponse.h
src/libcserv/HttpServletResponse.cpp

CPPSERV

servlet::HttpServletResponse Class Reference

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation