com.xpn.xwiki.web
Class XWikiServletResponse

java.lang.Object
  extended by com.xpn.xwiki.web.XWikiServletResponse
All Implemented Interfaces:
XWikiResponse, javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class XWikiServletResponse
extends Object
implements XWikiResponse


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
XWikiServletResponse(javax.servlet.http.HttpServletResponse response)
           
 
Method Summary
 void addCookie(javax.servlet.http.Cookie cookie)
           
 void addCookie(String cookieName, String cookieValue, int age)
           
 void addDateHeader(String name, long value)
           
 void addHeader(String name, String value)
           
 void addIntHeader(String name, int value)
           
 boolean containsHeader(String name)
           
 String encodeRedirectUrl(String s)
          Deprecated.  
 String encodeRedirectURL(String s)
           
 String encodeUrl(String s)
          Deprecated.  
 String encodeURL(String s)
           
 void flushBuffer()
           
 int getBufferSize()
           
 String getCharacterEncoding()
           
 String getContentType()
           
 javax.servlet.http.HttpServletResponse getHttpServletResponse()
           
 Locale getLocale()
           
 javax.servlet.ServletOutputStream getOutputStream()
           
 int getStatus()
          Note that in Servlet 3.0 there's a better way to get the servlet response's code by calling getStatus().
 PrintWriter getWriter()
           
 boolean isCommitted()
           
 void removeCookie(String cookieName, XWikiRequest request)
          Remove a cookie.
 void reset()
           
 void resetBuffer()
           
 void sendError(int i)
           
 void sendError(int i, String s)
           
 void sendRedirect(String redirect)
           
 void setBufferSize(int i)
           
 void setCharacterEncoding(String s)
           
 void setContentLength(int length)
           
 void setContentType(String type)
           
 void setDateHeader(String name, long value)
           
 void setHeader(String name, String value)
           
 void setIntHeader(String name, int value)
           
 void setLocale(Locale locale)
           
 void setStatus(int i)
           
 void setStatus(int i, String s)
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XWikiServletResponse

public XWikiServletResponse(javax.servlet.http.HttpServletResponse response)
Method Detail

getStatus

public int getStatus()
Note that in Servlet 3.0 there's a better way to get the servlet response's code by calling getStatus().

Returns:
the HTTP response status (200, 302, etc)
Since:
5.0M1

getHttpServletResponse

public javax.servlet.http.HttpServletResponse getHttpServletResponse()
Specified by:
getHttpServletResponse in interface XWikiResponse

sendRedirect

public void sendRedirect(String redirect)
                  throws IOException
Specified by:
sendRedirect in interface javax.servlet.http.HttpServletResponse
Throws:
IOException

setContentType

public void setContentType(String type)
Specified by:
setContentType in interface javax.servlet.ServletResponse

setBufferSize

public void setBufferSize(int i)
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 IOException
Specified by:
flushBuffer in interface javax.servlet.ServletResponse
Throws:
IOException

resetBuffer

public void resetBuffer()
Specified by:
resetBuffer in interface javax.servlet.ServletResponse

isCommitted

public boolean isCommitted()
Specified by:
isCommitted in interface javax.servlet.ServletResponse

reset

public void reset()
Specified by:
reset in interface javax.servlet.ServletResponse

setContentLength

public void setContentLength(int length)
Specified by:
setContentLength in interface javax.servlet.ServletResponse

getCharacterEncoding

public String getCharacterEncoding()
Specified by:
getCharacterEncoding in interface javax.servlet.ServletResponse

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException
Specified by:
getOutputStream in interface javax.servlet.ServletResponse
Throws:
IOException

getWriter

public PrintWriter getWriter()
                      throws IOException
Specified by:
getWriter in interface javax.servlet.ServletResponse
Throws:
IOException

setCharacterEncoding

public void setCharacterEncoding(String s)
Specified by:
setCharacterEncoding in interface javax.servlet.ServletResponse

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)
Specified by:
addCookie in interface javax.servlet.http.HttpServletResponse

addCookie

public void addCookie(String cookieName,
                      String cookieValue,
                      int age)

removeCookie

public void removeCookie(String cookieName,
                         XWikiRequest request)
Remove a cookie.

Specified by:
removeCookie in interface XWikiResponse
Parameters:
request - The servlet request needed to find the cookie to remove
cookieName - The name of the cookie that must be removed.

setLocale

public void setLocale(Locale locale)
Specified by:
setLocale in interface javax.servlet.ServletResponse

getLocale

public Locale getLocale()
Specified by:
getLocale in interface javax.servlet.ServletResponse

setDateHeader

public void setDateHeader(String name,
                          long value)
Specified by:
setDateHeader in interface javax.servlet.http.HttpServletResponse

setIntHeader

public void setIntHeader(String name,
                         int value)
Specified by:
setIntHeader in interface javax.servlet.http.HttpServletResponse

setHeader

public void setHeader(String name,
                      String value)
Specified by:
setHeader in interface javax.servlet.http.HttpServletResponse

addHeader

public void addHeader(String name,
                      String value)
Specified by:
addHeader in interface javax.servlet.http.HttpServletResponse

addDateHeader

public void addDateHeader(String name,
                          long value)
Specified by:
addDateHeader in interface javax.servlet.http.HttpServletResponse

addIntHeader

public void addIntHeader(String name,
                         int value)
Specified by:
addIntHeader in interface javax.servlet.http.HttpServletResponse

setStatus

public void setStatus(int i)
Specified by:
setStatus in interface javax.servlet.http.HttpServletResponse

setStatus

@Deprecated
public void setStatus(int i,
                                 String s)
Deprecated. 

Specified by:
setStatus in interface javax.servlet.http.HttpServletResponse

containsHeader

public boolean containsHeader(String name)
Specified by:
containsHeader in interface javax.servlet.http.HttpServletResponse

encodeURL

public String encodeURL(String s)
Specified by:
encodeURL in interface javax.servlet.http.HttpServletResponse

encodeRedirectURL

public String encodeRedirectURL(String s)
Specified by:
encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

encodeUrl

@Deprecated
public String encodeUrl(String s)
Deprecated. 

Specified by:
encodeUrl in interface javax.servlet.http.HttpServletResponse

encodeRedirectUrl

@Deprecated
public String encodeRedirectUrl(String s)
Deprecated. 

Specified by:
encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse

sendError

public void sendError(int i,
                      String s)
               throws IOException
Specified by:
sendError in interface javax.servlet.http.HttpServletResponse
Throws:
IOException

sendError

public void sendError(int i)
               throws IOException
Specified by:
sendError in interface javax.servlet.http.HttpServletResponse
Throws:
IOException

getContentType

public String getContentType()
Specified by:
getContentType in interface javax.servlet.ServletResponse


Copyright © 2004–2014 XWiki. All rights reserved.