com.xpn.xwiki.web
Class XWikiServletResponseStub

java.lang.Object
  extended by com.xpn.xwiki.web.XWikiServletResponseStub
All Implemented Interfaces:
XWikiResponse, HttpServletResponse, ServletResponse

public class XWikiServletResponseStub
extends Object
implements XWikiResponse

This stub is intended to simulate a servlet request in a daemon context, in order to be able to create a custom XWiki context. This trick is used in to give a daemon thread access to the XWiki api.


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
XWikiServletResponseStub()
           
 
Method Summary
 void addCookie(Cookie cookie)
           
 void addDateHeader(String name, long date)
           
 void addHeader(String name, String value)
           
 void addIntHeader(String name, int value)
           
 void addProperty(String arg0, String arg1)
           
 boolean containsHeader(String name)
           
 PortletURL createActionURL()
           
 PortletURL createRenderURL()
           
 String encodeRedirectUrl(String url)
           
 String encodeRedirectURL(String url)
           
 String encodeUrl(String url)
           
 String encodeURL(String url)
           
 void flushBuffer()
           
 int getBufferSize()
           
 String getCharacterEncoding()
           
 String getContentType()
           
 HttpServletResponse getHttpServletResponse()
           
 Locale getLocale()
           
 String getNamespace()
           
 ServletOutputStream getOutputStream()
           
 OutputStream getPortletOutputStream()
           
 PrintWriter getWriter()
           
 boolean isCommitted()
           
 void removeCookie(String cookieName, XWikiRequest request)
           
 void reset()
           
 void resetBuffer()
           
 void sendError(int sc)
           
 void sendError(int sc, String msg)
           
 void sendRedirect(String location)
           
 void setBufferSize(int size)
           
 void setCharacterEncoding(String s)
           
 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 setOutpuStream(OutputStream outputStream)
           
 void setPortletMode(PortletMode arg0)
           
 void setProperty(String arg0, String arg1)
           
 void setRenderParameter(String arg0, String arg1)
           
 void setRenderParameter(String arg0, String[] arg1)
           
 void setRenderParameters(Map arg0)
           
 void setStatus(int sc)
           
 void setStatus(int sc, String sm)
           
 void setTitle(String arg0)
           
 void setWindowState(WindowState arg0)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XWikiServletResponseStub

public XWikiServletResponseStub()
Method Detail

setOutpuStream

public void setOutpuStream(OutputStream outputStream)

getHttpServletResponse

public HttpServletResponse getHttpServletResponse()
Specified by:
getHttpServletResponse in interface XWikiResponse

setCharacterEncoding

public void setCharacterEncoding(String s)
Specified by:
setCharacterEncoding in interface XWikiResponse
Specified by:
setCharacterEncoding in interface ServletResponse

removeCookie

public void removeCookie(String cookieName,
                         XWikiRequest request)
Specified by:
removeCookie in interface XWikiResponse

addCookie

public void addCookie(Cookie cookie)
Specified by:
addCookie in interface HttpServletResponse

containsHeader

public boolean containsHeader(String name)
Specified by:
containsHeader in interface HttpServletResponse

encodeURL

public String encodeURL(String url)
Specified by:
encodeURL in interface HttpServletResponse

encodeRedirectURL

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

encodeUrl

public String encodeUrl(String url)
Specified by:
encodeUrl in interface HttpServletResponse

encodeRedirectUrl

public String encodeRedirectUrl(String url)
Specified by:
encodeRedirectUrl in interface HttpServletResponse

sendError

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

sendError

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

sendRedirect

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

setDateHeader

public void setDateHeader(String name,
                          long date)
Specified by:
setDateHeader in interface HttpServletResponse

addDateHeader

public void addDateHeader(String name,
                          long date)
Specified by:
addDateHeader in interface HttpServletResponse

setHeader

public void setHeader(String name,
                      String value)
Specified by:
setHeader in interface HttpServletResponse

addHeader

public void addHeader(String name,
                      String value)
Specified by:
addHeader in interface HttpServletResponse

setIntHeader

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

addIntHeader

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

setStatus

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

setStatus

public void setStatus(int sc,
                      String sm)
Specified by:
setStatus in interface HttpServletResponse

getCharacterEncoding

public String getCharacterEncoding()
Specified by:
getCharacterEncoding in interface ServletResponse

getContentType

public String getContentType()
Specified by:
getContentType in interface ServletResponse

getOutputStream

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

getWriter

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

setContentLength

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

setContentType

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

setBufferSize

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

getBufferSize

public int getBufferSize()
Specified by:
getBufferSize in interface ServletResponse

flushBuffer

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

resetBuffer

public void resetBuffer()
Specified by:
resetBuffer in interface ServletResponse

isCommitted

public boolean isCommitted()
Specified by:
isCommitted in interface ServletResponse

reset

public void reset()
Specified by:
reset in interface ServletResponse

setLocale

public void setLocale(Locale loc)
Specified by:
setLocale in interface ServletResponse

getLocale

public Locale getLocale()
Specified by:
getLocale in interface ServletResponse

createActionURL

public PortletURL createActionURL()

createRenderURL

public PortletURL createRenderURL()

getNamespace

public String getNamespace()

getPortletOutputStream

public OutputStream getPortletOutputStream()
                                    throws IOException
Throws:
IOException

setTitle

public void setTitle(String arg0)

addProperty

public void addProperty(String arg0,
                        String arg1)

setProperty

public void setProperty(String arg0,
                        String arg1)

setPortletMode

public void setPortletMode(PortletMode arg0)
                    throws PortletModeException
Throws:
PortletModeException

setRenderParameter

public void setRenderParameter(String arg0,
                               String arg1)

setRenderParameter

public void setRenderParameter(String arg0,
                               String[] arg1)

setRenderParameters

public void setRenderParameters(Map arg0)

setWindowState

public void setWindowState(WindowState arg0)
                    throws WindowStateException
Throws:
WindowStateException