RestRequest (Apache Juneau 7.1.1)

java.lang.Object
- javax.servlet.ServletRequestWrapper
- - javax.servlet.http.HttpServletRequestWrapper
  - - org.apache.juneau.rest.RestRequest

All Implemented Interfaces:: javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public final class RestRequest
extends javax.servlet.http.HttpServletRequestWrapper

Represents an HTTP request for a REST resource.

Equivalent to HttpServletRequest except with some additional convenience methods.

For reference, given the URL "http://localhost:9080/contextRoot/servletPath/foo?bar=baz#qux", the following methods return the following values....

Method	Value
`getContextPath()`	`/contextRoot`
`getPathInfo()`	`/foo`
`getPathTranslated()`	`path-to-deployed-war-on-filesystem/foo`
`getQueryString()`	`bar=baz`
`getRequestURI()`	`/contextRoot/servletPath/foo`
`getRequestURL()`	`http://localhost:9080/contextRoot/servletPath/foo`
`getServletPath()`	`/servletPath`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RestRequest`	`attr(String name, Object value)` Shorthand method for calling `ServletRequestWrapper.setAttribute(String, Object)` fluently.
`Object`	`getAttribute(String name, Object def)` Same as `ServletRequestWrapper.getAttribute(String)` but returns a default value if not found.
`BeanSession`	`getBeanSession()` Returns the `BeanSession` associated with this request.
`RequestBody`	`getBody()` Request body.
`String`	`getCharacterEncoding()` Returns the charset specified on the `Content-Type` header, or "UTF-8" if not specified.
`ReaderResource`	`getClasspathReaderResource(String name)` Same as `getClasspathReaderResource(String, boolean)` with `resolveVars == false`
`ReaderResource`	`getClasspathReaderResource(String name, boolean resolveVars)` Same as `getClasspathReaderResource(String, boolean, MediaType)` except uses the resource mime-type map constructed using `RestContextBuilder.mimeTypes(String...)` to determine the media type.
`ReaderResource`	`getClasspathReaderResource(String name, boolean resolveVars, MediaType mediaType)` Returns an instance of a `ReaderResource` that represents the contents of a resource text file from the classpath.
`Config`	`getConfig()` Config file associated with the resource.
`List<MediaType>`	`getConsumes()` Returns the media types that are valid for `Content-Type` headers on the request.
`int`	`getContentLength()`
`RestContext`	`getContext()` Returns the resource context handling the request.
`String`	`getContextPath()`
`String`	`getDescription()` Returns a string of the form "HTTP method-name full-url"
`RequestFormData`	`getFormData()` Form-data.
`String`	`getFormData(String name)` Shortcut for calling `getFormData().getString(name)`.
`String`	`getHeader(String name)`
`RequestHeaders`	`getHeaders()` Request headers.
`Enumeration<String>`	`getHeaders(String name)`
`HttpMethod`	`getHttpMethod()` Returns the HTTP 1.1 method name of the request as an enum.
`RestInfoProvider`	`getInfoProvider()` Resource information provider.
`javax.servlet.ServletInputStream`	`getInputStream()` Returns the HTTP body content as an `InputStream`.
`Method`	`getJavaMethod()` Returns the java method handling the request.
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`RestLogger`	`getLogger()` Logger.
`String`	`getMessage(String key, Object... args)` Shortcut method for calling `MessageBundle.getString(Locale, String, Object...)` based on the request locale.
`MessageBundle`	`getMessageBundle()` Returns the resource bundle for the request locale.
`String`	`getMethod()` Returns the method of this request.
`String`	`getMethodDescription()` Returns the localized method description.
`String`	`getMethodSummary()` Returns the localized method summary.
`ParserGroup`	`getParsers()` Returns the parsers associated with this request.
`String`	`getPath(String name)` Shortcut for calling `getPathMatch().get(name)`.
`RequestPathMatch`	`getPathMatch()` Request path match.
`List<MediaType>`	`getProduces()` Returns the media types that are valid for `Accept` headers on the request.
`RequestProperties`	`getProperties()` Retrieve the properties active for this request.
`RequestQuery`	`getQuery()` Query parameters.
`String`	`getQuery(String name)` Shortcut for calling `getQuery().getString(name)`.
`BufferedReader`	`getReader()` Returns the HTTP body content as a `Reader`.
`String`	`getResourceDescription()` Returns the localized resource description.
`String`	`getResourceTitle()` Returns the localized resource title.
`SerializerGroup`	`getSerializers()` Returns the serializers associated with this request.
`String`	`getServletPath()`
`String`	`getSiteName()` Returns the localized site name.
`Swagger`	`getSwagger()` Returns the localized swagger associated with the resource.
`URI`	`getUri(boolean includeQuery, Map<String,?> addQueryParams)` Returns the URI for this request.
`UriContext`	`getUriContext()` Returns the URI context of the request.
`UriResolver`	`getUriResolver()` Shortcut for calling `getUriResolver()` using `UriResolution.ROOT_RELATIVE` and `UriRelativity.RESOURCE`
`UriResolver`	`getUriResolver(UriResolution resolution, UriRelativity relativity)` Returns a URI resolver that can be used to convert URIs to absolute or root-relative form.
`VarResolverSession`	`getVarResolverSession()` Request-level variable resolver session.
`Map<String,Widget>`	`getWidgets()` Returns the widgets used for resolving "$W{...}" string variables.
`boolean`	`isPlainText()` Returns true if `&plainText=true` was specified as a URL parameter.
`RestRequest`	`prop(String name, Object value)` Shortcut for calling `getProperties().append(name, value);` fluently.
`void`	`setCharacterEncoding(String charset)` Sets the charset to expect on the request body.
`String`	`toString()`

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper
authenticate, changeSessionId, getAuthType, getCookies, getDateHeader, getHeaderNames, getIntHeader, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, login, logout, upgrade

Methods inherited from class javax.servlet.ServletRequestWrapper
getAsyncContext, getAttribute, getAttributeNames, getContentLengthLong, getContentType, getDispatcherType, getLocalAddr, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setRequest, startAsync, startAsync

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.servlet.ServletRequest
getAsyncContext, getAttribute, getAttributeNames, getContentLengthLong, getContentType, getDispatcherType, getLocalAddr, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, startAsync, startAsync

- Method Detail
  - getDescription
```
public String getDescription()
```
    Returns a string of the form "HTTP method-name full-url"
    
    Returns:
    
    A description string of the request.
  - getAttribute
```
public Object getAttribute(String name,
                           Object def)
