Package com.xpn.xwiki.web
Class XWikiServletRequestStub
- java.lang.Object
-
- com.xpn.xwiki.web.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 $
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
XWikiServletRequestStub.Builder
Builder forXWikiServletRequestStub
.
-
Constructor Summary
Constructors Constructor Description XWikiServletRequestStub()
XWikiServletRequestStub(XWikiRequest request)
XWikiServletRequestStub(URL requestURL, String contextPath, Map<String,String[]> requestParameters)
Deprecated.use the dedicatedXWikiServletRequestStub.Builder
insteadXWikiServletRequestStub(URL requestURL, String contextPath, Map<String,String[]> requestParameters, javax.servlet.http.Cookie[] cookies)
Deprecated.use the dedicatedXWikiServletRequestStub.Builder
insteadXWikiServletRequestStub(URL requestURL, Map<String,String[]> requestParameters)
Deprecated.use the dedicatedXWikiServletRequestStub.Builder
instead
-
Method Summary
-
-
-
Constructor Detail
-
XWikiServletRequestStub
public XWikiServletRequestStub()
-
XWikiServletRequestStub
@Deprecated public XWikiServletRequestStub(URL requestURL, Map<String,String[]> requestParameters)
Deprecated.use the dedicatedXWikiServletRequestStub.Builder
instead- Since:
- 8.4RC1
-
XWikiServletRequestStub
@Deprecated public XWikiServletRequestStub(URL requestURL, String contextPath, Map<String,String[]> requestParameters)
Deprecated.use the dedicatedXWikiServletRequestStub.Builder
instead- Since:
- 10.11.1, 11.0
-
XWikiServletRequestStub
@Deprecated public XWikiServletRequestStub(URL requestURL, String contextPath, Map<String,String[]> requestParameters, javax.servlet.http.Cookie[] cookies)
Deprecated.use the dedicatedXWikiServletRequestStub.Builder
instead- Since:
- 14.4.2, 14.5
-
XWikiServletRequestStub
public XWikiServletRequestStub(XWikiRequest request)
- Parameters:
request
- the request to copy- Since:
- 10.7RC1
-
-
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 interfacejavax.servlet.http.HttpServletRequest
-
get
public String get(String name)
- Specified by:
get
in interfaceXWikiRequest
-
getHttpServletRequest
public javax.servlet.http.HttpServletRequest getHttpServletRequest()
- Specified by:
getHttpServletRequest
in interfaceXWikiRequest
-
getCookie
public javax.servlet.http.Cookie getCookie(String cookieName)
- Specified by:
getCookie
in interfaceXWikiRequest
-
getAuthType
public String getAuthType()
- Specified by:
getAuthType
in interfacejavax.servlet.http.HttpServletRequest
-
getCookies
public javax.servlet.http.Cookie[] getCookies()
- Specified by:
getCookies
in interfacejavax.servlet.http.HttpServletRequest
-
getDateHeader
public long getDateHeader(String s)
- Specified by:
getDateHeader
in interfacejavax.servlet.http.HttpServletRequest
-
getHeaders
public Enumeration<String> getHeaders(String headerName)
- Specified by:
getHeaders
in interfacejavax.servlet.http.HttpServletRequest
-
getHeaderNames
public Enumeration<String> getHeaderNames()
- Specified by:
getHeaderNames
in interfacejavax.servlet.http.HttpServletRequest
-
getIntHeader
public int getIntHeader(String s)
- Specified by:
getIntHeader
in interfacejavax.servlet.http.HttpServletRequest
-
getMethod
public String getMethod()
- Specified by:
getMethod
in interfacejavax.servlet.http.HttpServletRequest
-
getPathInfo
public String getPathInfo()
- Specified by:
getPathInfo
in interfacejavax.servlet.http.HttpServletRequest
-
getPathTranslated
public String getPathTranslated()
- Specified by:
getPathTranslated
in interfacejavax.servlet.http.HttpServletRequest
-
getContextPath
public String getContextPath()
- Specified by:
getContextPath
in interfacejavax.servlet.http.HttpServletRequest
-
getQueryString
public String getQueryString()
- Specified by:
getQueryString
in interfacejavax.servlet.http.HttpServletRequest
-
getRemoteUser
public String getRemoteUser()
- Specified by:
getRemoteUser
in interfacejavax.servlet.http.HttpServletRequest
-
isUserInRole
public boolean isUserInRole(String s)
- Specified by:
isUserInRole
in interfacejavax.servlet.http.HttpServletRequest
-
getUserPrincipal
public Principal getUserPrincipal()
- Specified by:
getUserPrincipal
in interfacejavax.servlet.http.HttpServletRequest
-
getRequestedSessionId
public String getRequestedSessionId()
- Specified by:
getRequestedSessionId
in interfacejavax.servlet.http.HttpServletRequest
-
getRequestURI
public String getRequestURI()
- Specified by:
getRequestURI
in interfacejavax.servlet.http.HttpServletRequest
-
getRequestURL
public StringBuffer getRequestURL()
- Specified by:
getRequestURL
in interfacejavax.servlet.http.HttpServletRequest
-
getServletPath
public String getServletPath()
- Specified by:
getServletPath
in interfacejavax.servlet.http.HttpServletRequest
-
getSession
public javax.servlet.http.HttpSession getSession(boolean b)
- Specified by:
getSession
in interfacejavax.servlet.http.HttpServletRequest
-
changeSessionId
public String changeSessionId()
- Specified by:
changeSessionId
in interfacejavax.servlet.http.HttpServletRequest
-
getSession
public javax.servlet.http.HttpSession getSession()
- Specified by:
getSession
in interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()
- Specified by:
isRequestedSessionIdValid
in interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()
- Specified by:
isRequestedSessionIdFromCookie
in interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()
- Specified by:
isRequestedSessionIdFromURL
in interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromUrl
@Deprecated public boolean isRequestedSessionIdFromUrl()
Deprecated.- Specified by:
isRequestedSessionIdFromUrl
in interfacejavax.servlet.http.HttpServletRequest
-
getAttribute
public Object getAttribute(String s)
- Specified by:
getAttribute
in interfacejavax.servlet.ServletRequest
-
getAttributeNames
public Enumeration<String> getAttributeNames()
- Specified by:
getAttributeNames
in interfacejavax.servlet.ServletRequest
-
getCharacterEncoding
public String getCharacterEncoding()
- Specified by:
getCharacterEncoding
in interfacejavax.servlet.ServletRequest
-
setCharacterEncoding
public void setCharacterEncoding(String s) throws UnsupportedEncodingException
- Specified by:
setCharacterEncoding
in interfacejavax.servlet.ServletRequest
- Throws:
UnsupportedEncodingException
-
getContentLength
public int getContentLength()
- Specified by:
getContentLength
in interfacejavax.servlet.ServletRequest
-
getContentLengthLong
public long getContentLengthLong()
- Specified by:
getContentLengthLong
in interfacejavax.servlet.ServletRequest
-
getContentType
public String getContentType()
- Specified by:
getContentType
in interfacejavax.servlet.ServletRequest
-
getInputStream
public javax.servlet.ServletInputStream getInputStream() throws IOException
- Specified by:
getInputStream
in interfacejavax.servlet.ServletRequest
- Throws:
IOException
-
getParameter
public String getParameter(String s)
- Specified by:
getParameter
in interfacejavax.servlet.ServletRequest
-
getParameterNames
public Enumeration<String> getParameterNames()
- Specified by:
getParameterNames
in interfacejavax.servlet.ServletRequest
-
getParameterValues
public String[] getParameterValues(String s)
- Specified by:
getParameterValues
in interfacejavax.servlet.ServletRequest
-
getParameterMap
public Map<String,String[]> getParameterMap()
- Specified by:
getParameterMap
in interfacejavax.servlet.ServletRequest
-
getProtocol
public String getProtocol()
- Specified by:
getProtocol
in interfacejavax.servlet.ServletRequest
-
getScheme
public String getScheme()
- Specified by:
getScheme
in interfacejavax.servlet.ServletRequest
-
getServerName
public String getServerName()
- Specified by:
getServerName
in interfacejavax.servlet.ServletRequest
-
getServerPort
public int getServerPort()
- Specified by:
getServerPort
in interfacejavax.servlet.ServletRequest
-
getReader
public BufferedReader getReader() throws IOException
- Specified by:
getReader
in interfacejavax.servlet.ServletRequest
- Throws:
IOException
-
getRemoteAddr
public String getRemoteAddr()
- Specified by:
getRemoteAddr
in interfacejavax.servlet.ServletRequest
-
getRemoteHost
public String getRemoteHost()
- Specified by:
getRemoteHost
in interfacejavax.servlet.ServletRequest
-
setAttribute
public void setAttribute(String s, Object o)
- Specified by:
setAttribute
in interfacejavax.servlet.ServletRequest
-
removeAttribute
public void removeAttribute(String s)
- Specified by:
removeAttribute
in interfacejavax.servlet.ServletRequest
-
getLocale
public Locale getLocale()
- Specified by:
getLocale
in interfacejavax.servlet.ServletRequest
-
getLocales
public Enumeration<Locale> getLocales()
- Specified by:
getLocales
in interfacejavax.servlet.ServletRequest
-
isSecure
public boolean isSecure()
- Specified by:
isSecure
in interfacejavax.servlet.ServletRequest
-
getRequestDispatcher
public javax.servlet.RequestDispatcher getRequestDispatcher(String s)
- Specified by:
getRequestDispatcher
in interfacejavax.servlet.ServletRequest
-
getRealPath
@Deprecated public String getRealPath(String s)
Deprecated.- Specified by:
getRealPath
in interfacejavax.servlet.ServletRequest
-
getRemotePort
public int getRemotePort()
- Specified by:
getRemotePort
in interfacejavax.servlet.ServletRequest
-
getLocalName
public String getLocalName()
- Specified by:
getLocalName
in interfacejavax.servlet.ServletRequest
-
getLocalAddr
public String getLocalAddr()
- Specified by:
getLocalAddr
in interfacejavax.servlet.ServletRequest
-
getLocalPort
public int getLocalPort()
- Specified by:
getLocalPort
in interfacejavax.servlet.ServletRequest
-
authenticate
public boolean authenticate(javax.servlet.http.HttpServletResponse httpServletResponse) throws IOException, javax.servlet.ServletException
- Specified by:
authenticate
in interfacejavax.servlet.http.HttpServletRequest
- Throws:
IOException
javax.servlet.ServletException
-
login
public void login(String s, String s1) throws javax.servlet.ServletException
- Specified by:
login
in interfacejavax.servlet.http.HttpServletRequest
- Throws:
javax.servlet.ServletException
-
logout
public void logout() throws javax.servlet.ServletException
- Specified by:
logout
in interfacejavax.servlet.http.HttpServletRequest
- Throws:
javax.servlet.ServletException
-
getParts
public Collection<javax.servlet.http.Part> getParts() throws IOException, javax.servlet.ServletException
- Specified by:
getParts
in interfacejavax.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 interfacejavax.servlet.http.HttpServletRequest
- Throws:
IOException
javax.servlet.ServletException
-
getServletContext
public javax.servlet.ServletContext getServletContext()
- Specified by:
getServletContext
in interfacejavax.servlet.ServletRequest
-
startAsync
public javax.servlet.AsyncContext startAsync() throws IllegalStateException
- Specified by:
startAsync
in interfacejavax.servlet.ServletRequest
- Throws:
IllegalStateException
-
startAsync
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse) throws IllegalStateException
- Specified by:
startAsync
in interfacejavax.servlet.ServletRequest
- Throws:
IllegalStateException
-
isAsyncStarted
public boolean isAsyncStarted()
- Specified by:
isAsyncStarted
in interfacejavax.servlet.ServletRequest
-
isAsyncSupported
public boolean isAsyncSupported()
- Specified by:
isAsyncSupported
in interfacejavax.servlet.ServletRequest
-
getAsyncContext
public javax.servlet.AsyncContext getAsyncContext()
- Specified by:
getAsyncContext
in interfacejavax.servlet.ServletRequest
-
getDispatcherType
public javax.servlet.DispatcherType getDispatcherType()
- Specified by:
getDispatcherType
in interfacejavax.servlet.ServletRequest
-
upgrade
public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(Class<T> handlerClass) throws IOException, javax.servlet.ServletException
- Specified by:
upgrade
in interfacejavax.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
-
-