Package org.apache.sling.servlethelpers
Class MockSlingHttpServletRequest
- java.lang.Object
-
- org.apache.sling.api.adapter.SlingAdaptable
-
- org.apache.sling.servlethelpers.MockSlingHttpServletRequest
-
- All Implemented Interfaces:
javax.servlet.http.HttpServletRequest,javax.servlet.ServletRequest,org.apache.sling.api.adapter.Adaptable,org.apache.sling.api.SlingHttpServletRequest
@ConsumerType public class MockSlingHttpServletRequest extends org.apache.sling.api.adapter.SlingAdaptable implements org.apache.sling.api.SlingHttpServletRequestMockSlingHttpServletRequestimplementation.
-
-
Field Summary
Fields Modifier and Type Field Description protected static ResourceBundleEMPTY_RESOURCE_BUNDLE
-
Constructor Summary
Constructors Constructor Description MockSlingHttpServletRequest(org.apache.sling.api.resource.ResourceResolver resourceResolver)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <AdapterType>
AdapterTypeadaptTo(Class<AdapterType> type)voidaddCookie(javax.servlet.http.Cookie cookie)Set cookievoidaddDateHeader(String name, long date)Add header, keep existing ones with same name.voidaddHeader(String name, String value)Add header, keep existing ones with same name.voidaddIntHeader(String name, int value)Add header, keep existing ones with same name.voidaddPart(javax.servlet.http.Part part)voidaddRequestParameter(String name, byte[] content, String contentType)Add a request parameter that emulates a file upload field.voidaddRequestParameter(String name, byte[] content, String contentType, String filename)Add a request parameter that emulates a file upload field with a filename associated with it.voidaddRequestParameter(String name, String value)Add a request parameter that consists of a simple name/value pair.booleanauthenticate(javax.servlet.http.HttpServletResponse response)StringchangeSessionId()javax.servlet.AsyncContextgetAsyncContext()ObjectgetAttribute(String name)Enumeration<String>getAttributeNames()StringgetAuthType()StringgetCharacterEncoding()intgetContentLength()longgetContentLengthLong()StringgetContentType()StringgetContextPath()javax.servlet.http.CookiegetCookie(String name)javax.servlet.http.Cookie[]getCookies()longgetDateHeader(String name)javax.servlet.DispatcherTypegetDispatcherType()StringgetHeader(String name)Enumeration<String>getHeaderNames()Enumeration<String>getHeaders(String name)javax.servlet.ServletInputStreamgetInputStream()intgetIntHeader(String name)StringgetLocalAddr()LocalegetLocale()Enumeration<Locale>getLocales()StringgetLocalName()intgetLocalPort()StringgetMethod()StringgetParameter(String name)Map<String,String[]>getParameterMap()Enumeration<String>getParameterNames()String[]getParameterValues(String name)javax.servlet.http.PartgetPart(String name)Collection<javax.servlet.http.Part>getParts()StringgetPathInfo()StringgetPathTranslated()StringgetProtocol()StringgetQueryString()BufferedReadergetReader()StringgetRealPath(String path)StringgetRemoteAddr()StringgetRemoteHost()intgetRemotePort()StringgetRemoteUser()javax.servlet.RequestDispatchergetRequestDispatcher(String path)javax.servlet.RequestDispatchergetRequestDispatcher(String path, org.apache.sling.api.request.RequestDispatcherOptions options)javax.servlet.RequestDispatchergetRequestDispatcher(org.apache.sling.api.resource.Resource resource)javax.servlet.RequestDispatchergetRequestDispatcher(org.apache.sling.api.resource.Resource resource, org.apache.sling.api.request.RequestDispatcherOptions options)StringgetRequestedSessionId()org.apache.sling.api.request.RequestParametergetRequestParameter(String name)List<org.apache.sling.api.request.RequestParameter>getRequestParameterList()org.apache.sling.api.request.RequestParameterMapgetRequestParameterMap()org.apache.sling.api.request.RequestParameter[]getRequestParameters(String name)org.apache.sling.api.request.RequestPathInfogetRequestPathInfo()org.apache.sling.api.request.RequestProgressTrackergetRequestProgressTracker()StringgetRequestURI()StringBuffergetRequestURL()org.apache.sling.api.resource.ResourcegetResource()ResourceBundlegetResourceBundle(String baseName, Locale locale)ResourceBundlegetResourceBundle(Locale locale)org.apache.sling.api.resource.ResourceResolvergetResourceResolver()StringgetResponseContentType()Enumeration<String>getResponseContentTypes()StringgetScheme()StringgetServerName()intgetServerPort()javax.servlet.ServletContextgetServletContext()StringgetServletPath()javax.servlet.http.HttpSessiongetSession()javax.servlet.http.HttpSessiongetSession(boolean create)PrincipalgetUserPrincipal()booleanisAsyncStarted()booleanisAsyncSupported()booleanisRequestedSessionIdFromCookie()booleanisRequestedSessionIdFromUrl()booleanisRequestedSessionIdFromURL()booleanisRequestedSessionIdValid()booleanisSecure()booleanisUserInRole(String role)voidlogin(String pUsername, String password)voidlogout()protected MockHttpSessionnewMockHttpSession()protected MockRequestPathInfonewMockRequestPathInfo()voidremoveAttribute(String name)voidsetAttribute(String name, Object object)voidsetAuthType(String authType)voidsetCharacterEncoding(String charset)voidsetContent(byte[] content)voidsetContentType(String type)voidsetContextPath(String contextPath)voidsetDateHeader(String name, long date)Set header, overwrite existing ones with same name.voidsetHeader(String name, String value)Set header, overwrite existing ones with same name.voidsetIntHeader(String name, int value)Set header, overwrite existing ones with same name.voidsetLocale(Locale loc)voidsetMethod(String method)voidsetParameterMap(Map<String,Object> parameterMap)voidsetPathInfo(String pathInfo)voidsetQueryString(String queryString)voidsetRemoteAddr(String remoteAddr)voidsetRemoteHost(String remoteHost)voidsetRemotePort(int remotePort)voidsetRemoteUser(String remoteUser)voidsetRequestDispatcherFactory(MockRequestDispatcherFactory requestDispatcherFactory)voidsetResource(org.apache.sling.api.resource.Resource resource)voidsetResponseContentType(String responseContentType)voidsetScheme(String scheme)voidsetServerName(String serverName)voidsetServerPort(int serverPort)voidsetServletPath(String servletPath)javax.servlet.AsyncContextstartAsync()javax.servlet.AsyncContextstartAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)<T extends javax.servlet.http.HttpUpgradeHandler>
Tupgrade(Class<T> handlerClass)
-
-
-
Field Detail
-
EMPTY_RESOURCE_BUNDLE
protected static final ResourceBundle EMPTY_RESOURCE_BUNDLE
-
-
Method Detail
-
newMockHttpSession
protected MockHttpSession newMockHttpSession()
-
newMockRequestPathInfo
protected MockRequestPathInfo newMockRequestPathInfo()
-
getResourceResolver
public org.apache.sling.api.resource.ResourceResolver getResourceResolver()
- Specified by:
getResourceResolverin interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getSession
public javax.servlet.http.HttpSession getSession()
- Specified by:
getSessionin interfacejavax.servlet.http.HttpServletRequest
-
getSession
public javax.servlet.http.HttpSession getSession(boolean create)
- Specified by:
getSessionin interfacejavax.servlet.http.HttpServletRequest
-
getRequestPathInfo
public org.apache.sling.api.request.RequestPathInfo getRequestPathInfo()
- Specified by:
getRequestPathInfoin interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getAttribute
public Object getAttribute(String name)
- Specified by:
getAttributein interfacejavax.servlet.ServletRequest
-
getAttributeNames
public Enumeration<String> getAttributeNames()
- Specified by:
getAttributeNamesin interfacejavax.servlet.ServletRequest
-
removeAttribute
public void removeAttribute(String name)
- Specified by:
removeAttributein interfacejavax.servlet.ServletRequest
-
setAttribute
public void setAttribute(String name, Object object)
- Specified by:
setAttributein interfacejavax.servlet.ServletRequest
-
getResource
public org.apache.sling.api.resource.Resource getResource()
- Specified by:
getResourcein interfaceorg.apache.sling.api.SlingHttpServletRequest
-
setResource
public void setResource(org.apache.sling.api.resource.Resource resource)
-
getParameter
public String getParameter(String name)
- Specified by:
getParameterin interfacejavax.servlet.ServletRequest
-
getParameterMap
public Map<String,String[]> getParameterMap()
- Specified by:
getParameterMapin interfacejavax.servlet.ServletRequest
-
getParameterNames
public Enumeration<String> getParameterNames()
- Specified by:
getParameterNamesin interfacejavax.servlet.ServletRequest
-
getParameterValues
public String[] getParameterValues(String name)
- Specified by:
getParameterValuesin interfacejavax.servlet.ServletRequest
-
setParameterMap
public void setParameterMap(Map<String,Object> parameterMap)
- Parameters:
parameterMap- Map of parameters
-
getLocale
public Locale getLocale()
- Specified by:
getLocalein interfacejavax.servlet.ServletRequest
-
setLocale
public void setLocale(Locale loc)
- Parameters:
loc- Request locale
-
getContextPath
public String getContextPath()
- Specified by:
getContextPathin interfacejavax.servlet.http.HttpServletRequest
-
setContextPath
public void setContextPath(String contextPath)
- Parameters:
contextPath- Webapp context path
-
setQueryString
public void setQueryString(String queryString)
- Parameters:
queryString- Query string (with proper URL encoding)
-
getQueryString
public String getQueryString()
- Specified by:
getQueryStringin interfacejavax.servlet.http.HttpServletRequest
-
getScheme
public String getScheme()
- Specified by:
getSchemein interfacejavax.servlet.ServletRequest
-
setScheme
public void setScheme(String scheme)
-
getServerName
public String getServerName()
- Specified by:
getServerNamein interfacejavax.servlet.ServletRequest
-
setServerName
public void setServerName(String serverName)
-
getServerPort
public int getServerPort()
- Specified by:
getServerPortin interfacejavax.servlet.ServletRequest
-
setServerPort
public void setServerPort(int serverPort)
-
isSecure
public boolean isSecure()
- Specified by:
isSecurein interfacejavax.servlet.ServletRequest
-
getMethod
public String getMethod()
- Specified by:
getMethodin interfacejavax.servlet.http.HttpServletRequest
-
setMethod
public void setMethod(String method)
-
getDateHeader
public long getDateHeader(String name)
- Specified by:
getDateHeaderin interfacejavax.servlet.http.HttpServletRequest
-
getHeader
public String getHeader(String name)
- Specified by:
getHeaderin interfacejavax.servlet.http.HttpServletRequest
-
getHeaderNames
public Enumeration<String> getHeaderNames()
- Specified by:
getHeaderNamesin interfacejavax.servlet.http.HttpServletRequest
-
getHeaders
public Enumeration<String> getHeaders(String name)
- Specified by:
getHeadersin interfacejavax.servlet.http.HttpServletRequest
-
getIntHeader
public int getIntHeader(String name)
- Specified by:
getIntHeaderin interfacejavax.servlet.http.HttpServletRequest
-
addHeader
public void addHeader(String name, String value)
Add header, keep existing ones with same name.- Parameters:
name- Header namevalue- Header value
-
addIntHeader
public void addIntHeader(String name, int value)
Add header, keep existing ones with same name.- Parameters:
name- Header namevalue- Header value
-
addDateHeader
public void addDateHeader(String name, long date)
Add header, keep existing ones with same name.- Parameters:
name- Header namedate- Header value
-
setHeader
public void setHeader(String name, String value)
Set header, overwrite existing ones with same name.- Parameters:
name- Header namevalue- Header value
-
setIntHeader
public void setIntHeader(String name, int value)
Set header, overwrite existing ones with same name.- Parameters:
name- Header namevalue- Header value
-
setDateHeader
public void setDateHeader(String name, long date)
Set header, overwrite existing ones with same name.- Parameters:
name- Header namedate- Header value
-
getCookie
public javax.servlet.http.Cookie getCookie(String name)
- Specified by:
getCookiein interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getCookies
public javax.servlet.http.Cookie[] getCookies()
- Specified by:
getCookiesin interfacejavax.servlet.http.HttpServletRequest
-
addCookie
public void addCookie(javax.servlet.http.Cookie cookie)
Set cookie- Parameters:
cookie- Cookie
-
getResourceBundle
public ResourceBundle getResourceBundle(Locale locale)
- Specified by:
getResourceBundlein interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getResourceBundle
public ResourceBundle getResourceBundle(String baseName, Locale locale)
- Specified by:
getResourceBundlein interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getRequestParameter
public org.apache.sling.api.request.RequestParameter getRequestParameter(String name)
- Specified by:
getRequestParameterin interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getRequestParameterMap
public org.apache.sling.api.request.RequestParameterMap getRequestParameterMap()
- Specified by:
getRequestParameterMapin interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getRequestParameters
public org.apache.sling.api.request.RequestParameter[] getRequestParameters(String name)
- Specified by:
getRequestParametersin interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getRequestParameterList
public List<org.apache.sling.api.request.RequestParameter> getRequestParameterList()
-
addRequestParameter
public void addRequestParameter(String name, String value)
Add a request parameter that consists of a simple name/value pair. This emulates a simple form field.- Parameters:
name- field namevalue- field value
-
addRequestParameter
public void addRequestParameter(String name, byte[] content, String contentType)
Add a request parameter that emulates a file upload field.- Parameters:
name- field namecontent- file contentcontentType- mime type of content in the field
-
addRequestParameter
public void addRequestParameter(String name, byte[] content, String contentType, String filename)
Add a request parameter that emulates a file upload field with a filename associated with it.- Parameters:
name- field namecontent- file contentcontentType- mime type of content in the fieldfilename- filename associated with content
-
getCharacterEncoding
public String getCharacterEncoding()
- Specified by:
getCharacterEncodingin interfacejavax.servlet.ServletRequest
-
setCharacterEncoding
public void setCharacterEncoding(String charset)
- Specified by:
setCharacterEncodingin interfacejavax.servlet.ServletRequest
-
getContentType
public String getContentType()
- Specified by:
getContentTypein interfacejavax.servlet.ServletRequest
-
setContentType
public void setContentType(String type)
-
getInputStream
public javax.servlet.ServletInputStream getInputStream()
- Specified by:
getInputStreamin interfacejavax.servlet.ServletRequest
-
getContentLength
public int getContentLength()
- Specified by:
getContentLengthin interfacejavax.servlet.ServletRequest
-
setContent
public void setContent(byte[] content)
-
getRequestDispatcher
public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
- Specified by:
getRequestDispatcherin interfacejavax.servlet.ServletRequest
-
getRequestDispatcher
public javax.servlet.RequestDispatcher getRequestDispatcher(String path, org.apache.sling.api.request.RequestDispatcherOptions options)
- Specified by:
getRequestDispatcherin interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getRequestDispatcher
public javax.servlet.RequestDispatcher getRequestDispatcher(org.apache.sling.api.resource.Resource resource)
- Specified by:
getRequestDispatcherin interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getRequestDispatcher
public javax.servlet.RequestDispatcher getRequestDispatcher(org.apache.sling.api.resource.Resource resource, org.apache.sling.api.request.RequestDispatcherOptions options)- Specified by:
getRequestDispatcherin interfaceorg.apache.sling.api.SlingHttpServletRequest
-
setRequestDispatcherFactory
public void setRequestDispatcherFactory(MockRequestDispatcherFactory requestDispatcherFactory)
-
getRemoteUser
public String getRemoteUser()
- Specified by:
getRemoteUserin interfacejavax.servlet.http.HttpServletRequest
-
setRemoteUser
public void setRemoteUser(String remoteUser)
-
getRemoteAddr
public String getRemoteAddr()
- Specified by:
getRemoteAddrin interfacejavax.servlet.ServletRequest
-
setRemoteAddr
public void setRemoteAddr(String remoteAddr)
-
getRemoteHost
public String getRemoteHost()
- Specified by:
getRemoteHostin interfacejavax.servlet.ServletRequest
-
setRemoteHost
public void setRemoteHost(String remoteHost)
-
getRemotePort
public int getRemotePort()
- Specified by:
getRemotePortin interfacejavax.servlet.ServletRequest
-
setRemotePort
public void setRemotePort(int remotePort)
-
getServletPath
public String getServletPath()
- Specified by:
getServletPathin interfacejavax.servlet.http.HttpServletRequest
-
setServletPath
public void setServletPath(String servletPath)
-
getPathInfo
public String getPathInfo()
- Specified by:
getPathInfoin interfacejavax.servlet.http.HttpServletRequest
-
setPathInfo
public void setPathInfo(String pathInfo)
-
getRequestURI
public String getRequestURI()
- Specified by:
getRequestURIin interfacejavax.servlet.http.HttpServletRequest
-
getRequestURL
public StringBuffer getRequestURL()
- Specified by:
getRequestURLin interfacejavax.servlet.http.HttpServletRequest
-
getAuthType
public String getAuthType()
- Specified by:
getAuthTypein interfacejavax.servlet.http.HttpServletRequest
-
setAuthType
public void setAuthType(String authType)
-
adaptTo
public <AdapterType> AdapterType adaptTo(Class<AdapterType> type)
- Specified by:
adaptToin interfaceorg.apache.sling.api.adapter.Adaptable- Overrides:
adaptToin classorg.apache.sling.api.adapter.SlingAdaptable
-
getResponseContentType
public String getResponseContentType()
- Specified by:
getResponseContentTypein interfaceorg.apache.sling.api.SlingHttpServletRequest
-
setResponseContentType
public void setResponseContentType(String responseContentType)
-
getResponseContentTypes
public Enumeration<String> getResponseContentTypes()
- Specified by:
getResponseContentTypesin interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getReader
public BufferedReader getReader()
- Specified by:
getReaderin interfacejavax.servlet.ServletRequest
-
getRequestProgressTracker
public org.apache.sling.api.request.RequestProgressTracker getRequestProgressTracker()
- Specified by:
getRequestProgressTrackerin interfaceorg.apache.sling.api.SlingHttpServletRequest
-
addPart
public void addPart(javax.servlet.http.Part part)
-
getParts
public Collection<javax.servlet.http.Part> getParts()
- Specified by:
getPartsin interfacejavax.servlet.http.HttpServletRequest
-
getPart
public javax.servlet.http.Part getPart(String name)
- Specified by:
getPartin interfacejavax.servlet.http.HttpServletRequest
-
getUserPrincipal
public Principal getUserPrincipal()
- Specified by:
getUserPrincipalin interfacejavax.servlet.http.HttpServletRequest
-
getPathTranslated
public String getPathTranslated()
- Specified by:
getPathTranslatedin interfacejavax.servlet.http.HttpServletRequest
-
getRequestedSessionId
public String getRequestedSessionId()
- Specified by:
getRequestedSessionIdin interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()
- Specified by:
isRequestedSessionIdFromCookiein interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()
- Specified by:
isRequestedSessionIdFromURLin interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromUrl
public boolean isRequestedSessionIdFromUrl()
- Specified by:
isRequestedSessionIdFromUrlin interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()
- Specified by:
isRequestedSessionIdValidin interfacejavax.servlet.http.HttpServletRequest
-
isUserInRole
public boolean isUserInRole(String role)
- Specified by:
isUserInRolein interfacejavax.servlet.http.HttpServletRequest
-
getLocalAddr
public String getLocalAddr()
- Specified by:
getLocalAddrin interfacejavax.servlet.ServletRequest
-
getLocalName
public String getLocalName()
- Specified by:
getLocalNamein interfacejavax.servlet.ServletRequest
-
getLocalPort
public int getLocalPort()
- Specified by:
getLocalPortin interfacejavax.servlet.ServletRequest
-
getLocales
public Enumeration<Locale> getLocales()
- Specified by:
getLocalesin interfacejavax.servlet.ServletRequest
-
getProtocol
public String getProtocol()
- Specified by:
getProtocolin interfacejavax.servlet.ServletRequest
-
getRealPath
public String getRealPath(String path)
- Specified by:
getRealPathin interfacejavax.servlet.ServletRequest
-
authenticate
public boolean authenticate(javax.servlet.http.HttpServletResponse response)
- Specified by:
authenticatein interfacejavax.servlet.http.HttpServletRequest
-
login
public void login(String pUsername, String password)
- Specified by:
loginin interfacejavax.servlet.http.HttpServletRequest
-
logout
public void logout() throws javax.servlet.ServletException- Specified by:
logoutin interfacejavax.servlet.http.HttpServletRequest- Throws:
javax.servlet.ServletException
-
getServletContext
public javax.servlet.ServletContext getServletContext()
- Specified by:
getServletContextin interfacejavax.servlet.ServletRequest
-
startAsync
public javax.servlet.AsyncContext startAsync()
- Specified by:
startAsyncin interfacejavax.servlet.ServletRequest
-
startAsync
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)- Specified by:
startAsyncin interfacejavax.servlet.ServletRequest
-
isAsyncStarted
public boolean isAsyncStarted()
- Specified by:
isAsyncStartedin interfacejavax.servlet.ServletRequest
-
isAsyncSupported
public boolean isAsyncSupported()
- Specified by:
isAsyncSupportedin interfacejavax.servlet.ServletRequest
-
getAsyncContext
public javax.servlet.AsyncContext getAsyncContext()
- Specified by:
getAsyncContextin interfacejavax.servlet.ServletRequest
-
getDispatcherType
public javax.servlet.DispatcherType getDispatcherType()
- Specified by:
getDispatcherTypein interfacejavax.servlet.ServletRequest
-
changeSessionId
public String changeSessionId()
- Specified by:
changeSessionIdin interfacejavax.servlet.http.HttpServletRequest
-
upgrade
public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(Class<T> handlerClass) throws IOException, javax.servlet.ServletException
- Specified by:
upgradein interfacejavax.servlet.http.HttpServletRequest- Throws:
IOExceptionjavax.servlet.ServletException
-
getContentLengthLong
public long getContentLengthLong()
- Specified by:
getContentLengthLongin interfacejavax.servlet.ServletRequest
-
-