```
    Same as ServletRequestWrapper.getAttribute(String) but returns a default value if not found.
    
    Parameters:
    
    name - The request attribute name.
    
    def - The default value if the attribute doesn't exist.
    
    Returns:
    
    The request attribute value.
  - attr
```
public RestRequest attr(String name,
                        Object value)
```
    Shorthand method for calling ServletRequestWrapper.setAttribute(String, Object) fluently.
    
    Parameters:
    
    name - The request attribute name.
    
    value - The request attribute value.
    
    Returns:
    
    This object (for method chaining).
  - getProperties
```
public RequestProperties getProperties()
```
    Retrieve the properties active for this request.
    This contains all resource and method level properties from the following:
    The returned object is modifiable and allows you to override session-level properties before they get passed to the serializers.
    However, properties are open-ended, and can be used for any purpose.
    Example:
    
    @RestMethod( properties={ @Property(name=SERIALIZER_sortMaps, value="false") } ) public Map doGet(RestRequest req, @Query("sortMaps") Boolean sortMaps) { // Override value if specified through query parameter. if (sortMaps != null) req.getProperties().put(SERIALIZER_sortMaps, sortMaps); return getMyMap(); }
    
    See Also:
    - prop(String, Object)
    - Overview > juneau-rest-server > Properties
    Returns:
    
    The properties active for this request.
  - prop
```
public RestRequest prop(String name,
                        Object value)
