org.apache.cocoon.environment.http
Class HttpResponse

java.lang.Object
  extended byorg.apache.cocoon.environment.impl.AbstractResponse
      extended byorg.apache.cocoon.environment.http.HttpResponse
All Implemented Interfaces:
HttpServletResponse, org.apache.cocoon.environment.Response, ServletResponse

public final class HttpResponse
extends AbstractResponse
implements org.apache.cocoon.environment.Response

Implements the Response interface to provide response functionality in the HTTP servlets environment.

Version:
$Id: HttpResponse.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary
 
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
protected HttpResponse(HttpServletResponse res)
          Creates a HttpServletResponse based on a real HttpServletResponse object
 
Method Summary
 void addCookie(Cookie cookie)
           
 void addCookie(org.apache.cocoon.environment.Cookie cookie)
           
 void addDateHeader(String name, long date)
           
 void addHeader(String name, String value)
           
 void addIntHeader(String name, int value)
           
 boolean containsHeader(String name)
           
 org.apache.cocoon.environment.Cookie createCocoonCookie(String name, String value)
           
 Cookie createCookie(String name, String value)
          Create a new cookie which is not added to the response
 String encodeRedirectUrl(String url)
          Deprecated. As of version 2.1, use encodeRedirectURL(String url) instead
 String encodeRedirectURL(String url)
           
 String encodeUrl(String url)
          Deprecated. As of version 2.1, use encodeURL(String url) instead
 String encodeURL(String url)
           
 void flushBuffer()
           
 int getBufferSize()
           
 String getCharacterEncoding()
           
 Locale getLocale()
           
 ServletOutputStream getOutputStream()
           
 PrintWriter getWriter()
           
 boolean isCommitted()
           
 void reset()
           
 void sendError(int sc)
           
 void sendError(int sc, String msg)
           
 void sendPermanentRedirect(String location)
           
 void sendRedirect(String location)
           
 void setBufferSize(int size)
           
 void setContentLength(int len)
           
 void setContentType(String type)
           
 void setDateHeader(String name, long date)
           
 void setHeader(String name, String value)
           
 void setIntHeader(String name, int value)
           
 void setLocale(Locale loc)
           
 void setStatus(int sc)
           
 void setStatus(int sc, 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 org.apache.cocoon.environment.impl.AbstractResponse
getContentType, resetBuffer, setCharacterEncoding
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.servlet.ServletResponse
getContentType, resetBuffer, setCharacterEncoding
 

Constructor Detail

HttpResponse

protected HttpResponse(HttpServletResponse res)
Creates a HttpServletResponse based on a real HttpServletResponse object

Method Detail

createCookie

public Cookie createCookie(String name,
                           String value)
Create a new cookie which is not added to the response

Specified by:
createCookie in interface org.apache.cocoon.environment.Response

addCookie

public void addCookie(Cookie cookie)
Specified by:
addCookie in interface org.apache.cocoon.environment.Response

createCocoonCookie

public org.apache.cocoon.environment.Cookie createCocoonCookie(String name,
                                                               String value)
Specified by:
createCocoonCookie in interface org.apache.cocoon.environment.Response

addCookie

public void addCookie(org.apache.cocoon.environment.Cookie cookie)
Specified by:
addCookie in interface org.apache.cocoon.environment.Response

containsHeader

public boolean containsHeader(String name)
Specified by:
containsHeader in interface org.apache.cocoon.environment.Response

encodeURL

public String encodeURL(String url)
Specified by:
encodeURL in interface org.apache.cocoon.environment.Response

encodeRedirectURL

public String encodeRedirectURL(String url)
Specified by:
encodeRedirectURL in interface HttpServletResponse
Overrides:
encodeRedirectURL in class AbstractResponse

sendError

public void sendError(int sc,
                      String msg)
               throws IOException
Specified by:
sendError in interface HttpServletResponse
Overrides:
sendError in class AbstractResponse
Throws:
IOException

sendError

public void sendError(int sc)
               throws IOException
Specified by:
sendError in interface HttpServletResponse
Overrides:
sendError in class AbstractResponse
Throws:
IOException

sendRedirect

public void sendRedirect(String location)
                  throws IOException
Specified by:
sendRedirect in interface HttpServletResponse
Overrides:
sendRedirect in class AbstractResponse
Throws:
IOException

sendPermanentRedirect

public void sendPermanentRedirect(String location)
                           throws IOException
Throws:
IOException

setDateHeader

public void setDateHeader(String name,
                          long date)
Specified by:
setDateHeader in interface org.apache.cocoon.environment.Response

addDateHeader

public void addDateHeader(String name,
                          long date)
Specified by:
addDateHeader in interface org.apache.cocoon.environment.Response

setHeader

public void setHeader(String name,
                      String value)
Specified by:
setHeader in interface org.apache.cocoon.environment.Response

addHeader

public void addHeader(String name,
                      String value)
Specified by:
addHeader in interface org.apache.cocoon.environment.Response

setIntHeader

public void setIntHeader(String name,
                         int value)
Specified by:
setIntHeader in interface org.apache.cocoon.environment.Response

addIntHeader

public void addIntHeader(String name,
                         int value)
Specified by:
addIntHeader in interface org.apache.cocoon.environment.Response

setStatus

public void setStatus(int sc)
Specified by:
setStatus in interface HttpServletResponse
Overrides:
setStatus in class AbstractResponse

encodeUrl

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

Specified by:
encodeUrl in interface HttpServletResponse
Overrides:
encodeUrl in class AbstractResponse

encodeRedirectUrl

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

Specified by:
encodeRedirectUrl in interface HttpServletResponse
Overrides:
encodeRedirectUrl in class AbstractResponse

setStatus

public void setStatus(int sc,
                      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).

Specified by:
setStatus in interface HttpServletResponse
Overrides:
setStatus in class AbstractResponse

getCharacterEncoding

public String getCharacterEncoding()
Specified by:
getCharacterEncoding in interface org.apache.cocoon.environment.Response

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException
Specified by:
getOutputStream in interface ServletResponse
Overrides:
getOutputStream in class AbstractResponse
Throws:
IOException

getWriter

public PrintWriter getWriter()
                      throws IOException
Specified by:
getWriter in interface ServletResponse
Overrides:
getWriter in class AbstractResponse
Throws:
IOException

setContentLength

public void setContentLength(int len)
Specified by:
setContentLength in interface ServletResponse
Overrides:
setContentLength in class AbstractResponse

setContentType

public void setContentType(String type)
Specified by:
setContentType in interface ServletResponse
Overrides:
setContentType in class AbstractResponse

setBufferSize

public void setBufferSize(int size)
Specified by:
setBufferSize in interface ServletResponse
Overrides:
setBufferSize in class AbstractResponse

getBufferSize

public int getBufferSize()
Specified by:
getBufferSize in interface ServletResponse
Overrides:
getBufferSize in class AbstractResponse

flushBuffer

public void flushBuffer()
                 throws IOException
Specified by:
flushBuffer in interface ServletResponse
Overrides:
flushBuffer in class AbstractResponse
Throws:
IOException

isCommitted

public boolean isCommitted()
Specified by:
isCommitted in interface ServletResponse
Overrides:
isCommitted in class AbstractResponse

reset

public void reset()
Specified by:
reset in interface ServletResponse
Overrides:
reset in class AbstractResponse

setLocale

public void setLocale(Locale loc)
Specified by:
setLocale in interface org.apache.cocoon.environment.Response

getLocale

public Locale getLocale()
Specified by:
getLocale in interface org.apache.cocoon.environment.Response


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.