org.apache.sling.engine.impl
Class SlingHttpServletRequestImpl

java.lang.Object
  extended by javax.servlet.ServletRequestWrapper
      extended by javax.servlet.http.HttpServletRequestWrapper
          extended by org.apache.sling.engine.impl.SlingHttpServletRequestImpl
All Implemented Interfaces:
javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, Adaptable, SlingHttpServletRequest

public class SlingHttpServletRequestImpl
extends javax.servlet.http.HttpServletRequestWrapper
implements SlingHttpServletRequest

The SlingHttpServletRequestImpl TODO


Constructor Summary
SlingHttpServletRequestImpl(RequestData requestData, javax.servlet.http.HttpServletRequest servletRequest)
           
 
Method Summary
<AdapterType>
AdapterType
adaptTo(Class<AdapterType> type)
          Adapts the adaptable to another type.
 javax.servlet.http.Cookie getCookie(String name)
          Returns the named cookie from the HTTP request or null if no such cookie exists in the request.
 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(Resource resource)
          Returns null if resource is null.
 javax.servlet.RequestDispatcher getRequestDispatcher(Resource resource, 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, RequestDispatcherOptions options)
          Returns null if path is null.
 RequestParameter getRequestParameter(String name)
          Returns the value of a request parameter as a RequestParameter, or null if the parameter does not exist.
 RequestParameterMap getRequestParameterMap()
          Returns a Map of the parameters of this request.
 RequestParameter[] getRequestParameters(String name)
          Returns an array of RequestParameter objects containing all of the values the given request parameter has, or null if the parameter does not exist.
 RequestPathInfo getRequestPathInfo()
          Returns the RequestPathInfo pertaining to this request.
 RequestProgressTracker getRequestProgressTracker()
          Returns the RequestProgressTracker of this request.
 Resource getResource()
          Returns the Resource object on whose behalf the servlet acts.
 ResourceBundle getResourceBundle(Locale locale)
          Returns the resource bundle for the given locale.
 ResourceBundle getResourceBundle(String baseName, Locale locale)
          Returns the resource bundle of the given base name for the given locale.
 ResourceResolver getResourceResolver()
          Returns the ResourceResolver which resolved the resource of this request.
 String getResponseContentType()
          Returns the framework preferred content type for the response.
 Enumeration<String> getResponseContentTypes()
          Gets a list of content types which the framework accepts for the response.
 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
getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getSession, getSession, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid
 
Methods inherited from class javax.servlet.ServletRequestWrapper
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setRequest
 
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
getAuthType, getCookies, getDateHeader, getHeader, getHeaderNames, getIntHeader, getMethod, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getSession, getSession, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid
 
Methods inherited from interface javax.servlet.ServletRequest
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getScheme, getServerName, getServerPort, setAttribute
 

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)
Description copied from interface: Adaptable
Adapts the adaptable to another type.

Specified by:
adaptTo in interface Adaptable
Type Parameters:
AdapterType - The generic type to which this resource is adapted to
Parameters:
type - The Class object of the target type, such as Node.class
Returns:
The adapter target or null if the resource cannot adapt to the requested type

getResource

public Resource getResource()
Description copied from interface: SlingHttpServletRequest
Returns the Resource object on whose behalf the servlet acts.

Specified by:
getResource in interface SlingHttpServletRequest
Returns:
The Resource object of this request.

getResourceResolver

public ResourceResolver getResourceResolver()
Description copied from interface: SlingHttpServletRequest
Returns the ResourceResolver which resolved the resource of this request.

Specified by:
getResourceResolver in interface SlingHttpServletRequest
Returns:
The resource resolver

getRequestProgressTracker

public RequestProgressTracker getRequestProgressTracker()
Description copied from interface: SlingHttpServletRequest
Returns the RequestProgressTracker of this request.

Specified by:
getRequestProgressTracker in interface SlingHttpServletRequest

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(Resource resource)
Returns null if resource is null.

Specified by:
getRequestDispatcher in interface SlingHttpServletRequest

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(Resource resource,
                                                            RequestDispatcherOptions options)
Returns null if resource is null.

Specified by:
getRequestDispatcher in interface SlingHttpServletRequest
Parameters:
resource - The Resource instance whose response content may be included by the returned dispatcher.
options - influence the rendering of the included Resource
Returns:
a RequestDispatcher object that acts as a wrapper for the resource or null if an error occurs preparing the dispatcher.

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
Returns null if path is null.

Overrides:
getRequestDispatcher in class javax.servlet.ServletRequestWrapper

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(String path,
                                                            RequestDispatcherOptions options)
Returns null if path is null.

Specified by:
getRequestDispatcher in interface SlingHttpServletRequest
Parameters:
path - a String specifying the pathname to the resource. If it is relative, it must be relative against the current servlet.
options - influence the rendering of the included Resource
Returns:
a RequestDispatcher object that acts as a wrapper for the resource or null if an error occurs preparing the dispatcher.

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()
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 RequestParameter getRequestParameter(String name)
Description copied from interface: SlingHttpServletRequest
Returns the value of a request parameter as a RequestParameter, or null if the parameter does not exist.

This method should only be used if the parameter has only one value. If the parameter might have more than one value, use SlingHttpServletRequest.getRequestParameters(String).

If this method is used with a multivalued parameter, the value returned is equal to the first value in the array returned by getRequestParameters.

This method is a shortcut for getRequestParameterMap().getValue(String).

Specified by:
getRequestParameter in interface SlingHttpServletRequest
Parameters:
name - a String specifying the name of the parameter
Returns:
a RequestParameter representing the single value of the parameter
See Also:
SlingHttpServletRequest.getRequestParameter(java.lang.String)

getRequestParameters

public RequestParameter[] getRequestParameters(String name)
Description copied from interface: SlingHttpServletRequest
Returns an array of RequestParameter objects containing all of the values the given request parameter has, or null if the parameter does not exist.

If the parameter has a single value, the array has a length of 1.

This method is a shortcut for getRequestParameterMap().getValues(String).

Specified by:
getRequestParameters in interface SlingHttpServletRequest
Parameters:
name - a String containing the name of the parameter the value of which is requested
Returns:
an array of RequestParameter objects containing the parameter values.
See Also:
SlingHttpServletRequest.getRequestParameters(java.lang.String)

getRequestParameterMap

public RequestParameterMap getRequestParameterMap()
Description copied from interface: SlingHttpServletRequest
Returns a Map of the parameters of this request.

The values in the returned Map are from type RequestParameter array (RequestParameter[]).

If no parameters exist this method returns an empty Map.

Specified by:
getRequestParameterMap in interface SlingHttpServletRequest
Returns:
an immutable Map containing parameter names as keys and parameter values as map values, or an empty Map if no parameters exist. The keys in the parameter map are of type String. The values in the parameter map are of type RequestParameter array (RequestParameter[]).
See Also:
SlingHttpServletRequest.getRequestParameterMap()

getCookie

public javax.servlet.http.Cookie getCookie(String name)
Description copied from interface: SlingHttpServletRequest
Returns the named cookie from the HTTP request or null if no such cookie exists in the request.

Specified by:
getCookie in interface SlingHttpServletRequest
Parameters:
name - The name of the cookie to return.
Returns:
The named cookie or null if no such cookie exists.
See Also:
SlingHttpServletRequest.getCookie(java.lang.String)

getRequestPathInfo

public RequestPathInfo getRequestPathInfo()
Description copied from interface: SlingHttpServletRequest
Returns the RequestPathInfo pertaining to this request.

Specified by:
getRequestPathInfo in interface SlingHttpServletRequest
Returns:
the request path info.
See Also:
SlingHttpServletRequest.getRequestPathInfo()

getResourceBundle

public ResourceBundle getResourceBundle(Locale locale)
Description copied from interface: SlingHttpServletRequest
Returns the resource bundle for the given locale.

Specified by:
getResourceBundle in interface SlingHttpServletRequest
Parameters:
locale - the locale for which to retrieve the resource bundle. If this is null, the locale returned by #getLocale() is used to select the resource bundle.
Returns:
the resource bundle for the given locale
See Also:
SlingHttpServletRequest.getResourceBundle(java.util.Locale)

getResourceBundle

public ResourceBundle getResourceBundle(String baseName,
                                        Locale locale)
Description copied from interface: SlingHttpServletRequest
Returns the resource bundle of the given base name for the given locale.

Specified by:
getResourceBundle in interface SlingHttpServletRequest
Parameters:
baseName - The base name of the resource bundle to returned. If this parameter is null, the same resource bundle must be returned as if the SlingHttpServletRequest.getResourceBundle(Locale) method is called.
locale - the locale for which to retrieve the resource bundle. If this is null, the locale returned by #getLocale() is used to select the resource bundle.
Returns:
the resource bundle for the given locale
See Also:
SlingHttpServletRequest.getResourceBundle(String, Locale)

getResponseContentType

public String getResponseContentType()
Description copied from interface: SlingHttpServletRequest
Returns the framework preferred content type for the response. The content type only includes the MIME type, not the character set.

For included resources this method will returned the same string as returned by the ServletResponse.getContentType() without the character set.

Specified by:
getResponseContentType in interface SlingHttpServletRequest
Returns:
preferred MIME type of the response
See Also:
SlingHttpServletRequest.getResponseContentType()

getResponseContentTypes

public Enumeration<String> getResponseContentTypes()
Description copied from interface: SlingHttpServletRequest
Gets a list of content types which the framework accepts for the response. This list is ordered with the most preferable types listed first. The content type only includes the MIME type, not the character set.

For included resources this method will returned an enumeration containing a single entry which is the same string as returned by the ServletResponse.getContentType() without the character set.

Specified by:
getResponseContentTypes in interface SlingHttpServletRequest
Returns:
ordered list of MIME types for the response
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()
Overrides:
getUserPrincipal in class javax.servlet.http.HttpServletRequestWrapper
See Also:
HttpServletRequestWrapper.getUserPrincipal()

isUserInRole

public boolean isUserInRole(String role)
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


Copyright © 2007-2013 The Apache Software Foundation. All Rights Reserved.