```
    Shortcut for calling getProperties().append(name, value); fluently.
    
    Parameters:
    
    name - The property name.
    
    value - The property value.
    
    Returns:
    
    This object (for method chaining).
  - getHeaders
```
public RequestHeaders getHeaders()
```
    Request headers.
    Returns a RequestHeaders object that encapsulates access to HTTP headers on the request.
    Example:
    
    @RestMethod(...) public Object myMethod(RestRequest req) { // Get access to headers. RequestHeaders h = req.getHeaders(); // Add a default value. h.addDefault("ETag", DEFAULT_UUID); // Get a header value as a POJO. UUID etag = h.get("ETag", UUID.class); // Get a standard header. CacheControl = h.getCacheControl(); }
    
    Notes:
    - This object is modifiable.
    - Values are converted from strings using the registered part-parser on the resource class.
    - The RequestHeaders object can also be passed as a parameter on the method.
    - The @Header annotation can be used to access individual header values.
    See Also:
    - Overview > juneau-rest-server > RequestHeaders
    Returns:
    
    The headers on this request.
    Never null.
  - getHeader
```
public String getHeader(String name)
```
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getHeader in class javax.servlet.http.HttpServletRequestWrapper
  - getHeaders
```
public Enumeration<String> getHeaders(String name)
```
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getHeaders in class javax.servlet.http.HttpServletRequestWrapper
  - getProduces
```
public List<MediaType> getProduces()
```
    Returns the media types that are valid for Accept headers on the request.
    
    Returns:
    
    The set of media types registered in the serializer group of this request.
  - getConsumes
```
public List<MediaType> getConsumes()
```
    Returns the media types that are valid for Content-Type headers on the request.
    
    Returns:
    
    The set of media types registered in the parser group of this request.
  - setCharacterEncoding
```
public void setCharacterEncoding(String charset)
```
    Sets the charset to expect on the request body.
    
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
    
    Overrides:
    
    setCharacterEncoding in class javax.servlet.ServletRequestWrapper
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Returns the charset specified on the Content-Type header, or "UTF-8" if not specified.
    
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getCharacterEncoding in class javax.servlet.ServletRequestWrapper
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getLocale in class javax.servlet.ServletRequestWrapper
  - getLocales
```
public Enumeration<Locale> getLocales()
```
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getLocales in class javax.servlet.ServletRequestWrapper
  - getQuery
```
public RequestQuery getQuery()
```
    Query parameters.
    Returns a RequestQuery object that encapsulates access to URL GET parameters.
    Similar to ServletRequestWrapper.getParameterMap() but only looks for query parameters in the URL and not form posts.
    Example:
    
    @RestMethod(...) public void doGet(RestRequest req) { // Get access to query parameters on the URL. RequestQuery q = req.getQuery(); // Get query parameters converted to various types. int p1 = q.get("p1", 0, int.class); String p2 = q.get("p2", String.class); UUID p3 = q.get("p3", UUID.class); }
    
    Notes:
    - This object is modifiable.
    - This method can be used to retrieve query parameters without triggering the underlying servlet API to load and parse the request body.
    - Values are converted from strings using the registered part-parser on the resource class.
    - The RequestQuery object can also be passed as a parameter on the method.
    - The @Query annotation can be used to access individual query parameter values.
    See Also:
    - Overview > juneau-rest-server > RequestQuery
    Returns:
    
    The query parameters as a modifiable map.
    Never null.
  - getQuery
```
public String getQuery(String name)
```
    Shortcut for calling getQuery().getString(name).
    
    Parameters:
    
    name - The query parameter name.
    
    Returns:
    
    The query parameter value, or null if not found.
  - getFormData
```
public RequestFormData getFormData()
```
    Form-data.
    Returns a RequestFormData object that encapsulates access to form post parameters.
    Similar to ServletRequestWrapper.getParameterMap(), but only looks for form data in the HTTP body.
    Example:
    
    @RestMethod(...) public void doPost(RestRequest req) { // Get access to parsed form data parameters. RequestFormData fd = req.getFormData(); // Get form data parameters converted to various types. int p1 = fd.get("p1", 0, int.class); String p2 = fd.get("p2", String.class); UUID p3 = fd.get("p3", UUID.class); }
    
    Notes:
    - This object is modifiable.
    - Values are converted from strings using the registered part-parser on the resource class.
    - The RequestFormData object can also be passed as a parameter on the method.
    - The @FormDAta annotation can be used to access individual form data parameter values.
    See Also:
    - Overview > juneau-rest-server > RequestFormData
    Returns:
    
    The URL-encoded form data from the request.
    Never null.
    
    See Also:
    
    FormData
  - getFormData
```
public String getFormData(String name)
```
    Shortcut for calling getFormData().getString(name).
    
    Parameters:
    
    name - The form data parameter name.
    
    Returns:
    
    The form data parameter value, or null if not found.
  - getPathMatch
```
public RequestPathMatch getPathMatch()
```
    Request path match.
    Returns a RequestPathMatch object that encapsulates access to everything related to the URL path.
    Example:
    
    @RestMethod(..., path="/{foo}/{bar}/{baz}/*") public void doGet(RestRequest req) { // Get access to path data. RequestPathMatch pm = req.getPathMatch(); // Example URL: /123/qux/true/quux int foo = pm.getInt("foo"); // =123 String bar = pm.getString("bar"); // =qux boolean baz = pm.getBoolean("baz"); // =true String remainder = pm.getRemainder(); // =quux }
    
    Notes:
    - This object is modifiable.
    - Values are converted from strings using the registered part-parser on the resource class.
    - The RequestPathMatch object can also be passed as a parameter on the method.
    - The @Path and @PathRemainder annotations can be used to access individual values.
    See Also:
    - Overview > juneau-rest-server > RequestPathMatch
    Returns:
    
    The path data from the URL.
    Never null.
  - getPath
```
public String getPath(String name)
```
    Shortcut for calling getPathMatch().get(name).
    
    Parameters:
    
    name - The path variable name.
    
    Returns:
    
    The path variable value, or null if not found.
  - getBody
```
public RequestBody getBody()
```
    Request body.
    Returns a RequestBody object that encapsulates access to the HTTP request body.
    Example:
    
    @RestMethod(...) public void doPost2(RestRequest req) { // Convert body to a linked list of Person objects. List<Person> l = req.getBody().asType(LinkedList.class, Person.class); .. }
    
    Notes:
    - The RequestBody object can also be passed as a parameter on the method.
    - The @Body annotation can be used to access the body as well.
    See Also:
    - Overview > juneau-rest-server > RequestBody
    Returns:
    
    The body of this HTTP request.
    Never null.
  - getReader
```
public BufferedReader getReader()
                         throws IOException
