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.intjavax.servlet.http.Cookie[]longgetDateHeader(String name) getHeaders(String name) javax.servlet.ServletInputStreamintgetIntHeader(String name) intgetParameter(String name) String[]getParameterValues(String name) getRealPath(String path) Deprecated.intReturns the login of the user making this request, if the user has been authenticated, ornullif the user has not been authenticated.javax.servlet.ServletRequestjavax.servlet.RequestDispatchergetRequestDispatcher(String path) intjavax.servlet.http.HttpSessionjavax.servlet.http.HttpSessiongetSession(boolean create) Return the originalSlingHttpServletRequestobject wrapped by this.Returns ajava.security.Principalobject containing the name of the current authenticated user.booleanbooleanDeprecated.booleanbooleanbooleanisSecure()booleanisUserInRole(String role) voidremoveAttribute(String name) voidsetAttribute(String name, Object o) voidMethods 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, getResponseContentTypesMethods inherited from class javax.servlet.http.HttpServletRequestWrapper
authenticate, changeSessionId, getPart, getParts, login, logout, upgradeMethods inherited from class javax.servlet.ServletRequestWrapper
getAsyncContext, getContentLengthLong, getDispatcherType, getServletContext, isAsyncStarted, isAsyncSupported, isWrapperFor, isWrapperFor, setRequest, startAsync, startAsyncMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javax.servlet.http.HttpServletRequest
authenticate, changeSessionId, getPart, getParts, login, logout, upgradeMethods 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:
getLocalAddrin interfacejavax.servlet.ServletRequest- Overrides:
getLocalAddrin classjavax.servlet.ServletRequestWrapper
-
getLocalName
- Specified by:
getLocalNamein interfacejavax.servlet.ServletRequest- Overrides:
getLocalNamein classjavax.servlet.ServletRequestWrapper
-
getLocalPort
public int getLocalPort()- Specified by:
getLocalPortin interfacejavax.servlet.ServletRequest- Overrides:
getLocalPortin classjavax.servlet.ServletRequestWrapper
-
getRemotePort
public int getRemotePort()- Specified by:
getRemotePortin interfacejavax.servlet.ServletRequest- Overrides:
getRemotePortin classjavax.servlet.ServletRequestWrapper
-
getAuthType
Description copied from interface:SlingHttpServletRequestReturns 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 authenticatednullis returned.- Specified by:
getAuthTypein interfacejavax.servlet.http.HttpServletRequest- Specified by:
getAuthTypein interfaceSlingHttpServletRequest- Overrides:
getAuthTypein classjavax.servlet.http.HttpServletRequestWrapper- Returns:
- the authentication scheme or {code null}
- See Also:
-
SlingHttpServletRequest.getRemoteUser()HttpServletRequest.getAuthType()
-
getContextPath
- Specified by:
getContextPathin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getContextPathin classjavax.servlet.http.HttpServletRequestWrapper
-
getCookies
public javax.servlet.http.Cookie[] getCookies()- Specified by:
getCookiesin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getCookiesin classjavax.servlet.http.HttpServletRequestWrapper
-
getDateHeader
- Specified by:
getDateHeaderin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getDateHeaderin classjavax.servlet.http.HttpServletRequestWrapper
-
getHeader
- Specified by:
getHeaderin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getHeaderin classjavax.servlet.http.HttpServletRequestWrapper
-
getHeaderNames
- Specified by:
getHeaderNamesin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getHeaderNamesin classjavax.servlet.http.HttpServletRequestWrapper
-
getHeaders
- Specified by:
getHeadersin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getHeadersin classjavax.servlet.http.HttpServletRequestWrapper
-
getIntHeader
- Specified by:
getIntHeaderin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getIntHeaderin classjavax.servlet.http.HttpServletRequestWrapper
-
getMethod
- Specified by:
getMethodin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getMethodin classjavax.servlet.http.HttpServletRequestWrapper
-
getPathInfo
- Specified by:
getPathInfoin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getPathInfoin classjavax.servlet.http.HttpServletRequestWrapper
-
getPathTranslated
- Specified by:
getPathTranslatedin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getPathTranslatedin classjavax.servlet.http.HttpServletRequestWrapper
-
getQueryString
- Specified by:
getQueryStringin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getQueryStringin classjavax.servlet.http.HttpServletRequestWrapper
-
getRemoteUser
Description copied from interface:SlingHttpServletRequestReturns the login of the user making this request, if the user has been authenticated, ornullif the user has not been authenticated.- Specified by:
getRemoteUserin interfacejavax.servlet.http.HttpServletRequest- Specified by:
getRemoteUserin interfaceSlingHttpServletRequest- Overrides:
getRemoteUserin classjavax.servlet.http.HttpServletRequestWrapper- Returns:
- a
Stringspecifying the login of the user making this request, ornull - See Also:
-
SlingHttpServletRequest.getAuthType()HttpServletRequest.getRemoteUser()
-
getRequestURI
- Specified by:
getRequestURIin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getRequestURIin classjavax.servlet.http.HttpServletRequestWrapper
-
getRequestURL
- Specified by:
getRequestURLin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getRequestURLin classjavax.servlet.http.HttpServletRequestWrapper
-
getRequestedSessionId
- Specified by:
getRequestedSessionIdin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getRequestedSessionIdin classjavax.servlet.http.HttpServletRequestWrapper
-
getServletPath
- Specified by:
getServletPathin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getServletPathin classjavax.servlet.http.HttpServletRequestWrapper
-
getSession
public javax.servlet.http.HttpSession getSession()- Specified by:
getSessionin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getSessionin classjavax.servlet.http.HttpServletRequestWrapper
-
getSession
public javax.servlet.http.HttpSession getSession(boolean create) - Specified by:
getSessionin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getSessionin classjavax.servlet.http.HttpServletRequestWrapper
-
getUserPrincipal
Description copied from interface:SlingHttpServletRequestReturns ajava.security.Principalobject 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:
getUserPrincipalin interfacejavax.servlet.http.HttpServletRequest- Specified by:
getUserPrincipalin interfaceSlingHttpServletRequest- Overrides:
getUserPrincipalin classjavax.servlet.http.HttpServletRequestWrapper- Returns:
- a
java.security.Principalornull. - See Also:
-
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()- Specified by:
isRequestedSessionIdFromCookiein interfacejavax.servlet.http.HttpServletRequest- Overrides:
isRequestedSessionIdFromCookiein classjavax.servlet.http.HttpServletRequestWrapper
-
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()- Specified by:
isRequestedSessionIdFromURLin interfacejavax.servlet.http.HttpServletRequest- Overrides:
isRequestedSessionIdFromURLin classjavax.servlet.http.HttpServletRequestWrapper
-
isRequestedSessionIdFromUrl
Deprecated.- Specified by:
isRequestedSessionIdFromUrlin interfacejavax.servlet.http.HttpServletRequest- Overrides:
isRequestedSessionIdFromUrlin classjavax.servlet.http.HttpServletRequestWrapper
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()- Specified by:
isRequestedSessionIdValidin interfacejavax.servlet.http.HttpServletRequest- Overrides:
isRequestedSessionIdValidin classjavax.servlet.http.HttpServletRequestWrapper
-
isUserInRole
- Specified by:
isUserInRolein interfacejavax.servlet.http.HttpServletRequest- Overrides:
isUserInRolein classjavax.servlet.http.HttpServletRequestWrapper
-
getAttribute
- Specified by:
getAttributein interfacejavax.servlet.ServletRequest- Overrides:
getAttributein classjavax.servlet.ServletRequestWrapper
-
getAttributeNames
- Specified by:
getAttributeNamesin interfacejavax.servlet.ServletRequest- Overrides:
getAttributeNamesin classjavax.servlet.ServletRequestWrapper
-
getCharacterEncoding
- Specified by:
getCharacterEncodingin interfacejavax.servlet.ServletRequest- Overrides:
getCharacterEncodingin classjavax.servlet.ServletRequestWrapper
-
getContentLength
public int getContentLength()- Specified by:
getContentLengthin interfacejavax.servlet.ServletRequest- Overrides:
getContentLengthin classjavax.servlet.ServletRequestWrapper
-
getContentType
- Specified by:
getContentTypein interfacejavax.servlet.ServletRequest- Overrides:
getContentTypein classjavax.servlet.ServletRequestWrapper
-
getInputStream
- Specified by:
getInputStreamin interfacejavax.servlet.ServletRequest- Overrides:
getInputStreamin classjavax.servlet.ServletRequestWrapper- Throws:
IOException
-
getLocale
- Specified by:
getLocalein interfacejavax.servlet.ServletRequest- Overrides:
getLocalein classjavax.servlet.ServletRequestWrapper
-
getLocales
- Specified by:
getLocalesin interfacejavax.servlet.ServletRequest- Overrides:
getLocalesin classjavax.servlet.ServletRequestWrapper
-
getParameter
- Specified by:
getParameterin interfacejavax.servlet.ServletRequest- Overrides:
getParameterin classjavax.servlet.ServletRequestWrapper
-
getParameterMap
- Specified by:
getParameterMapin interfacejavax.servlet.ServletRequest- Overrides:
getParameterMapin classjavax.servlet.ServletRequestWrapper
-
getParameterNames
- Specified by:
getParameterNamesin interfacejavax.servlet.ServletRequest- Overrides:
getParameterNamesin classjavax.servlet.ServletRequestWrapper
-
getParameterValues
- Specified by:
getParameterValuesin interfacejavax.servlet.ServletRequest- Overrides:
getParameterValuesin classjavax.servlet.ServletRequestWrapper
-
getProtocol
- Specified by:
getProtocolin interfacejavax.servlet.ServletRequest- Overrides:
getProtocolin classjavax.servlet.ServletRequestWrapper
-
getReader
- Specified by:
getReaderin interfacejavax.servlet.ServletRequest- Overrides:
getReaderin classjavax.servlet.ServletRequestWrapper- Throws:
IOException
-
getRealPath
Deprecated.- Specified by:
getRealPathin interfacejavax.servlet.ServletRequest- Overrides:
getRealPathin classjavax.servlet.ServletRequestWrapper
-
getRemoteAddr
- Specified by:
getRemoteAddrin interfacejavax.servlet.ServletRequest- Overrides:
getRemoteAddrin classjavax.servlet.ServletRequestWrapper
-
getRemoteHost
- Specified by:
getRemoteHostin interfacejavax.servlet.ServletRequest- Overrides:
getRemoteHostin classjavax.servlet.ServletRequestWrapper
-
getRequest
public javax.servlet.ServletRequest getRequest()- Overrides:
getRequestin classjavax.servlet.ServletRequestWrapper
-
getSlingRequest
Description copied from class:SlingHttpServletRequestWrapperReturn the originalSlingHttpServletRequestobject wrapped by this.- Overrides:
getSlingRequestin classSlingHttpServletRequestWrapper- Returns:
- The wrapped request.
-
getRequestDispatcher
- Specified by:
getRequestDispatcherin interfacejavax.servlet.ServletRequest- Overrides:
getRequestDispatcherin classjavax.servlet.ServletRequestWrapper
-
getScheme
- Specified by:
getSchemein interfacejavax.servlet.ServletRequest- Overrides:
getSchemein classjavax.servlet.ServletRequestWrapper
-
getServerName
- Specified by:
getServerNamein interfacejavax.servlet.ServletRequest- Overrides:
getServerNamein classjavax.servlet.ServletRequestWrapper
-
getServerPort
public int getServerPort()- Specified by:
getServerPortin interfacejavax.servlet.ServletRequest- Overrides:
getServerPortin classjavax.servlet.ServletRequestWrapper
-
isSecure
public boolean isSecure()- Specified by:
isSecurein interfacejavax.servlet.ServletRequest- Overrides:
isSecurein classjavax.servlet.ServletRequestWrapper
-
removeAttribute
- Specified by:
removeAttributein interfacejavax.servlet.ServletRequest- Overrides:
removeAttributein classjavax.servlet.ServletRequestWrapper
-
setAttribute
- Specified by:
setAttributein interfacejavax.servlet.ServletRequest- Overrides:
setAttributein classjavax.servlet.ServletRequestWrapper
-
setCharacterEncoding
- Specified by:
setCharacterEncodingin interfacejavax.servlet.ServletRequest- Overrides:
setCharacterEncodingin classjavax.servlet.ServletRequestWrapper- Throws:
UnsupportedEncodingException
-