org.openqa.jetty.jetty.servlet
Class ServletHttpResponse

java.lang.Object
  org.openqa.jetty.jetty.servlet.ServletHttpResponse

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class ServletHttpResponse
extends java.lang.Object
implements javax.servlet.http.HttpServletResponse

Servlet Response Wrapper. This class wraps a Jetty HTTP response as a 2.2 Servlet response. Note that this wrapper is not synchronized and if a response is to be operated on by multiple threads, then higher level synchronizations may be required.

Version:

$Id: ServletHttpResponse.java,v 1.65 2006/04/04 22:28:05 gregwilkins Exp $

Author:

Greg Wilkins (gregw)

Field Summary

static int	DISABLED
static int	NO_OUT
static int	OUTPUTSTREAM_OUT
static int	WRITER_OUT

Fields inherited from interface javax.servlet.http.HttpServletResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

ServletHttpResponse(ServletHttpRequest request, HttpResponse response)

Method Summary

void	addCookie(javax.servlet.http.Cookie cookie)
void	addDateHeader(java.lang.String name, long value)
void	addHeader(java.lang.String name, java.lang.String value)
void	addIntHeader(java.lang.String name, int value)
boolean	containsHeader(java.lang.String name)
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)
void	flushBuffer()
int	getBufferSize()
java.lang.String	getCharacterEncoding()
java.lang.String	getContentType()
java.util.Locale	getLocale()
javax.servlet.ServletOutputStream	getOutputStream()
java.io.PrintWriter	getWriter()
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	sendError(int status)
void	sendError(int status, java.lang.String message)
void	sendRedirect(java.lang.String url)
void	setBufferSize(int size)
void	setCharacterEncoding(java.lang.String encoding)
void	setContentLength(int len)
void	setContentType(java.lang.String contentType)
void	setDateHeader(java.lang.String name, long value)
void	setHeader(java.lang.String name, java.lang.String value)
void	setIntHeader(java.lang.String name, int value)
void	setLocale(java.util.Locale locale) Sets the locale of the response, setting the headers (including the Content-Type's charset) as appropriate.
void	setStatus(int status)
void	setStatus(int status, java.lang.String message) Deprecated. As of version 2.1 of the Servlet spec. To set a status code use setStatus(int), to send an error with a description use sendError(int, String). Sets the status code and message for this response.
java.lang.String	toString()
static ServletHttpResponse	unwrap(javax.servlet.ServletResponse response) Unwrap a ServletResponse.

Methods inherited from class java.lang.Object

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

Field Detail

DISABLED

public static final int DISABLED

See Also:

Constant Field Values

NO_OUT

public static final int NO_OUT

See Also:

Constant Field Values

OUTPUTSTREAM_OUT

public static final int OUTPUTSTREAM_OUT

See Also:

Constant Field Values

WRITER_OUT

public static final int WRITER_OUT

See Also:

Constant Field Values

Constructor Detail

ServletHttpResponse

public ServletHttpResponse(ServletHttpRequest request,
                           HttpResponse response)

Method Detail

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface javax.servlet.ServletResponse

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface javax.servlet.ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface javax.servlet.ServletResponse

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Throws:

java.io.IOException

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface javax.servlet.ServletResponse

reset

public void reset()

Specified by:

reset in interface javax.servlet.ServletResponse

setLocale

public void setLocale(java.util.Locale locale)

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.

Specified by:

setLocale in interface javax.servlet.ServletResponse

Parameters:

locale - the Locale of the response

See Also:

getLocale()

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletResponse

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

containsHeader

public boolean containsHeader(java.lang.String name)

Specified by:

containsHeader in interface javax.servlet.http.HttpServletResponse

encodeURL

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

Specified by:

encodeURL in interface javax.servlet.http.HttpServletResponse

encodeRedirectURL

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

Specified by:

encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

encodeUrl

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

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

Specified by:

encodeUrl in interface javax.servlet.http.HttpServletResponse

encodeRedirectUrl

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

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

Specified by:

encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse

sendError

public void sendError(int status,
                      java.lang.String message)
               throws java.io.IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Throws:

java.io.IOException

sendError

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

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Throws:

java.io.IOException

sendRedirect

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

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Throws:

java.io.IOException

setDateHeader

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

Specified by:

setDateHeader in interface javax.servlet.http.HttpServletResponse

setHeader

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

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

setIntHeader

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

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

addDateHeader

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

Specified by:

addDateHeader in interface javax.servlet.http.HttpServletResponse

addHeader

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

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

addIntHeader

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

Specified by:

addIntHeader in interface javax.servlet.http.HttpServletResponse

setStatus

public void setStatus(int status)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

setStatus

public void setStatus(int status,
                      java.lang.String message)

Deprecated. As of version 2.1 of the Servlet spec. To set a status code use setStatus(int), to send an error with a description use sendError(int, String). Sets the status code and message for this response.

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Parameters:

status - the status code

message - the status message

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

getWriter

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

Specified by:

getWriter in interface javax.servlet.ServletResponse

Throws:

java.io.IOException

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface javax.servlet.ServletResponse

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletResponse

setContentType

public void setContentType(java.lang.String contentType)

Specified by:

setContentType in interface javax.servlet.ServletResponse

setCharacterEncoding

public void setCharacterEncoding(java.lang.String encoding)

Specified by:

setCharacterEncoding in interface javax.servlet.ServletResponse

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.servlet.ServletResponse

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

unwrap

public static ServletHttpResponse unwrap(javax.servlet.ServletResponse response)

Unwrap a ServletResponse.

Parameters:

response -

Returns:

The core ServletHttpResponse which must be the underlying response object

See Also:

ServletResponseWrapper, HttpServletResponseWrapper