```
    Returns the HTTP body content as a Reader.
    If allowHeaderParams init parameter is true, then first looks for &body=xxx in the URL query string.
    Automatically handles GZipped input streams.
    
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getReader in class javax.servlet.ServletRequestWrapper
    
    Throws:
    
    IOException
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException
```
    Returns the HTTP body content as an InputStream.
    Automatically handles GZipped input streams.
    
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getInputStream in class javax.servlet.ServletRequestWrapper
    
    Returns:
    
    The negotiated input stream.
    
    Throws:
    
    IOException - If any error occurred while trying to get the input stream or wrap it in the GZIP wrapper.
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getContextPath in class javax.servlet.http.HttpServletRequestWrapper
  - getServletPath
```
public String getServletPath()
```
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getServletPath in class javax.servlet.http.HttpServletRequestWrapper
  - getUriContext
```
public UriContext getUriContext()
```
    Returns the URI context of the request.
    The URI context contains all the information about the URI of the request, such as the servlet URI, context path, etc...
    
    Returns:
    
    The URI context of the request.
  - getUriResolver
```
public UriResolver getUriResolver(UriResolution resolution,
                                  UriRelativity relativity)
```
    Returns a URI resolver that can be used to convert URIs to absolute or root-relative form.
    
    Parameters:
    
    resolution - The URI resolution rule.
    
    relativity - The relative URI relativity rule.
    
    Returns:
    
    The URI resolver for this request.
  - getUriResolver
