org.apache.sling.engine.impl

Class SlingHttpServletRequestImpl

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

org.apache.sling.engine.impl.SlingHttpServletRequestImpl

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, org.apache.sling.api.adapter.Adaptable, org.apache.sling.api.SlingHttpServletRequest

Direct Known Subclasses:

SlingHttpServletRequestImpl3

public class SlingHttpServletRequestImpl
extends javax.servlet.http.HttpServletRequestWrapper
implements org.apache.sling.api.SlingHttpServletRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor and Description
SlingHttpServletRequestImpl(RequestData requestData, javax.servlet.http.HttpServletRequest servletRequest)

Method Summary

Methods

Modifier and Type	Method and Description
<AdapterType> AdapterType	adaptTo(Class<AdapterType> type)
javax.servlet.http.Cookie	getCookie(String name)
javax.servlet.ServletInputStream	getInputStream()
String	getParameter(String name)
Map<String,String[]>	getParameterMap()
Enumeration<String>	getParameterNames()
String[]	getParameterValues(String name)
String	getPathInfo() Returns the part of the request URL without the leading servlet context path.
BufferedReader	getReader()
RequestData	getRequestData()
javax.servlet.RequestDispatcher	getRequestDispatcher(org.apache.sling.api.resource.Resource resource) Returns null if resource is null.
javax.servlet.RequestDispatcher	getRequestDispatcher(org.apache.sling.api.resource.Resource resource, org.apache.sling.api.request.RequestDispatcherOptions options) Returns null if resource is null.
javax.servlet.RequestDispatcher	getRequestDispatcher(String path) Returns null if path is null.
javax.servlet.RequestDispatcher	getRequestDispatcher(String path, org.apache.sling.api.request.RequestDispatcherOptions options) Returns null if path is null.
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()
org.apache.sling.api.resource.Resource	getResource()
ResourceBundle	getResourceBundle(Locale locale)
ResourceBundle	getResourceBundle(String baseName, Locale locale)
org.apache.sling.api.resource.ResourceResolver	getResourceResolver()
String	getResponseContentType()
Enumeration<String>	getResponseContentTypes()
String	getServletPath() Always returns the empty string since the actual servlet registered with the servlet container (the HttpService actually) is registered as if the servlet path is "/*".
Principal	getUserPrincipal()
boolean	isUserInRole(String role)

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

authenticate, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getSession, getSession, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, login, logout

Methods inherited from class javax.servlet.ServletRequestWrapper

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.http.HttpServletRequest

authenticate, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getSession, getSession, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, login, logout

Methods inherited from interface javax.servlet.ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Constructor Detail

SlingHttpServletRequestImpl

public SlingHttpServletRequestImpl(RequestData requestData,
                           javax.servlet.http.HttpServletRequest servletRequest)

Method Detail

getRequestData

public final RequestData getRequestData()

Returns:

the requestData

adaptTo

public <AdapterType> AdapterType adaptTo(Class<AdapterType> type)

Specified by:

adaptTo in interface org.apache.sling.api.adapter.Adaptable

getResource

public org.apache.sling.api.resource.Resource getResource()

Specified by:

getResource in interface org.apache.sling.api.SlingHttpServletRequest

getResourceResolver

public org.apache.sling.api.resource.ResourceResolver getResourceResolver()

Specified by:

getResourceResolver in interface org.apache.sling.api.SlingHttpServletRequest

getRequestProgressTracker

public org.apache.sling.api.request.RequestProgressTracker getRequestProgressTracker()

Specified by:

getRequestProgressTracker in interface org.apache.sling.api.SlingHttpServletRequest

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(org.apache.sling.api.resource.Resource resource)

Returns null if resource is null.

Specified by:

getRequestDispatcher in interface org.apache.sling.api.SlingHttpServletRequest

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(org.apache.sling.api.resource.Resource resource,
                                                   org.apache.sling.api.request.RequestDispatcherOptions options)

Returns null if resource is null.

Specified by:

getRequestDispatcher in interface org.apache.sling.api.SlingHttpServletRequest

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(String path)

Returns null if path is null.

Specified by:

getRequestDispatcher in interface javax.servlet.ServletRequest

Overrides:

getRequestDispatcher in class javax.servlet.ServletRequestWrapper

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(String path,
                                                   org.apache.sling.api.request.RequestDispatcherOptions options)

Returns null if path is null.

Specified by:

getRequestDispatcher in interface org.apache.sling.api.SlingHttpServletRequest

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface javax.servlet.ServletRequest

Overrides:

getParameter in class javax.servlet.ServletRequestWrapper

See Also:

ServletRequestWrapper.getParameter(java.lang.String)

getParameterMap

public Map<String,String[]> getParameterMap()

Specified by:

getParameterMap in interface javax.servlet.ServletRequest

Overrides:

getParameterMap in class javax.servlet.ServletRequestWrapper

See Also:

ServletRequestWrapper.getParameterMap()

getParameterNames

public Enumeration<String> getParameterNames()

Specified by:

getParameterNames in interface javax.servlet.ServletRequest

Overrides:

getParameterNames in class javax.servlet.ServletRequestWrapper

See Also:

ServletRequestWrapper.getParameterNames()

getParameterValues

public String[] getParameterValues(String name)

Specified by:

getParameterValues in interface javax.servlet.ServletRequest

Overrides:

getParameterValues in class javax.servlet.ServletRequestWrapper

See Also:

ServletRequestWrapper.getParameterValues(java.lang.String)

getRequestParameter

public org.apache.sling.api.request.RequestParameter getRequestParameter(String name)

Specified by:

getRequestParameter in interface org.apache.sling.api.SlingHttpServletRequest

See Also:

SlingHttpServletRequest.getRequestParameter(java.lang.String)

getRequestParameters

public org.apache.sling.api.request.RequestParameter[] getRequestParameters(String name)

Specified by:

getRequestParameters in interface org.apache.sling.api.SlingHttpServletRequest

See Also:

SlingHttpServletRequest.getRequestParameters(java.lang.String)

getRequestParameterMap

public org.apache.sling.api.request.RequestParameterMap getRequestParameterMap()

Specified by:

getRequestParameterMap in interface org.apache.sling.api.SlingHttpServletRequest

See Also:

SlingHttpServletRequest.getRequestParameterMap()

getRequestParameterList

public List<org.apache.sling.api.request.RequestParameter> getRequestParameterList()

Specified by:

getRequestParameterList in interface org.apache.sling.api.SlingHttpServletRequest

See Also:

SlingHttpServletRequest.getRequestParameterList()

getCookie

public javax.servlet.http.Cookie getCookie(String name)

Specified by:

getCookie in interface org.apache.sling.api.SlingHttpServletRequest

See Also:

SlingHttpServletRequest.getCookie(java.lang.String)

getRequestPathInfo

public org.apache.sling.api.request.RequestPathInfo getRequestPathInfo()

Specified by:

getRequestPathInfo in interface org.apache.sling.api.SlingHttpServletRequest

See Also:

SlingHttpServletRequest.getRequestPathInfo()

getResourceBundle

public ResourceBundle getResourceBundle(Locale locale)

Specified by:

getResourceBundle in interface org.apache.sling.api.SlingHttpServletRequest

See Also:

SlingHttpServletRequest.getResourceBundle(java.util.Locale)

getResourceBundle

public ResourceBundle getResourceBundle(String baseName,
                               Locale locale)

Specified by:

getResourceBundle in interface org.apache.sling.api.SlingHttpServletRequest

See Also:

SlingHttpServletRequest.getResourceBundle(String, Locale)

getResponseContentType

public String getResponseContentType()

Specified by:

getResponseContentType in interface org.apache.sling.api.SlingHttpServletRequest

See Also:

SlingHttpServletRequest.getResponseContentType()

getResponseContentTypes

public Enumeration<String> getResponseContentTypes()

Specified by:

getResponseContentTypes in interface org.apache.sling.api.SlingHttpServletRequest

See Also:

SlingHttpServletRequest.getResponseContentTypes()

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException

Specified by:

getInputStream in interface javax.servlet.ServletRequest

Overrides:

getInputStream in class javax.servlet.ServletRequestWrapper

Throws:

IOException

See Also:

ServletRequestWrapper.getInputStream()

getReader

public BufferedReader getReader()
                         throws UnsupportedEncodingException,
                                IOException

Specified by:

getReader in interface javax.servlet.ServletRequest

Overrides:

getReader in class javax.servlet.ServletRequestWrapper

Throws:

UnsupportedEncodingException

IOException

See Also:

ServletRequestWrapper.getReader()

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface javax.servlet.http.HttpServletRequest

Overrides:

getUserPrincipal in class javax.servlet.http.HttpServletRequestWrapper

See Also:

HttpServletRequestWrapper.getUserPrincipal()

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface javax.servlet.http.HttpServletRequest

Overrides:

isUserInRole in class javax.servlet.http.HttpServletRequestWrapper

See Also:

HttpServletRequestWrapper.isUserInRole(String)

getServletPath

public String getServletPath()

Always returns the empty string since the actual servlet registered with the servlet container (the HttpService actually) is registered as if the servlet path is "/*".

Specified by:

getServletPath in interface javax.servlet.http.HttpServletRequest

Overrides:

getServletPath in class javax.servlet.http.HttpServletRequestWrapper

getPathInfo

public String getPathInfo()

Returns the part of the request URL without the leading servlet context path.

Specified by:

getPathInfo in interface javax.servlet.http.HttpServletRequest

Overrides:

getPathInfo in class javax.servlet.http.HttpServletRequestWrapper