Class JavaxToJakartaRequestWrapper
- All Implemented Interfaces:
jakarta.servlet.http.HttpServletRequest
,jakarta.servlet.ServletRequest
,Adaptable
,SlingJakartaHttpServletRequest
SlingHttpServletRequest
to adapt it to the Jakarta Servlet API.- Since:
- 2.9.0
-
Field Summary
Fields inherited from interface jakarta.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription<AdapterType>
AdapterTypeAdapts the adaptable to another type.@Nullable jakarta.servlet.http.Cookie
Returns the named cookie from the HTTP request ornull
if no such cookie exists in the request.@Nullable jakarta.servlet.RequestDispatcher
getRequestDispatcher
(@NotNull String path, RequestDispatcherOptions options) Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given path.@Nullable jakarta.servlet.RequestDispatcher
getRequestDispatcher
(@NotNull Resource resource) Same asSlingJakartaHttpServletRequest.getRequestDispatcher(Resource,RequestDispatcherOptions)
but using empty options.@Nullable jakarta.servlet.RequestDispatcher
getRequestDispatcher
(@NotNull Resource resource, RequestDispatcherOptions options) Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given resource.@Nullable RequestParameter
getRequestParameter
(@NotNull String name) Returns the value of a request parameter as aRequestParameter
, ornull
if the parameter does not exist.@NotNull List<RequestParameter>
Returns the request parameters as instances of theRequestParameter
interface in the order or the request where the query string parameters are first and the POST request parameters are second.@NotNull RequestParameterMap
Returns aMap
of the parameters of this request.@Nullable RequestParameter[]
getRequestParameters
(@NotNull String name) Returns an array ofRequestParameter
objects containing all of the values the given request parameter has, ornull
if the parameter does not exist.@NotNull RequestPathInfo
Returns theRequestPathInfo
pertaining to this request.@NotNull RequestProgressTracker
Returns theRequestProgressTracker
of this request.@NotNull Resource
Returns theResource
object on whose behalf the servlet acts.@Nullable ResourceBundle
getResourceBundle
(String baseName, Locale locale) Returns the resource bundle of the given base name for the given locale.@Nullable ResourceBundle
getResourceBundle
(Locale locale) Returns the resource bundle for the given locale.@NotNull ResourceResolver
Returns theResourceResolver
which resolved theresource
of this request.@Nullable String
Returns the framework preferred content type for the response.@NotNull Enumeration<String>
Gets a list of content types which the framework accepts for the response.static jakarta.servlet.http.HttpServletRequest
toJakartaRequest
(javax.servlet.http.HttpServletRequest request) static jakarta.servlet.ServletRequest
toJakartaRequest
(javax.servlet.ServletRequest request) Create a new wrappertoJakartaRequest
(SlingHttpServletRequest request) Methods inherited from class org.apache.felix.http.jakartawrappers.HttpServletRequestWrapper
authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getTrailerFields, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgrade
Methods inherited from class org.apache.felix.http.jakartawrappers.ServletRequestWrapper
getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, getTranslatedAttributeName, getWrapper, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jakarta.servlet.http.HttpServletRequest
authenticate, changeSessionId, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getTrailerFields, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgrade
Methods inherited from interface jakarta.servlet.ServletRequest
getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setCharacterEncoding, startAsync, startAsync
Methods inherited from interface org.apache.sling.api.SlingJakartaHttpServletRequest
getAuthType, getRemoteUser, getUserPrincipal
-
Constructor Details
-
JavaxToJakartaRequestWrapper
-
-
Method Details
-
toJakartaRequest
public static jakarta.servlet.ServletRequest toJakartaRequest(javax.servlet.ServletRequest request) Create a new wrapper- Parameters:
request
- The request object- Returns:
- The wrapped request object
-
toJakartaRequest
public static jakarta.servlet.http.HttpServletRequest toJakartaRequest(javax.servlet.http.HttpServletRequest request) -
toJakartaRequest
-
getCookie
Description copied from interface:SlingJakartaHttpServletRequest
Returns the named cookie from the HTTP request ornull
if no such cookie exists in the request.- Specified by:
getCookie
in interfaceSlingJakartaHttpServletRequest
- Parameters:
name
- The name of the cookie to return.- Returns:
- The named cookie or
null
if no such cookie exists.
-
getRequestDispatcher
@Nullable public @Nullable jakarta.servlet.RequestDispatcher getRequestDispatcher(@NotNull @NotNull String path, RequestDispatcherOptions options) Description copied from interface:SlingJakartaHttpServletRequest
Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given path. ARequestDispatcher
object can be used to include the resource in a response.Returns
null
if aRequestDispatcher
cannot be returned for any reason.- Specified by:
getRequestDispatcher
in interfaceSlingJakartaHttpServletRequest
- Parameters:
path
- aString
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 theresource
ornull
if an error occurs preparing the dispatcher.
-
getRequestDispatcher
@Nullable public @Nullable jakarta.servlet.RequestDispatcher getRequestDispatcher(@NotNull @NotNull Resource resource, RequestDispatcherOptions options) Description copied from interface:SlingJakartaHttpServletRequest
Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given resource. ARequestDispatcher
object can be used to include the resource in a response.Returns
null
if aRequestDispatcher
cannot be returned for any reason.- Specified by:
getRequestDispatcher
in interfaceSlingJakartaHttpServletRequest
- Parameters:
resource
- TheResource
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 theresource
ornull
if an error occurs preparing the dispatcher.
-
getRequestDispatcher
@Nullable public @Nullable jakarta.servlet.RequestDispatcher getRequestDispatcher(@NotNull @NotNull Resource resource) Description copied from interface:SlingJakartaHttpServletRequest
Same asSlingJakartaHttpServletRequest.getRequestDispatcher(Resource,RequestDispatcherOptions)
but using empty options.- Specified by:
getRequestDispatcher
in interfaceSlingJakartaHttpServletRequest
- Parameters:
resource
- TheResource
instance whose response content may be included by the returned dispatcher.- Returns:
- a
RequestDispatcher
object that acts as a wrapper for theresource
ornull
if an error occurs preparing the dispatcher.
-
getRequestParameter
Description copied from interface:SlingJakartaHttpServletRequest
Returns the value of a request parameter as aRequestParameter
, ornull
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
SlingJakartaHttpServletRequest.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 interfaceSlingJakartaHttpServletRequest
- Parameters:
name
- aString
specifying the name of the parameter- Returns:
- a
RequestParameter
representing the single value of the parameter - See Also:
-
getRequestParameterList
Description copied from interface:SlingJakartaHttpServletRequest
Returns the request parameters as instances of theRequestParameter
interface in the order or the request where the query string parameters are first and the POST request parameters are second.- Specified by:
getRequestParameterList
in interfaceSlingJakartaHttpServletRequest
- Returns:
- The list of
RequestParameter
in request declaration order.
-
getRequestParameterMap
Description copied from interface:SlingJakartaHttpServletRequest
Returns aMap
of the parameters of this request.The values in the returned
Map
are from typeRequestParameter
array (RequestParameter[]
).If no parameters exist this method returns an empty
Map
.- Specified by:
getRequestParameterMap
in interfaceSlingJakartaHttpServletRequest
- Returns:
- an immutable
Map
containing parameter names as keys and parameter values as map values, or an emptyMap
if no parameters exist. The keys in the parameter map are of type String. The values in the parameter map are of typeRequestParameter
array (RequestParameter[]
).
-
getRequestParameters
Description copied from interface:SlingJakartaHttpServletRequest
Returns an array ofRequestParameter
objects containing all of the values the given request parameter has, ornull
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 interfaceSlingJakartaHttpServletRequest
- Parameters:
name
- aString
containing the name of the parameter the value of which is requested- Returns:
- an array of
RequestParameter
objects containing the parameter values. - See Also:
-
getRequestPathInfo
Description copied from interface:SlingJakartaHttpServletRequest
Returns theRequestPathInfo
pertaining to this request.- Specified by:
getRequestPathInfo
in interfaceSlingJakartaHttpServletRequest
- Returns:
- the request path info.
-
getRequestProgressTracker
Description copied from interface:SlingJakartaHttpServletRequest
Returns theRequestProgressTracker
of this request.- Specified by:
getRequestProgressTracker
in interfaceSlingJakartaHttpServletRequest
- Returns:
- The request progress tracker.
-
getResource
Description copied from interface:SlingJakartaHttpServletRequest
Returns theResource
object on whose behalf the servlet acts.- Specified by:
getResource
in interfaceSlingJakartaHttpServletRequest
- Returns:
- The
Resource
object of this request.
-
getResourceBundle
Description copied from interface:SlingJakartaHttpServletRequest
Returns the resource bundle for the given locale.- Specified by:
getResourceBundle
in interfaceSlingJakartaHttpServletRequest
- Parameters:
locale
- the locale for which to retrieve the resource bundle. If this isnull
, the locale returned byServletRequest.getLocale()
is used to select the resource bundle.- Returns:
- the resource bundle for the given locale
-
getResourceBundle
Description copied from interface:SlingJakartaHttpServletRequest
Returns the resource bundle of the given base name for the given locale.- Specified by:
getResourceBundle
in interfaceSlingJakartaHttpServletRequest
- Parameters:
baseName
- The base name of the resource bundle to returned. If this parameter isnull
, the same resource bundle must be returned as if theSlingJakartaHttpServletRequest.getResourceBundle(Locale)
method is called.locale
- the locale for which to retrieve the resource bundle. If this isnull
, the locale returned byServletRequest.getLocale()
is used to select the resource bundle.- Returns:
- the resource bundle for the given locale
-
getResourceResolver
Description copied from interface:SlingJakartaHttpServletRequest
Returns theResourceResolver
which resolved theresource
of this request.- Specified by:
getResourceResolver
in interfaceSlingJakartaHttpServletRequest
- Returns:
- The resource resolver
-
getResponseContentType
Description copied from interface:SlingJakartaHttpServletRequest
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 interfaceSlingJakartaHttpServletRequest
- Returns:
- preferred MIME type of the response
-
getResponseContentTypes
Description copied from interface:SlingJakartaHttpServletRequest
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 interfaceSlingJakartaHttpServletRequest
- Returns:
- ordered list of MIME types for the response
-
adaptTo
Description copied from interface:Adaptable
Adapts the adaptable to another type.Please note that it is explicitly left as an implementation detail whether each call to this method with the same
type
yields the same object or a new object on each call.Implementations of this method should document their adapted types as well as their behaviour with respect to returning newly created or same instances on each call.
- Specified by:
adaptTo
in interfaceAdaptable
- Type Parameters:
AdapterType
- The generic type to which this object is adapted to- Parameters:
type
- The Class object of the target type, such asjavax.jcr.Node.class
orjava.io.File.class
- Returns:
- The adapter target or
null
if the object cannot adapt to the requested type
-