```
public UriResolver getUriResolver()
```
    Shortcut for calling getUriResolver() using UriResolution.ROOT_RELATIVE and UriRelativity.RESOURCE
    
    Returns:
    
    The URI resolver for this request.
  - getUri
```
public URI getUri(boolean includeQuery,
                  Map<String,?> addQueryParams)
```
    Returns the URI for this request.
    Similar to HttpServletRequestWrapper.getRequestURI() but returns the value as a URI. It also gives you the capability to override the query parameters (e.g. add new query parameters to the existing URI).
    
    Parameters:
    
    includeQuery - If true include the query parameters on the request.
    
    addQueryParams - Augment the request URI with the specified query parameters.
    
    Returns:
    
    A new URI.
  - getInfoProvider
```
public RestInfoProvider getInfoProvider()
```
    Resource information provider.
    Returns a RestInfoProvider object that encapsulates all the textual meta-data on this resource such as descriptions, titles, and Swagger documentation.
    Example:
    
    @RestMethod(...) public void doGet(RestRequest req) { // Get information provider. RestInfoProvider p = req.getInfoProvider(); // Get localized strings. String resourceTitle = p.getTitle(req); String methodDescription = p.getMethodDescription(req.getMethod(), req); Contact contact = p.getContact(req); .. }
    
    Notes:
    - The RestInfoProvider object can also be passed as a parameter on the method.
    See Also:
    Returns:
    
    The info provider on the resource.
    Never null.
  - getSwagger
```
public Swagger getSwagger()
```
    Returns the localized swagger associated with the resource.
    A shortcut for calling getInfoProvider().getSwagger(request);
    Example:
    
    @RestMethod(...) public List<Tag> getSwaggerTags(RestRequest req) { return req.getSwagger().getTags(); }
    
    Notes:
    - The Swagger object can also be passed as a parameter on the method.
    See Also:
    Returns:
    
    The swagger associated with the resource.
    Never null.
  - getSiteName
```
public String getSiteName()
```
    Returns the localized site name.
    The site name is intended to be a title that can be applied to the entire site.
    One possible use is if you want to add the same title to the top of all pages by defining a header on a common parent class like so:
    htmldoc=@HtmlDoc( header={ "<h1>$R{siteName}</h1>", "<h2>$R{resourceTitle}</h2>" } )
    
    Equivalent to calling RestInfoProvider.getSiteName(RestRequest) with this object.
    
    Returns:
    
    The localized site name.
  - getResourceTitle
```
public String getResourceTitle()
```
    Returns the localized resource title.
    Equivalent to calling RestInfoProvider.getTitle(RestRequest) with this object.
    
    Returns:
    
    The localized resource title.
  - getResourceDescription
```
public String getResourceDescription()
```
    Returns the localized resource description.
    Equivalent to calling RestInfoProvider.getDescription(RestRequest) with this object.
    
    Returns:
    
    The localized resource description.
  - getMethodSummary
```
public String getMethodSummary()
```
    Returns the localized method summary.
    Equivalent to calling RestInfoProvider.getMethodSummary(Method, RestRequest) with this object.
    
    Returns:
    
    The localized method description.
  - getMethodDescription
```
public String getMethodDescription()
```
    Returns the localized method description.
    Equivalent to calling RestInfoProvider.getMethodDescription(Method, RestRequest) with this object.
    
    Returns:
    
    The localized method description.
  - getSerializers
```
public SerializerGroup getSerializers()
```
    Returns the serializers associated with this request.
    See Also:
    - Overview > juneau-rest-server > Serializers
    Returns:
    
    The serializers associated with this request.
  - getParsers
```
public ParserGroup getParsers()
```
    Returns the parsers associated with this request.
    See Also:
    - Overview > juneau-rest-server > Parsers
    Returns:
    
    The parsers associated with this request.
  - getMethod
```
public String getMethod()
```
    Returns the method of this request.
    If allowHeaderParams init parameter is true, then first looks for &method=xxx in the URL query string.
    
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getMethod in class javax.servlet.http.HttpServletRequestWrapper
  - getHttpMethod
```
public HttpMethod getHttpMethod()
```
    Returns the HTTP 1.1 method name of the request as an enum.
    Note that non-RFC2616 method names resolve as HttpMethod.OTHER.
    
    Returns:
    
    The HTTP method.
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getContentLength in class javax.servlet.ServletRequestWrapper
  - isPlainText
```
public boolean isPlainText()
```
    Returns true if &plainText=true was specified as a URL parameter.
    This indicates that the Content-Type of the output should always be set to "text/plain" to make it easy to render in a browser.
    This feature is useful for debugging.
    
    Returns:
    
    true if &plainText=true was specified as a URL parameter
  - getMessageBundle
```
public MessageBundle getMessageBundle()
```
    Returns the resource bundle for the request locale.
    Example:
    
    @RestMethod(...) public String sayHello(RestRequest req, @Query("user") String user) { // Get message bundle. MessageBundle mb = req.getMessageBundle(); // Return a localized message. return mb.getString("hello.message", user); }
    
    Notes:
    - The MessageBundle object can also be passed as a parameter on the method.
    See Also:
    Returns:
    
    The resource bundle.
    Never null.
  - getMessage
```
public String getMessage(String key,
                         Object... args)
```
    Shortcut method for calling MessageBundle.getString(Locale, String, Object...) based on the request locale.
    
    Parameters:
    
    key - The message key.
    
    args - Optional MessageFormat-style arguments.
    
    Returns:
    
    The localized message.
  - getContext
```
public RestContext getContext()
```
    Returns the resource context handling the request.
    Can be used to access servlet-init parameters or annotations during requests, such as in calls to RestGuard.guard(RestRequest, RestResponse)..
    
    Returns:
    
    The resource context handling the request.
  - getJavaMethod
```
public Method getJavaMethod()
```
    Returns the java method handling the request.
    Can be used to access the method name or method annotations during requests, such as in calls to RestGuard.guard(RestRequest, RestResponse).
    Notes:
    - This returns null when evaluating servlet-level guards since the method has not been resolved at that point of execution.
    Returns:
    
    The Java method handling the request, or null if the method has not yet been resolved.
  - getBeanSession
```
public BeanSession getBeanSession()
```
    Returns the BeanSession associated with this request.
    
    Returns:
    
    The request bean session.
  - getVarResolverSession
```
public VarResolverSession getVarResolverSession()
```
    Request-level variable resolver session.
    Used to resolve SVL variables in text.
    Example:
    
    @RestMethod(...) public String sayHello(RestRequest req) { // Get var resolver session. VarResolverSession session = getVarResolverSession(); // Use it to construct a customized message from a query parameter. return session.resolve("Hello $RQ{user}!"); }
    
    Notes:
    - The VarResolverSession object can also be passed as a parameter on the method.
    See Also:
    - RestContext.getVarResolver()
    - Overview > juneau-rest-server > SVL Variables
    Returns:
    
    The variable resolver for this request.
  - getClasspathReaderResource
```
public ReaderResource getClasspathReaderResource(String name,
                                                 boolean resolveVars,
                                                 MediaType mediaType)
                                          throws IOException
```
    Returns an instance of a ReaderResource that represents the contents of a resource text file from the classpath.
    
    Example:
    
    // A rest method that (unsafely!) returns the contents of a localized file // from the classpath and resolves any SVL variables embedded in it. @RestMethod(...) public String myMethod(RestRequest req, @Query("file") String file) { return req.getClasspathResourceAsString(file, true); }
    
    See Also:
    Parameters:
    
    name - The name of the resource (i.e. the value normally passed to Class.getResourceAsStream(String).
    
    resolveVars - If true, any SVL variables will be resolved by the variable resolver returned by getVarResolverSession().
    See RestContext.getVarResolver() for the list of supported variables.
    
    mediaType - The value to set as the "Content-Type" header for this object.
    
    Returns:
    
    A new reader resource, or null if resource could not be found.
    
    Throws:
    
    IOException
  - getClasspathReaderResource
```
public ReaderResource getClasspathReaderResource(String name,
                                                 boolean resolveVars)
                                          throws IOException
```
    Same as getClasspathReaderResource(String, boolean, MediaType) except uses the resource mime-type map constructed using RestContextBuilder.mimeTypes(String...) to determine the media type.
    
    Parameters:
    
    name - The name of the resource (i.e. the value normally passed to Class.getResourceAsStream(String).
    
    resolveVars - If true, any SVL variables will be resolved by the variable resolver returned by getVarResolverSession().
    See RestContext.getVarResolver() for the list of supported variables.
    
    Returns:
    
    A new reader resource, or null if resource could not be found.
    
    Throws:
    
    IOException
  - getClasspathReaderResource
```
public ReaderResource getClasspathReaderResource(String name)
                                          throws IOException
```
    Same as getClasspathReaderResource(String, boolean) with resolveVars == false
    
    Parameters:
    
    name - The name of the resource (i.e. the value normally passed to Class.getResourceAsStream(String).
    
    Returns:
    
    A new reader resource, or null if resource could not be found.
    
    Throws:
    
    IOException
  - getConfig
```
public Config getConfig()
```
    Config file associated with the resource.
    Returns a config file with session-level variable resolution. The config file is identified via one of the following:
    - RestResource.config()
    - RestContextBuilder.config(Config)
    Example:
    
    @RestMethod(...) public void doGet(RestRequest req) { // Get config file. Config cf = req.getConfig(); // Get simple values from config file. int timeout = cf.getInt("MyResource/timeout", 10000); // Get complex values from config file. MyBean b = cf.getObject("MyResource/myBean", MyBean.class); }
    
    Notes:
    - The Config object can also be passed as a parameter on the method.
    See Also:
    - Overview > juneau-rest-server > Configuration Files
    Returns:
    
    The config file associated with the resource, or null if resource does not have a config file associated with it.
  - getWidgets
```
public Map<String,Widget> getWidgets()
```
    Returns the widgets used for resolving "$W{...}" string variables.
    
    Returns:
    
    The widgets used for resolving "$W{...}" string variables. Never null.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getLogger
```
public RestLogger getLogger()
```
    Logger.
    Shortcut for calling getContext().getLogger().
    Example:
    
    @RestMethod(...) public void doGet(RestRequest req) { req.getLogger().logObjects(FINE, "Request query parameters = {0}", req.getQuery()); }
    
    Notes:
    - The RestLogger object can also be passed as a parameter on the method.
    See Also:
    Returns:
    
    The logger associated with the resource context.
    Never null.

Class RestRequest

See Also:

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Method Summary

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

Methods inherited from class javax.servlet.ServletRequestWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface javax.servlet.ServletRequest

Method Detail

getDescription

getAttribute

attr

getProperties

Example:

See Also:

prop

getHeaders

Example:

Notes:

See Also:

getHeader

getHeaders

getProduces

getConsumes

setCharacterEncoding

getCharacterEncoding

getLocale

getLocales

getQuery

Example:

Notes:

See Also:

getQuery

getFormData

Example:

Notes:

See Also:

getFormData

getPathMatch

Example:

Notes:

See Also:

getPath

getBody

Example:

Notes:

See Also:

getReader

getInputStream

getContextPath

getServletPath

getUriContext

getUriResolver

getUriResolver

getUri

getInfoProvider

Example:

Notes:

See Also:

getSwagger

Example:

Notes:

See Also:

getSiteName

getResourceTitle

getResourceDescription

getMethodSummary

getMethodDescription

getSerializers

See Also:

getParsers

See Also:

getMethod

getHttpMethod

getContentLength

isPlainText

getMessageBundle

Example:

Notes: