Class SlingServletRequestAdapter
java.lang.Object
javax.servlet.ServletRequestWrapper
javax.servlet.http.HttpServletRequestWrapper
org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
org.apache.sling.engine.impl.adapter.SlingServletRequestAdapter
- All Implemented Interfaces:
javax.servlet.http.HttpServletRequest
,javax.servlet.ServletRequest
,Adaptable
,SlingHttpServletRequest
The
SlingServletRequestAdapter
class is a
ComponentRequestWrapper
which does not delegate to a wrapped
ComponentRequest
but to a wrapped
HttpServletRequest
. This is required if any user of the
RequestDispatcher.include
method uses a
HttpServletRequestWrapper
instead of a
ComponentRequestWrapper
.-
Field Summary
Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
-
Constructor Summary
ConstructorsConstructorDescriptionSlingServletRequestAdapter
(SlingHttpServletRequest delegatee, javax.servlet.http.HttpServletRequest request) -
Method Summary
Modifier and TypeMethodDescriptiongetAttribute
(String name) Returns the name of the authentication scheme used to protect the servlet.int
javax.servlet.http.Cookie[]
long
getDateHeader
(String name) getHeaders
(String name) javax.servlet.ServletInputStream
int
getIntHeader
(String name) int
getParameter
(String name) String[]
getParameterValues
(String name) getRealPath
(String path) Deprecated.int
Returns the login of the user making this request, if the user has been authenticated, ornull
if the user has not been authenticated.javax.servlet.ServletRequest
javax.servlet.RequestDispatcher
getRequestDispatcher
(String path) int
javax.servlet.http.HttpSession
javax.servlet.http.HttpSession
getSession
(boolean create) Return the originalSlingHttpServletRequest
object wrapped by this.Returns ajava.security.Principal
object containing the name of the current authenticated user.boolean
boolean
Deprecated.boolean
boolean
boolean
isSecure()
boolean
isUserInRole
(String role) void
removeAttribute
(String name) void
setAttribute
(String name, Object o) void
Methods inherited from class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
adaptTo, getCookie, getRequestDispatcher, getRequestDispatcher, getRequestDispatcher, getRequestParameter, getRequestParameterList, getRequestParameterMap, getRequestParameters, getRequestPathInfo, getRequestProgressTracker, getResource, getResourceBundle, getResourceBundle, getResourceResolver, getResponseContentType, getResponseContentTypes
Methods inherited from class javax.servlet.http.HttpServletRequestWrapper
authenticate, changeSessionId, getPart, getParts, login, logout, upgrade
Methods inherited from class javax.servlet.ServletRequestWrapper
getAsyncContext, getContentLengthLong, getDispatcherType, getServletContext, isAsyncStarted, isAsyncSupported, isWrapperFor, isWrapperFor, 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, changeSessionId, getPart, getParts, login, logout, upgrade
Methods inherited from interface javax.servlet.ServletRequest
getAsyncContext, getContentLengthLong, getDispatcherType, getServletContext, isAsyncStarted, isAsyncSupported, startAsync, startAsync
-
Constructor Details
-
SlingServletRequestAdapter
public SlingServletRequestAdapter(SlingHttpServletRequest delegatee, javax.servlet.http.HttpServletRequest request)
-
-
Method Details
-
getLocalAddr
- Specified by:
getLocalAddr
in interfacejavax.servlet.ServletRequest
- Overrides:
getLocalAddr
in classjavax.servlet.ServletRequestWrapper
-
getLocalName
- Specified by:
getLocalName
in interfacejavax.servlet.ServletRequest
- Overrides:
getLocalName
in classjavax.servlet.ServletRequestWrapper
-
getLocalPort
public int getLocalPort()- Specified by:
getLocalPort
in interfacejavax.servlet.ServletRequest
- Overrides:
getLocalPort
in classjavax.servlet.ServletRequestWrapper
-
getRemotePort
public int getRemotePort()- Specified by:
getRemotePort
in interfacejavax.servlet.ServletRequest
- Overrides:
getRemotePort
in classjavax.servlet.ServletRequestWrapper
-
getAuthType
Description copied from interface:SlingHttpServletRequest
Returns the name of the authentication scheme used to protect the servlet. All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the request is not authenticatednull
is returned.- Specified by:
getAuthType
in interfacejavax.servlet.http.HttpServletRequest
- Specified by:
getAuthType
in interfaceSlingHttpServletRequest
- Overrides:
getAuthType
in classjavax.servlet.http.HttpServletRequestWrapper
- Returns:
- the authentication scheme or {code null}
- See Also:
-
SlingHttpServletRequest.getRemoteUser()
HttpServletRequest.getAuthType()
-
getContextPath
- Specified by:
getContextPath
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getContextPath
in classjavax.servlet.http.HttpServletRequestWrapper
-
getCookies
public javax.servlet.http.Cookie[] getCookies()- Specified by:
getCookies
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getCookies
in classjavax.servlet.http.HttpServletRequestWrapper
-
getDateHeader
- Specified by:
getDateHeader
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getDateHeader
in classjavax.servlet.http.HttpServletRequestWrapper
-
getHeader
- Specified by:
getHeader
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getHeader
in classjavax.servlet.http.HttpServletRequestWrapper
-
getHeaderNames
- Specified by:
getHeaderNames
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getHeaderNames
in classjavax.servlet.http.HttpServletRequestWrapper
-
getHeaders
- Specified by:
getHeaders
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getHeaders
in classjavax.servlet.http.HttpServletRequestWrapper
-
getIntHeader
- Specified by:
getIntHeader
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getIntHeader
in classjavax.servlet.http.HttpServletRequestWrapper
-
getMethod
- Specified by:
getMethod
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getMethod
in classjavax.servlet.http.HttpServletRequestWrapper
-
getPathInfo
- Specified by:
getPathInfo
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getPathInfo
in classjavax.servlet.http.HttpServletRequestWrapper
-
getPathTranslated
- Specified by:
getPathTranslated
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getPathTranslated
in classjavax.servlet.http.HttpServletRequestWrapper
-
getQueryString
- Specified by:
getQueryString
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getQueryString
in classjavax.servlet.http.HttpServletRequestWrapper
-
getRemoteUser
Description copied from interface:SlingHttpServletRequest
Returns the login of the user making this request, if the user has been authenticated, ornull
if the user has not been authenticated.- Specified by:
getRemoteUser
in interfacejavax.servlet.http.HttpServletRequest
- Specified by:
getRemoteUser
in interfaceSlingHttpServletRequest
- Overrides:
getRemoteUser
in classjavax.servlet.http.HttpServletRequestWrapper
- Returns:
- a
String
specifying the login of the user making this request, ornull
- See Also:
-
SlingHttpServletRequest.getAuthType()
HttpServletRequest.getRemoteUser()
-
getRequestURI
- Specified by:
getRequestURI
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getRequestURI
in classjavax.servlet.http.HttpServletRequestWrapper
-
getRequestURL
- Specified by:
getRequestURL
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getRequestURL
in classjavax.servlet.http.HttpServletRequestWrapper
-
getRequestedSessionId
- Specified by:
getRequestedSessionId
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getRequestedSessionId
in classjavax.servlet.http.HttpServletRequestWrapper
-
getServletPath
- Specified by:
getServletPath
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getServletPath
in classjavax.servlet.http.HttpServletRequestWrapper
-
getSession
public javax.servlet.http.HttpSession getSession()- Specified by:
getSession
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getSession
in classjavax.servlet.http.HttpServletRequestWrapper
-
getSession
public javax.servlet.http.HttpSession getSession(boolean create) - Specified by:
getSession
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
getSession
in classjavax.servlet.http.HttpServletRequestWrapper
-
getUserPrincipal
Description copied from interface:SlingHttpServletRequest
Returns ajava.security.Principal
object containing the name of the current authenticated user.Note: This method deviates from the parent interface and might return a prinicpal even for anonymous users. Therefore it cannot be used to determine whether the user is authenticated.
- Specified by:
getUserPrincipal
in interfacejavax.servlet.http.HttpServletRequest
- Specified by:
getUserPrincipal
in interfaceSlingHttpServletRequest
- Overrides:
getUserPrincipal
in classjavax.servlet.http.HttpServletRequestWrapper
- Returns:
- a
java.security.Principal
ornull
. - See Also:
-
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()- Specified by:
isRequestedSessionIdFromCookie
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
isRequestedSessionIdFromCookie
in classjavax.servlet.http.HttpServletRequestWrapper
-
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()- Specified by:
isRequestedSessionIdFromURL
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
isRequestedSessionIdFromURL
in classjavax.servlet.http.HttpServletRequestWrapper
-
isRequestedSessionIdFromUrl
Deprecated.- Specified by:
isRequestedSessionIdFromUrl
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
isRequestedSessionIdFromUrl
in classjavax.servlet.http.HttpServletRequestWrapper
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()- Specified by:
isRequestedSessionIdValid
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
isRequestedSessionIdValid
in classjavax.servlet.http.HttpServletRequestWrapper
-
isUserInRole
- Specified by:
isUserInRole
in interfacejavax.servlet.http.HttpServletRequest
- Overrides:
isUserInRole
in classjavax.servlet.http.HttpServletRequestWrapper
-
getAttribute
- Specified by:
getAttribute
in interfacejavax.servlet.ServletRequest
- Overrides:
getAttribute
in classjavax.servlet.ServletRequestWrapper
-
getAttributeNames
- Specified by:
getAttributeNames
in interfacejavax.servlet.ServletRequest
- Overrides:
getAttributeNames
in classjavax.servlet.ServletRequestWrapper
-
getCharacterEncoding
- Specified by:
getCharacterEncoding
in interfacejavax.servlet.ServletRequest
- Overrides:
getCharacterEncoding
in classjavax.servlet.ServletRequestWrapper
-
getContentLength
public int getContentLength()- Specified by:
getContentLength
in interfacejavax.servlet.ServletRequest
- Overrides:
getContentLength
in classjavax.servlet.ServletRequestWrapper
-
getContentType
- Specified by:
getContentType
in interfacejavax.servlet.ServletRequest
- Overrides:
getContentType
in classjavax.servlet.ServletRequestWrapper
-
getInputStream
- Specified by:
getInputStream
in interfacejavax.servlet.ServletRequest
- Overrides:
getInputStream
in classjavax.servlet.ServletRequestWrapper
- Throws:
IOException
-
getLocale
- Specified by:
getLocale
in interfacejavax.servlet.ServletRequest
- Overrides:
getLocale
in classjavax.servlet.ServletRequestWrapper
-
getLocales
- Specified by:
getLocales
in interfacejavax.servlet.ServletRequest
- Overrides:
getLocales
in classjavax.servlet.ServletRequestWrapper
-
getParameter
- Specified by:
getParameter
in interfacejavax.servlet.ServletRequest
- Overrides:
getParameter
in classjavax.servlet.ServletRequestWrapper
-
getParameterMap
- Specified by:
getParameterMap
in interfacejavax.servlet.ServletRequest
- Overrides:
getParameterMap
in classjavax.servlet.ServletRequestWrapper
-
getParameterNames
- Specified by:
getParameterNames
in interfacejavax.servlet.ServletRequest
- Overrides:
getParameterNames
in classjavax.servlet.ServletRequestWrapper
-
getParameterValues
- Specified by:
getParameterValues
in interfacejavax.servlet.ServletRequest
- Overrides:
getParameterValues
in classjavax.servlet.ServletRequestWrapper
-
getProtocol
- Specified by:
getProtocol
in interfacejavax.servlet.ServletRequest
- Overrides:
getProtocol
in classjavax.servlet.ServletRequestWrapper
-
getReader
- Specified by:
getReader
in interfacejavax.servlet.ServletRequest
- Overrides:
getReader
in classjavax.servlet.ServletRequestWrapper
- Throws:
IOException
-
getRealPath
Deprecated.- Specified by:
getRealPath
in interfacejavax.servlet.ServletRequest
- Overrides:
getRealPath
in classjavax.servlet.ServletRequestWrapper
-
getRemoteAddr
- Specified by:
getRemoteAddr
in interfacejavax.servlet.ServletRequest
- Overrides:
getRemoteAddr
in classjavax.servlet.ServletRequestWrapper
-
getRemoteHost
- Specified by:
getRemoteHost
in interfacejavax.servlet.ServletRequest
- Overrides:
getRemoteHost
in classjavax.servlet.ServletRequestWrapper
-
getRequest
public javax.servlet.ServletRequest getRequest()- Overrides:
getRequest
in classjavax.servlet.ServletRequestWrapper
-
getSlingRequest
Description copied from class:SlingHttpServletRequestWrapper
Return the originalSlingHttpServletRequest
object wrapped by this.- Overrides:
getSlingRequest
in classSlingHttpServletRequestWrapper
- Returns:
- The wrapped request.
-
getRequestDispatcher
- Specified by:
getRequestDispatcher
in interfacejavax.servlet.ServletRequest
- Overrides:
getRequestDispatcher
in classjavax.servlet.ServletRequestWrapper
-
getScheme
- Specified by:
getScheme
in interfacejavax.servlet.ServletRequest
- Overrides:
getScheme
in classjavax.servlet.ServletRequestWrapper
-
getServerName
- Specified by:
getServerName
in interfacejavax.servlet.ServletRequest
- Overrides:
getServerName
in classjavax.servlet.ServletRequestWrapper
-
getServerPort
public int getServerPort()- Specified by:
getServerPort
in interfacejavax.servlet.ServletRequest
- Overrides:
getServerPort
in classjavax.servlet.ServletRequestWrapper
-
isSecure
public boolean isSecure()- Specified by:
isSecure
in interfacejavax.servlet.ServletRequest
- Overrides:
isSecure
in classjavax.servlet.ServletRequestWrapper
-
removeAttribute
- Specified by:
removeAttribute
in interfacejavax.servlet.ServletRequest
- Overrides:
removeAttribute
in classjavax.servlet.ServletRequestWrapper
-
setAttribute
- Specified by:
setAttribute
in interfacejavax.servlet.ServletRequest
- Overrides:
setAttribute
in classjavax.servlet.ServletRequestWrapper
-
setCharacterEncoding
- Specified by:
setCharacterEncoding
in interfacejavax.servlet.ServletRequest
- Overrides:
setCharacterEncoding
in classjavax.servlet.ServletRequestWrapper
- Throws:
UnsupportedEncodingException
-