org.apache.cocoon.environment.http
Class HttpResponse

java.lang.Object
  |
  +--org.apache.cocoon.environment.http.HttpResponse

All Implemented Interfaces:

Response

public final class HttpResponse

extends java.lang.Object

implements Response

Implements the HttpServletResponse interface to provide HTTP-specific functionality in sending a response. For example, it has methods to access HTTP headers and cookies.

Version:

CVS $Id: HttpResponse.java,v 1.4.2.1 2002/12/05 14:07:56 cziegeler Exp $

Author:

?

Constructor Summary

protected

HttpResponse(javax.servlet.http.HttpServletResponse res) Creates a HttpServletResponse based on a real HttpServletResponse object

Method Summary

void	addCookie(Cookie cookie) Adds the specified cookie to the response.
void	addDateHeader(java.lang.String name, long date) Adds a response header with the given name and date-value.
void	addHeader(java.lang.String name, java.lang.String value) Adds a response header with the given name and value.
void	addIntHeader(java.lang.String name, int value) Adds a response header with the given name and int value.
boolean	containsHeader(java.lang.String name) Returns a boolean indicating whether the named response header has already been set.
Cookie	createCookie(java.lang.String name, java.lang.String value) Create a new cookie which is not added to the response
java.lang.String	encodeRedirectUrl(java.lang.String url) Deprecated. As of version 2.1, use encodeRedirectURL(String url) instead
java.lang.String	encodeRedirectURL(java.lang.String url)
java.lang.String	encodeUrl(java.lang.String url) Deprecated. As of version 2.1, use encodeURL(String url) instead
java.lang.String	encodeURL(java.lang.String url) Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
void	flushBuffer()
int	getBufferSize()
java.lang.String	getCharacterEncoding() Returns the name of the charset used for the MIME body sent in this response.
java.util.Locale	getLocale() Returns the locale assigned to the response.
javax.servlet.ServletOutputStream	getOutputStream()
java.io.PrintWriter	getWriter()
boolean	isCommitted()
void	reset()
void	sendError(int sc)
void	sendError(int sc, java.lang.String msg)
void	sendRedirect(java.lang.String location)
void	setBufferSize(int size)
void	setContentLength(int len)
void	setContentType(java.lang.String type)
void	setDateHeader(java.lang.String name, long date) Sets a response header with the given name and date-value.
void	setHeader(java.lang.String name, java.lang.String value) Sets a response header with the given name and value.
void	setIntHeader(java.lang.String name, int value) Sets a response header with the given name and int value.
void	setLocale(java.util.Locale loc) Sets the locale of the response, setting the headers (including the Content-Type's charset) as appropriate.
void	setStatus(int sc)
void	setStatus(int sc, java.lang.String sm) Deprecated. As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use setStatus(int), to send an error with a description use sendError(int, String).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpResponse

protected HttpResponse(javax.servlet.http.HttpServletResponse res)

Creates a HttpServletResponse based on a real HttpServletResponse object

Method Detail

createCookie

public Cookie createCookie(java.lang.String name,
                           java.lang.String value)

Create a new cookie which is not added to the response

Specified by:

createCookie in interface Response

Following copied from interface: org.apache.cocoon.environment.Response

Parameters:

name - a String specifying the name of the cookie

value - a String specifying the value of the cookie

Throws:

java.lang.IllegalArgumentException - if the cookie name contains illegal characters (for example, a comma, space, or semicolon) or it is one of the tokens reserved for use by the cookie protocol

addCookie

public void addCookie(Cookie cookie)

Description copied from interface: Response

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

Specified by:

addCookie in interface Response

Following copied from interface: org.apache.cocoon.environment.Response

Parameters:

cookie - the Cookie to return to the client

containsHeader

public boolean containsHeader(java.lang.String name)

Description copied from interface: Response

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

Specified by:

containsHeader in interface Response

Following copied from interface: org.apache.cocoon.environment.Response

Parameters:

name - the header name

Returns:

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

encodeURL

public java.lang.String encodeURL(java.lang.String url)

Description copied from interface: Response

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.

Specified by:

encodeURL in interface Response

Following copied from interface: org.apache.cocoon.environment.Response

Parameters:

url - the url to be encoded.

Returns:

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

encodeRedirectURL

public java.lang.String encodeRedirectURL(java.lang.String url)

sendError

public void sendError(int sc,
                      java.lang.String msg)
               throws java.io.IOException

sendError

public void sendError(int sc)
               throws java.io.IOException

sendRedirect

public void sendRedirect(java.lang.String location)
                  throws java.io.IOException

setDateHeader

public void setDateHeader(java.lang.String name,
                          long date)

Description copied from interface: Response

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.

Specified by:

setDateHeader in interface Response

Following copied from interface: org.apache.cocoon.environment.Response

Parameters:

name - the name of the header to set

date - the assigned date value

See Also:

Response.containsHeader(java.lang.String), Response.addDateHeader(java.lang.String, long)

addDateHeader

public void addDateHeader(java.lang.String name,
                          long date)

Description copied from interface: Response

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.

Specified by:

addDateHeader in interface Response

Following copied from interface: org.apache.cocoon.environment.Response

Parameters:

name - the name of the header to set

date - the additional date value

See Also:

Response.setDateHeader(java.lang.String, long)

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)

