Class XWikiServletRequestStub

  • All Implemented Interfaces:
    XWikiRequest, javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

    public class XWikiServletRequestStub
    extends Object
    implements XWikiRequest
    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.
    Version:
    $Id: c090bf79e022a31ee16fd6fcea1bc5a1d5c54dde $
    • Method Detail

      • setContextPath

        public void setContextPath​(String contextPath)
      • setHost

        public void setHost​(String host)
      • setScheme

        public void setScheme​(String scheme)
      • setrequestURL

        public void setrequestURL​(StringBuffer requestURL)
        Since:
        7.1RC1, 6.4.5
      • setRequestURI

        public void setRequestURI​(String requestURI)
        Since:
        7.2M2
      • setServerName

        public void setServerName​(String serverName)
        Since:
        7.1RC1, 6.4.5
      • getHeader

        public String getHeader​(String headerName)
        Specified by:
        getHeader in interface javax.servlet.http.HttpServletRequest
      • put

        public void put​(String key,
                        String value)
        Since:
        7.3M1
      • getAuthType

        public String getAuthType()
        Specified by:
        getAuthType in interface javax.servlet.http.HttpServletRequest
      • getCookies

        public javax.servlet.http.Cookie[] getCookies()
        Specified by:
        getCookies in interface javax.servlet.http.HttpServletRequest
      • getDateHeader

        public long getDateHeader​(String s)
        Specified by:
        getDateHeader in interface javax.servlet.http.HttpServletRequest
      • getHeaders

        public Enumeration<String> getHeaders​(String headerName)
        Specified by:
        getHeaders in interface javax.servlet.http.HttpServletRequest
      • getHeaderNames

        public Enumeration<String> getHeaderNames()
        Specified by:
        getHeaderNames in interface javax.servlet.http.HttpServletRequest
      • getIntHeader

        public int getIntHeader​(String s)
        Specified by:
        getIntHeader in interface javax.servlet.http.HttpServletRequest
      • getMethod

        public String getMethod()
        Specified by:
        getMethod in interface javax.servlet.http.HttpServletRequest
      • getPathInfo

        public String getPathInfo()
        Specified by:
        getPathInfo in interface javax.servlet.http.HttpServletRequest
      • getPathTranslated

        public String getPathTranslated()
        Specified by:
        getPathTranslated in interface javax.servlet.http.HttpServletRequest
      • getContextPath

        public String getContextPath()
        Specified by:
        getContextPath in interface javax.servlet.http.HttpServletRequest
      • getQueryString

        public String getQueryString()
        Specified by:
        getQueryString in interface javax.servlet.http.HttpServletRequest
      • getRemoteUser

        public String getRemoteUser()
        Specified by:
        getRemoteUser in interface javax.servlet.http.HttpServletRequest
      • isUserInRole

        public boolean isUserInRole​(String s)
        Specified by:
        isUserInRole in interface javax.servlet.http.HttpServletRequest
      • getUserPrincipal

        public Principal getUserPrincipal()
        Specified by:
        getUserPrincipal in interface javax.servlet.http.HttpServletRequest
      • getRequestedSessionId

        public String getRequestedSessionId()
        Specified by:
        getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
      • getRequestURI

        public String getRequestURI()
        Specified by:
        getRequestURI in interface javax.servlet.http.HttpServletRequest
      • getRequestURL

        public StringBuffer getRequestURL()
        Specified by:
        getRequestURL in interface javax.servlet.http.HttpServletRequest
      • getServletPath

        public String getServletPath()
        Specified by:
        getServletPath in interface javax.servlet.http.HttpServletRequest
      • getSession

        public javax.servlet.http.HttpSession getSession​(boolean b)
        Specified by:
        getSession in interface javax.servlet.http.HttpServletRequest
      • changeSessionId

        public String changeSessionId()
        Specified by:
        changeSessionId in interface javax.servlet.http.HttpServletRequest
      • getSession

        public javax.servlet.http.HttpSession getSession()
        Specified by:
        getSession in interface javax.servlet.http.HttpServletRequest
      • isRequestedSessionIdValid

        public boolean isRequestedSessionIdValid()
        Specified by:
        isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
      • isRequestedSessionIdFromCookie

        public boolean isRequestedSessionIdFromCookie()
        Specified by:
        isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
      • isRequestedSessionIdFromURL

        public boolean isRequestedSessionIdFromURL()
        Specified by:
        isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
      • isRequestedSessionIdFromUrl

        @Deprecated
        public boolean isRequestedSessionIdFromUrl()
        Deprecated.
        Specified by:
        isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
      • getAttribute

        public Object getAttribute​(String s)
        Specified by:
        getAttribute in interface javax.servlet.ServletRequest
      • getAttributeNames

        public Enumeration<String> getAttributeNames()
        Specified by:
        getAttributeNames in interface javax.servlet.ServletRequest
      • getCharacterEncoding

        public String getCharacterEncoding()
        Specified by:
        getCharacterEncoding in interface javax.servlet.ServletRequest
      • getContentLength

        public int getContentLength()
        Specified by:
        getContentLength in interface javax.servlet.ServletRequest
      • getContentLengthLong

        public long getContentLengthLong()
        Specified by:
        getContentLengthLong in interface javax.servlet.ServletRequest
      • getContentType

        public String getContentType()
        Specified by:
        getContentType in interface javax.servlet.ServletRequest
      • getInputStream

        public javax.servlet.ServletInputStream getInputStream()
                                                        throws IOException
        Specified by:
        getInputStream in interface javax.servlet.ServletRequest
        Throws:
        IOException
      • getParameter

        public String getParameter​(String s)
        Specified by:
        getParameter in interface javax.servlet.ServletRequest
      • getParameterNames

        public Enumeration<String> getParameterNames()
        Specified by:
        getParameterNames in interface javax.servlet.ServletRequest
      • getParameterValues

        public String[] getParameterValues​(String s)
        Specified by:
        getParameterValues in interface javax.servlet.ServletRequest
      • getParameterMap

        public Map<String,​String[]> getParameterMap()
        Specified by:
        getParameterMap in interface javax.servlet.ServletRequest
      • getProtocol

        public String getProtocol()
        Specified by:
        getProtocol in interface javax.servlet.ServletRequest
      • getScheme

        public String getScheme()
        Specified by:
        getScheme in interface javax.servlet.ServletRequest
      • getServerName

        public String getServerName()
        Specified by:
        getServerName in interface javax.servlet.ServletRequest
      • getServerPort

        public int getServerPort()
        Specified by:
        getServerPort in interface javax.servlet.ServletRequest
      • getRemoteAddr

        public String getRemoteAddr()
        Specified by:
        getRemoteAddr in interface javax.servlet.ServletRequest
      • getRemoteHost

        public String getRemoteHost()
        Specified by:
        getRemoteHost in interface javax.servlet.ServletRequest
      • setAttribute

        public void setAttribute​(String s,
                                 Object o)
        Specified by:
        setAttribute in interface javax.servlet.ServletRequest
      • removeAttribute

        public void removeAttribute​(String s)
        Specified by:
        removeAttribute in interface javax.servlet.ServletRequest
      • getLocale

        public Locale getLocale()
        Specified by:
        getLocale in interface javax.servlet.ServletRequest
      • getLocales

        public Enumeration<Locale> getLocales()
        Specified by:
        getLocales in interface javax.servlet.ServletRequest
      • isSecure

        public boolean isSecure()
        Specified by:
        isSecure in interface javax.servlet.ServletRequest
      • getRequestDispatcher

        public javax.servlet.RequestDispatcher getRequestDispatcher​(String s)
        Specified by:
        getRequestDispatcher in interface javax.servlet.ServletRequest
      • getRealPath

        @Deprecated
        public String getRealPath​(String s)
        Deprecated.
        Specified by:
        getRealPath in interface javax.servlet.ServletRequest
      • getRemotePort

        public int getRemotePort()
        Specified by:
        getRemotePort in interface javax.servlet.ServletRequest
      • getLocalName

        public String getLocalName()
        Specified by:
        getLocalName in interface javax.servlet.ServletRequest
      • getLocalAddr

        public String getLocalAddr()
        Specified by:
        getLocalAddr in interface javax.servlet.ServletRequest
      • getLocalPort

        public int getLocalPort()
        Specified by:
        getLocalPort in interface javax.servlet.ServletRequest
      • authenticate

        public boolean authenticate​(javax.servlet.http.HttpServletResponse httpServletResponse)
                             throws IOException,
                                    javax.servlet.ServletException
        Specified by:
        authenticate in interface javax.servlet.http.HttpServletRequest
        Throws:
        IOException
        javax.servlet.ServletException
      • login

        public void login​(String s,
                          String s1)
                   throws javax.servlet.ServletException
        Specified by:
        login in interface javax.servlet.http.HttpServletRequest
        Throws:
        javax.servlet.ServletException
      • logout

        public void logout()
                    throws javax.servlet.ServletException
        Specified by:
        logout in interface javax.servlet.http.HttpServletRequest
        Throws:
        javax.servlet.ServletException
      • getParts

        public Collection<javax.servlet.http.Part> getParts()
                                                     throws IOException,
                                                            javax.servlet.ServletException
        Specified by:
        getParts in interface javax.servlet.http.HttpServletRequest
        Throws:
        IOException
        javax.servlet.ServletException
      • getPart

        public javax.servlet.http.Part getPart​(String s)
                                        throws IOException,
                                               javax.servlet.ServletException
        Specified by:
        getPart in interface javax.servlet.http.HttpServletRequest
        Throws:
        IOException
        javax.servlet.ServletException
      • getServletContext

        public javax.servlet.ServletContext getServletContext()
        Specified by:
        getServletContext in interface javax.servlet.ServletRequest
      • startAsync

        public javax.servlet.AsyncContext startAsync​(javax.servlet.ServletRequest servletRequest,
                                                     javax.servlet.ServletResponse servletResponse)
                                              throws IllegalStateException
        Specified by:
        startAsync in interface javax.servlet.ServletRequest
        Throws:
        IllegalStateException
      • isAsyncStarted

        public boolean isAsyncStarted()
        Specified by:
        isAsyncStarted in interface javax.servlet.ServletRequest
      • isAsyncSupported

        public boolean isAsyncSupported()
        Specified by:
        isAsyncSupported in interface javax.servlet.ServletRequest
      • getAsyncContext

        public javax.servlet.AsyncContext getAsyncContext()
        Specified by:
        getAsyncContext in interface javax.servlet.ServletRequest
      • getDispatcherType

        public javax.servlet.DispatcherType getDispatcherType()
        Specified by:
        getDispatcherType in interface javax.servlet.ServletRequest
      • upgrade

        public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade​(Class<T> handlerClass)
                                                                    throws IOException,
                                                                           javax.servlet.ServletException
        Specified by:
        upgrade in interface javax.servlet.http.HttpServletRequest
        Throws:
        IOException
        javax.servlet.ServletException
      • isDaemon

        public boolean isDaemon()
        Returns:
        true if the request is intended to be used in a long standing daemon thread (mails, etc.) and should not be taken into account when generating a URL
        Since:
        10.11RC1
      • setDaemon

        public void setDaemon​(boolean daemon)
        Parameters:
        daemon - the daemon to set
        Since:
        10.11RC1