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.SlingHttpServletRequest
MockSlingHttpServletRequest
implementation.
-
-
Field Summary
Fields Modifier and Type Field Description protected static ResourceBundle
EMPTY_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)
void
addCookie(javax.servlet.http.Cookie cookie)
Set cookievoid
addDateHeader(String name, long date)
Add header, keep existing ones with same name.void
addHeader(String name, String value)
Add header, keep existing ones with same name.void
addIntHeader(String name, int value)
Add header, keep existing ones with same name.void
addPart(javax.servlet.http.Part part)
void
addRequestParameter(String name, byte[] content, String contentType)
Add a request parameter that emulates a file upload field.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.void
addRequestParameter(String name, String value)
Add a request parameter that consists of a simple name/value pair.boolean
authenticate(javax.servlet.http.HttpServletResponse response)
String
changeSessionId()
javax.servlet.AsyncContext
getAsyncContext()
Object
getAttribute(String name)
Enumeration<String>
getAttributeNames()
String
getAuthType()
String
getCharacterEncoding()
int
getContentLength()
long
getContentLengthLong()
String
getContentType()
String
getContextPath()
javax.servlet.http.Cookie
getCookie(String name)
javax.servlet.http.Cookie[]
getCookies()
long
getDateHeader(String name)
javax.servlet.DispatcherType
getDispatcherType()
String
getHeader(String name)
Enumeration<String>
getHeaderNames()
Enumeration<String>
getHeaders(String name)
javax.servlet.ServletInputStream
getInputStream()
int
getIntHeader(String name)
String
getLocalAddr()
Locale
getLocale()
Enumeration<Locale>
getLocales()
String
getLocalName()
int
getLocalPort()
String
getMethod()
String
getParameter(String name)
Map<String,String[]>
getParameterMap()
Enumeration<String>
getParameterNames()
String[]
getParameterValues(String name)
javax.servlet.http.Part
getPart(String name)
Collection<javax.servlet.http.Part>
getParts()
String
getPathInfo()
String
getPathTranslated()
String
getProtocol()
String
getQueryString()
BufferedReader
getReader()
String
getRealPath(String path)
String
getRemoteAddr()
String
getRemoteHost()
int
getRemotePort()
String
getRemoteUser()
javax.servlet.RequestDispatcher
getRequestDispatcher(String path)
javax.servlet.RequestDispatcher
getRequestDispatcher(String path, org.apache.sling.api.request.RequestDispatcherOptions options)
javax.servlet.RequestDispatcher
getRequestDispatcher(org.apache.sling.api.resource.Resource resource)
javax.servlet.RequestDispatcher
getRequestDispatcher(org.apache.sling.api.resource.Resource resource, org.apache.sling.api.request.RequestDispatcherOptions options)
String
getRequestedSessionId()
org.apache.sling.api.request.RequestParameter
getRequestParameter(String name)
List<org.apache.sling.api.request.RequestParameter>
getRequestParameterList()
org.apache.sling.api.request.RequestParameterMap
getRequestParameterMap()
org.apache.sling.api.request.RequestParameter[]
getRequestParameters(String name)
org.apache.sling.api.request.RequestPathInfo
getRequestPathInfo()
org.apache.sling.api.request.RequestProgressTracker
getRequestProgressTracker()
String
getRequestURI()
StringBuffer
getRequestURL()
org.apache.sling.api.resource.Resource
getResource()
ResourceBundle
getResourceBundle(String baseName, Locale locale)
ResourceBundle
getResourceBundle(Locale locale)
org.apache.sling.api.resource.ResourceResolver
getResourceResolver()
String
getResponseContentType()
Enumeration<String>
getResponseContentTypes()
String
getScheme()
String
getServerName()
int
getServerPort()
javax.servlet.ServletContext
getServletContext()
String
getServletPath()
javax.servlet.http.HttpSession
getSession()
javax.servlet.http.HttpSession
getSession(boolean create)
Principal
getUserPrincipal()
boolean
isAsyncStarted()
boolean
isAsyncSupported()
boolean
isRequestedSessionIdFromCookie()
boolean
isRequestedSessionIdFromUrl()
boolean
isRequestedSessionIdFromURL()
boolean
isRequestedSessionIdValid()
boolean
isSecure()
boolean
isUserInRole(String role)
void
login(String pUsername, String password)
void
logout()
protected MockHttpSession
newMockHttpSession()
protected MockRequestPathInfo
newMockRequestPathInfo()
void
removeAttribute(String name)
void
setAttribute(String name, Object object)
void
setAuthType(String authType)
void
setCharacterEncoding(String charset)
void
setContent(byte[] content)
void
setContentType(String type)
void
setContextPath(String contextPath)
void
setDateHeader(String name, long date)
Set header, overwrite existing ones with same name.void
setHeader(String name, String value)
Set header, overwrite existing ones with same name.void
setIntHeader(String name, int value)
Set header, overwrite existing ones with same name.void
setLocale(Locale loc)
void
setMethod(String method)
void
setParameterMap(Map<String,Object> parameterMap)
void
setPathInfo(String pathInfo)
void
setQueryString(String queryString)
void
setRemoteAddr(String remoteAddr)
void
setRemoteHost(String remoteHost)
void
setRemotePort(int remotePort)
void
setRemoteUser(String remoteUser)
void
setRequestDispatcherFactory(MockRequestDispatcherFactory requestDispatcherFactory)
void
setResource(org.apache.sling.api.resource.Resource resource)
void
setResponseContentType(String responseContentType)
void
setScheme(String scheme)
void
setServerName(String serverName)
void
setServerPort(int serverPort)
void
setServletPath(String servletPath)
javax.servlet.AsyncContext
startAsync()
javax.servlet.AsyncContext
startAsync(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:
getResourceResolver
in interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getSession
public javax.servlet.http.HttpSession getSession()
- Specified by:
getSession
in interfacejavax.servlet.http.HttpServletRequest
-
getSession
public javax.servlet.http.HttpSession getSession(boolean create)
- Specified by:
getSession
in interfacejavax.servlet.http.HttpServletRequest
-
getRequestPathInfo
public org.apache.sling.api.request.RequestPathInfo getRequestPathInfo()
- Specified by:
getRequestPathInfo
in interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getAttribute
public Object getAttribute(String name)
- Specified by:
getAttribute
in interfacejavax.servlet.ServletRequest
-
getAttributeNames
public Enumeration<String> getAttributeNames()
- Specified by:
getAttributeNames
in interfacejavax.servlet.ServletRequest
-
removeAttribute
public void removeAttribute(String name)
- Specified by:
removeAttribute
in interfacejavax.servlet.ServletRequest
-
setAttribute
public void setAttribute(String name, Object object)
- Specified by:
setAttribute
in interfacejavax.servlet.ServletRequest
-
getResource
public org.apache.sling.api.resource.Resource getResource()
- Specified by:
getResource
in interfaceorg.apache.sling.api.SlingHttpServletRequest
-
setResource
public void setResource(org.apache.sling.api.resource.Resource resource)
-
getParameter
public String getParameter(String name)
- Specified by:
getParameter
in interfacejavax.servlet.ServletRequest
-
getParameterMap
public Map<String,String[]> getParameterMap()
- Specified by:
getParameterMap
in interfacejavax.servlet.ServletRequest
-
getParameterNames
public Enumeration<String> getParameterNames()
- Specified by:
getParameterNames
in interfacejavax.servlet.ServletRequest
-
getParameterValues
public String[] getParameterValues(String name)
- Specified by:
getParameterValues
in interfacejavax.servlet.ServletRequest
-
setParameterMap
public void setParameterMap(Map<String,Object> parameterMap)
- Parameters:
parameterMap
- Map of parameters
-
getLocale
public Locale getLocale()
- Specified by:
getLocale
in interfacejavax.servlet.ServletRequest
-
setLocale
public void setLocale(Locale loc)
- Parameters:
loc
- Request locale
-
getContextPath
public String getContextPath()
- Specified by:
getContextPath
in 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:
getQueryString
in interfacejavax.servlet.http.HttpServletRequest
-
getScheme
public String getScheme()
- Specified by:
getScheme
in interfacejavax.servlet.ServletRequest
-
setScheme
public void setScheme(String scheme)
-
getServerName
public String getServerName()
- Specified by:
getServerName
in interfacejavax.servlet.ServletRequest
-
setServerName
public void setServerName(String serverName)
-
getServerPort
public int getServerPort()
- Specified by:
getServerPort
in interfacejavax.servlet.ServletRequest
-
setServerPort
public void setServerPort(int serverPort)
-
isSecure
public boolean isSecure()
- Specified by:
isSecure
in interfacejavax.servlet.ServletRequest
-
getMethod
public String getMethod()
- Specified by:
getMethod
in interfacejavax.servlet.http.HttpServletRequest
-
setMethod
public void setMethod(String method)
-
getDateHeader
public long getDateHeader(String name)
- Specified by:
getDateHeader
in interfacejavax.servlet.http.HttpServletRequest
-
getHeader
public String getHeader(String name)
- Specified by:
getHeader
in interfacejavax.servlet.http.HttpServletRequest
-
getHeaderNames
public Enumeration<String> getHeaderNames()
- Specified by:
getHeaderNames
in interfacejavax.servlet.http.HttpServletRequest
-
getHeaders
public Enumeration<String> getHeaders(String name)
- Specified by:
getHeaders
in interfacejavax.servlet.http.HttpServletRequest
-
getIntHeader
public int getIntHeader(String name)
- Specified by:
getIntHeader
in 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:
getCookie
in interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getCookies
public javax.servlet.http.Cookie[] getCookies()
- Specified by:
getCookies
in 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:
getResourceBundle
in interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getResourceBundle
public ResourceBundle getResourceBundle(String baseName, Locale locale)
- Specified by:
getResourceBundle
in interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getRequestParameter
public org.apache.sling.api.request.RequestParameter getRequestParameter(String name)
- Specified by:
getRequestParameter
in interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getRequestParameterMap
public org.apache.sling.api.request.RequestParameterMap getRequestParameterMap()
- Specified by:
getRequestParameterMap
in interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getRequestParameters
public org.apache.sling.api.request.RequestParameter[] getRequestParameters(String name)
- Specified by:
getRequestParameters
in 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:
getCharacterEncoding
in interfacejavax.servlet.ServletRequest
-
setCharacterEncoding
public void setCharacterEncoding(String charset)
- Specified by:
setCharacterEncoding
in interfacejavax.servlet.ServletRequest
-
getContentType
public String getContentType()
- Specified by:
getContentType
in interfacejavax.servlet.ServletRequest
-
setContentType
public void setContentType(String type)
-
getInputStream
public javax.servlet.ServletInputStream getInputStream()
- Specified by:
getInputStream
in interfacejavax.servlet.ServletRequest
-
getContentLength
public int getContentLength()
- Specified by:
getContentLength
in interfacejavax.servlet.ServletRequest
-
setContent
public void setContent(byte[] content)
-
getRequestDispatcher
public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
- Specified by:
getRequestDispatcher
in interfacejavax.servlet.ServletRequest
-
getRequestDispatcher
public javax.servlet.RequestDispatcher getRequestDispatcher(String path, org.apache.sling.api.request.RequestDispatcherOptions options)
- Specified by:
getRequestDispatcher
in interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getRequestDispatcher
public javax.servlet.RequestDispatcher getRequestDispatcher(org.apache.sling.api.resource.Resource resource)
- Specified by:
getRequestDispatcher
in 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:
getRequestDispatcher
in interfaceorg.apache.sling.api.SlingHttpServletRequest
-
setRequestDispatcherFactory
public void setRequestDispatcherFactory(MockRequestDispatcherFactory requestDispatcherFactory)
-
getRemoteUser
public String getRemoteUser()
- Specified by:
getRemoteUser
in interfacejavax.servlet.http.HttpServletRequest
-
setRemoteUser
public void setRemoteUser(String remoteUser)
-
getRemoteAddr
public String getRemoteAddr()
- Specified by:
getRemoteAddr
in interfacejavax.servlet.ServletRequest
-
setRemoteAddr
public void setRemoteAddr(String remoteAddr)
-
getRemoteHost
public String getRemoteHost()
- Specified by:
getRemoteHost
in interfacejavax.servlet.ServletRequest
-
setRemoteHost
public void setRemoteHost(String remoteHost)
-
getRemotePort
public int getRemotePort()
- Specified by:
getRemotePort
in interfacejavax.servlet.ServletRequest
-
setRemotePort
public void setRemotePort(int remotePort)
-
getServletPath
public String getServletPath()
- Specified by:
getServletPath
in interfacejavax.servlet.http.HttpServletRequest
-
setServletPath
public void setServletPath(String servletPath)
-
getPathInfo
public String getPathInfo()
- Specified by:
getPathInfo
in interfacejavax.servlet.http.HttpServletRequest
-
setPathInfo
public void setPathInfo(String pathInfo)
-
getRequestURI
public String getRequestURI()
- Specified by:
getRequestURI
in interfacejavax.servlet.http.HttpServletRequest
-
getRequestURL
public StringBuffer getRequestURL()
- Specified by:
getRequestURL
in interfacejavax.servlet.http.HttpServletRequest
-
getAuthType
public String getAuthType()
- Specified by:
getAuthType
in interfacejavax.servlet.http.HttpServletRequest
-
setAuthType
public void setAuthType(String authType)
-
adaptTo
public <AdapterType> AdapterType adaptTo(Class<AdapterType> type)
- Specified by:
adaptTo
in interfaceorg.apache.sling.api.adapter.Adaptable
- Overrides:
adaptTo
in classorg.apache.sling.api.adapter.SlingAdaptable
-
getResponseContentType
public String getResponseContentType()
- Specified by:
getResponseContentType
in interfaceorg.apache.sling.api.SlingHttpServletRequest
-
setResponseContentType
public void setResponseContentType(String responseContentType)
-
getResponseContentTypes
public Enumeration<String> getResponseContentTypes()
- Specified by:
getResponseContentTypes
in interfaceorg.apache.sling.api.SlingHttpServletRequest
-
getReader
public BufferedReader getReader()
- Specified by:
getReader
in interfacejavax.servlet.ServletRequest
-
getRequestProgressTracker
public org.apache.sling.api.request.RequestProgressTracker getRequestProgressTracker()
- Specified by:
getRequestProgressTracker
in interfaceorg.apache.sling.api.SlingHttpServletRequest
-
addPart
public void addPart(javax.servlet.http.Part part)
-
getParts
public Collection<javax.servlet.http.Part> getParts()
- Specified by:
getParts
in interfacejavax.servlet.http.HttpServletRequest
-
getPart
public javax.servlet.http.Part getPart(String name)
- Specified by:
getPart
in interfacejavax.servlet.http.HttpServletRequest
-
getUserPrincipal
public Principal getUserPrincipal()
- Specified by:
getUserPrincipal
in interfacejavax.servlet.http.HttpServletRequest
-
getPathTranslated
public String getPathTranslated()
- Specified by:
getPathTranslated
in interfacejavax.servlet.http.HttpServletRequest
-
getRequestedSessionId
public String getRequestedSessionId()
- Specified by:
getRequestedSessionId
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
public boolean isRequestedSessionIdFromUrl()
- Specified by:
isRequestedSessionIdFromUrl
in interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()
- Specified by:
isRequestedSessionIdValid
in interfacejavax.servlet.http.HttpServletRequest
-
isUserInRole
public boolean isUserInRole(String role)
- Specified by:
isUserInRole
in interfacejavax.servlet.http.HttpServletRequest
-
getLocalAddr
public String getLocalAddr()
- Specified by:
getLocalAddr
in interfacejavax.servlet.ServletRequest
-
getLocalName
public String getLocalName()
- Specified by:
getLocalName
in interfacejavax.servlet.ServletRequest
-
getLocalPort
public int getLocalPort()
- Specified by:
getLocalPort
in interfacejavax.servlet.ServletRequest
-
getLocales
public Enumeration<Locale> getLocales()
- Specified by:
getLocales
in interfacejavax.servlet.ServletRequest
-
getProtocol
public String getProtocol()
- Specified by:
getProtocol
in interfacejavax.servlet.ServletRequest
-
getRealPath
public String getRealPath(String path)
- Specified by:
getRealPath
in interfacejavax.servlet.ServletRequest
-
authenticate
public boolean authenticate(javax.servlet.http.HttpServletResponse response)
- Specified by:
authenticate
in interfacejavax.servlet.http.HttpServletRequest
-
login
public void login(String pUsername, String password)
- Specified by:
login
in interfacejavax.servlet.http.HttpServletRequest
-
logout
public void logout() throws javax.servlet.ServletException
- Specified by:
logout
in interfacejavax.servlet.http.HttpServletRequest
- Throws:
javax.servlet.ServletException
-
getServletContext
public javax.servlet.ServletContext getServletContext()
- Specified by:
getServletContext
in interfacejavax.servlet.ServletRequest
-
startAsync
public javax.servlet.AsyncContext startAsync()
- Specified by:
startAsync
in interfacejavax.servlet.ServletRequest
-
startAsync
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)
- Specified by:
startAsync
in interfacejavax.servlet.ServletRequest
-
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
-
changeSessionId
public String changeSessionId()
- Specified by:
changeSessionId
in interfacejavax.servlet.http.HttpServletRequest
-
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
-
getContentLengthLong
public long getContentLengthLong()
- Specified by:
getContentLengthLong
in interfacejavax.servlet.ServletRequest
-
-