Description copied from interface: Response

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.

Specified by:

setHeader in interface Response

Following copied from interface: org.apache.cocoon.environment.Response

Parameters:

name - the name of the header

value - the header value

See Also:

Response.containsHeader(java.lang.String), Response.addHeader(java.lang.String, java.lang.String)

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

Description copied from interface: Response

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

Specified by:

addHeader in interface Response

Following copied from interface: org.apache.cocoon.environment.Response

Parameters:

name - the name of the header

value - the additional header value

See Also:

Response.setHeader(java.lang.String, java.lang.String)

setIntHeader

public void setIntHeader(java.lang.String name,
                         int value)

Description copied from interface: Response

Sets a response header with the given name and int 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.

Specified by:

setIntHeader in interface Response

Following copied from interface: org.apache.cocoon.environment.Response

Parameters:

name - the name of the header to set

value - the assigned int value

See Also:

Response.containsHeader(java.lang.String), Response.addIntHeader(java.lang.String, int)

addIntHeader

public void addIntHeader(java.lang.String name,
                         int value)

Description copied from interface: Response

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

Specified by:

addIntHeader in interface Response

Following copied from interface: org.apache.cocoon.environment.Response

Parameters:

name - the name of the header to set

value - the additional int value

See Also:

Response.setIntHeader(java.lang.String, int)

setStatus

public void setStatus(int sc)

encodeUrl

public java.lang.String encodeUrl(java.lang.String url)

Deprecated. As of version 2.1, use encodeURL(String url) instead

encodeRedirectUrl

public java.lang.String encodeRedirectUrl(java.lang.String url)

Deprecated. As of version 2.1, use encodeRedirectURL(String url) instead

setStatus

public void setStatus(int sc,
                      java.lang.String sm)

Deprecated. As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use setStatus(int), to send an error with a description use sendError(int, String).

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Description copied from interface: Response

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.

Specified by:

getCharacterEncoding in interface Response

Following copied from interface: org.apache.cocoon.environment.Response

Returns:

a String specifying the name of the charset, for example, ISO-8859-1

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException

getWriter

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

setContentLength

public void setContentLength(int len)

setContentType

public void setContentType(java.lang.String type)

setBufferSize

public void setBufferSize(int size)

getBufferSize

public int getBufferSize()

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

isCommitted

public boolean isCommitted()

reset

public void reset()

setLocale

public void setLocale(java.util.Locale loc)

Description copied from interface: Response

Sets the locale of the response, setting the headers (including the Content-Type's charset) as appropriate. By default, the response locale is the default locale for the server.

Specified by:

setLocale in interface Response

Following copied from interface: org.apache.cocoon.environment.Response

Parameters:

loc - the locale of the response

See Also:

Response.getLocale()

getLocale

public java.util.Locale getLocale()

Description copied from interface: Response

Returns the locale assigned to the response.

Specified by:

getLocale in interface Response

Following copied from interface: org.apache.cocoon.environment.Response

See Also:

Response.setLocale(java.util.Locale)