| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RestRequest (Apache Juneau 8.2.0)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RestRequest (Apache Juneau 8.2.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":42,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":42,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":42,"i69":10,"i70":10,"i71":42,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/juneau/rest/RestParamType.html" title="enum in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/juneau/rest/RestResourceResolver.html" title="interface in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/juneau/rest/RestRequest.html" target="_top">Frames</a></li> |
| <li><a href="RestRequest.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.juneau.rest</div> |
| <h2 title="Class RestRequest" class="title">Class RestRequest</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet">javax.servlet.ServletRequestWrapper</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet.http">javax.servlet.http.HttpServletRequestWrapper</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.juneau.rest.RestRequest</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public final class <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.95">RestRequest</a> |
| extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequestWrapper</a></pre> |
| <div class="block">Represents an HTTP request for a REST resource. |
| |
| <p> |
| Equivalent to <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http"><code>HttpServletRequest</code></a> except with some additional convenience methods. |
| |
| <p> |
| For reference, given the URL <js>"http://localhost:9080/contextRoot/servletPath/foo?bar=baz#qux"</js>, the |
| following methods return the following values.... |
| <table class='styled'> |
| <tr><th>Method</th><th>Value</th></tr> |
| <tr><td><code>getContextPath()</code></td><td><code>/contextRoot</code></td></tr> |
| <tr><td><code>getPathInfo()</code></td><td><code>/foo</code></td></tr> |
| <tr><td><code>getPathTranslated()</code></td><td><code>path-to-deployed-war-on-filesystem/foo</code></td></tr> |
| <tr><td><code>getQueryString()</code></td><td><code>bar=baz</code></td></tr> |
| <tr><td><code>getRequestURI()</code></td><td><code>/contextRoot/servletPath/foo</code></td></tr> |
| <tr><td><code>getRequestURL()</code></td><td><code>http://localhost:9080/contextRoot/servletPath/foo</code></td></tr> |
| <tr><td><code>getServletPath()</code></td><td><code>/servletPath</code></td></tr> |
| </table> |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestMethod.RestmRestRequest'>Overview > juneau-rest-server > @RestMethod > RestRequest</a> |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.javax.servlet.http.HttpServletRequest"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface javax.servlet.http.<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a></h3> |
| <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true#BASIC_AUTH" title="class or interface in javax.servlet.http">BASIC_AUTH</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true#CLIENT_CERT_AUTH" title="class or interface in javax.servlet.http">CLIENT_CERT_AUTH</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true#DIGEST_AUTH" title="class or interface in javax.servlet.http">DIGEST_AUTH</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true#FORM_AUTH" title="class or interface in javax.servlet.http">FORM_AUTH</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#attr-java.lang.String-java.lang.Object-">attr</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Shorthand method for calling <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#setAttribute-java.lang.String-java.lang.Object-" title="class or interface in javax.servlet"><code>ServletRequestWrapper.setAttribute(String, Object)</code></a> fluently.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getAttribute-java.lang.String-java.lang.Object-">getAttribute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> def)</code> |
| <div class="block">Same as <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getAttribute-java.lang.String-" title="class or interface in javax.servlet"><code>ServletRequestWrapper.getAttribute(String)</code></a> but returns a default value if not found.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RequestAttributes.html" title="class in org.apache.juneau.rest">RequestAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getAttributes--">getAttributes</a></span>()</code> |
| <div class="block">Request attributes.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getAuthorityPath--">getAuthorityPath</a></span>()</code> |
| <div class="block">Returns the URI authority portion of the request.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau">BeanSession</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getBeanSession--">getBeanSession</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau"><code>BeanSession</code></a> associated with this request.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RequestBody.html" title="class in org.apache.juneau.rest">RequestBody</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getBody--">getBody</a></span>()</code> |
| <div class="block">Request body.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestCallLoggerConfig.html" title="class in org.apache.juneau.rest">RestCallLoggerConfig</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getCallLoggerConfig--">getCallLoggerConfig</a></span>()</code> |
| <div class="block">Returns the logging configuration defined on the Java method that this request is executing against.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getCharacterEncoding--">getCharacterEncoding</a></span>()</code> |
| <div class="block">Returns the charset specified on the <c>Content-Type</c> header, or <js>"UTF-8"</js> if not specified.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getCharset--">getCharset</a></span>()</code> |
| <div class="block">Wrapper around <a href="../../../../org/apache/juneau/rest/RestRequest.html#getCharacterEncoding--"><code>getCharacterEncoding()</code></a> that converts the value to a <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset"><code>Charset</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/http/BasicHttpResource.html" title="class in org.apache.juneau.http">BasicHttpResource</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getClasspathHttpResource-java.lang.String-">getClasspathHttpResource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Same as <a href="../../../../org/apache/juneau/rest/RestRequest.html#getClasspathHttpResource-java.lang.String-boolean-"><code>getClasspathHttpResource(String, boolean)</code></a> with <code>resolveVars == <jk>false</jk></code></div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/http/BasicHttpResource.html" title="class in org.apache.juneau.http">BasicHttpResource</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getClasspathHttpResource-java.lang.String-boolean-">getClasspathHttpResource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| boolean resolveVars)</code> |
| <div class="block">Same as <a href="../../../../org/apache/juneau/rest/RestRequest.html#getClasspathHttpResource-java.lang.String-boolean-org.apache.juneau.http.MediaType-boolean-"><code>getClasspathHttpResource(String, boolean, MediaType, boolean)</code></a> except uses the resource mime-type map |
| constructed using <a href="../../../../org/apache/juneau/rest/RestContextBuilder.html#mimeTypes-java.lang.String...-"><code>RestContextBuilder.mimeTypes(String...)</code></a> to determine the media type.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/http/BasicHttpResource.html" title="class in org.apache.juneau.http">BasicHttpResource</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getClasspathHttpResource-java.lang.String-boolean-org.apache.juneau.http.MediaType-boolean-">getClasspathHttpResource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| boolean resolveVars, |
| <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType, |
| boolean cached)</code> |
| <div class="block">Returns an instance of a <a href="../../../../org/apache/juneau/http/BasicHttpResource.html" title="class in org.apache.juneau.http"><code>BasicHttpResource</code></a> that represents the contents of a resource text file from the |
| classpath.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getClasspathResourceAsString-java.lang.String-">getClasspathResourceAsString</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Returns a classpath resource as a string,</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getClasspathResourceAsString-java.lang.String-boolean-">getClasspathResourceAsString</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| boolean resolveVars)</code> |
| <div class="block">Returns a classpath resource as a string,</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/config/Config.html" title="class in org.apache.juneau.config">Config</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getConfig--">getConfig</a></span>()</code> |
| <div class="block">Config file associated with the resource.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getConsumes--">getConsumes</a></span>()</code> |
| <div class="block">Returns the media types that are valid for <c>Content-Type</c> headers on the request.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getContentLength--">getContentLength</a></span>()</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest">RestContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getContext--">getContext</a></span>()</code> |
| <div class="block">Returns the resource context handling the request.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getContextPath--">getContextPath</a></span>()</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getDescription--">getDescription</a></span>()</code> |
| <div class="block">Returns a string of the form <js>"HTTP method-name full-url"</js></div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RequestFormData.html" title="class in org.apache.juneau.rest">RequestFormData</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getFormData--">getFormData</a></span>()</code> |
| <div class="block">Form-data.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getFormData-java.lang.String-">getFormData</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Shortcut for calling <c>getFormData().getString(name)</c>.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getHeader-java.lang.String-">getHeader</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RequestHeaders.html" title="class in org.apache.juneau.rest">RequestHeaders</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getHeaders--">getHeaders</a></span>()</code> |
| <div class="block">Request headers.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getHeaders-java.lang.String-">getHeaders</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestInfoProvider.html" title="interface in org.apache.juneau.rest">RestInfoProvider</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getInfoProvider--">getInfoProvider</a></span>()</code> |
| <div class="block">Resource information provider.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getInner--">getInner</a></span>()</code> |
| <div class="block">Returns the wrapped servlet request.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletInputStream.html?is-external=true" title="class or interface in javax.servlet">ServletInputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getInputStream--">getInputStream</a></span>()</code> |
| <div class="block">Returns the HTTP body content as an <a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect">Method</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getJavaMethod--">getJavaMethod</a></span>()</code> |
| <div class="block">Returns the java method handling the request.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/jsonschema/JsonSchemaGenerator.html" title="class in org.apache.juneau.jsonschema">JsonSchemaGenerator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getJsonSchemaGenerator--">getJsonSchemaGenerator</a></span>()</code> |
| <div class="block">Returns the schema generator with settings assigned on this method and class.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getLocale--">getLocale</a></span>()</code> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getLocales--">getLocales</a></span>()</code> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestCallLogger.html" title="interface in org.apache.juneau.rest">RestCallLogger</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getLogger--">getLogger</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getMessage-java.lang.String-java.lang.Object...-">getMessage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args)</code> |
| <div class="block">Shortcut method for calling <a href="../../../../org/apache/juneau/rest/RestRequest.html#getMessages--"><code>getMessages()</code></a> and <a href="../../../../org/apache/juneau/cp/Messages.html#getString-java.lang.String-java.lang.Object...-"><code>Messages.getString(String,Object...)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/cp/Messages.html" title="class in org.apache.juneau.cp">Messages</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getMessages--">getMessages</a></span>()</code> |
| <div class="block">Returns the resource bundle for the request locale.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getMethod--">getMethod</a></span>()</code> |
| <div class="block">Returns the method of this request.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getMethodDescription--">getMethodDescription</a></span>()</code> |
| <div class="block">Returns the localized method description.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getMethodSummary--">getMethodSummary</a></span>()</code> |
| <div class="block">Returns the localized method summary.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/parser/ParserGroup.html" title="class in org.apache.juneau.parser">ParserGroup</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getParsers--">getParsers</a></span>()</code> |
| <div class="block">Returns the parsers associated with this request.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/parser/ParserSessionArgs.html" title="class in org.apache.juneau.parser">ParserSessionArgs</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getParserSessionArgs--">getParserSessionArgs</a></span>()</code> |
| <div class="block">Returns the session arguments to pass to parsers.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/httppart/HttpPartParserSession.html" title="interface in org.apache.juneau.httppart">HttpPartParserSession</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getPartParser--">getPartParser</a></span>()</code> |
| <div class="block">Returns the part serializer associated with this request.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/httppart/HttpPartSerializerSession.html" title="interface in org.apache.juneau.httppart">HttpPartSerializerSession</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getPartSerializer--">getPartSerializer</a></span>()</code> |
| <div class="block">Returns the part serializer associated with this request.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getPath-java.lang.String-">getPath</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Shortcut for calling <c>getPathMatch().get(name)</c>.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RequestPath.html" title="class in org.apache.juneau.rest">RequestPath</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getPathMatch--">getPathMatch</a></span>()</code> |
| <div class="block">Request path match.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getPathRemainder--">getPathRemainder</a></span>()</code> |
| <div class="block">Shortcut for calling <c>getPathMatch().getRemainder()</c>.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getProduces--">getProduces</a></span>()</code> |
| <div class="block">Returns the media types that are valid for <c>Accept</c> headers on the request.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RequestProperties.html" title="class in org.apache.juneau.rest">RequestProperties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getProperties--">getProperties</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getPropertyStore--">getPropertyStore</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau"><code>PropertyStore</code></a> for this request.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RequestQuery.html" title="class in org.apache.juneau.rest">RequestQuery</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getQuery--">getQuery</a></span>()</code> |
| <div class="block">Query parameters.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getQuery-java.lang.String-">getQuery</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Shortcut for calling <c>getQuery().getString(name)</c>.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html?is-external=true" title="class or interface in java.io">BufferedReader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getReader--">getReader</a></span>()</code> |
| <div class="block">Returns the HTTP body content as a <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getRequest-java.lang.Class-">getRequest</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> c)</code> |
| <div class="block">Creates a proxy interface to retrieve HTTP parts of this request as a proxy bean.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getRequest-org.apache.juneau.httppart.bean.RequestBeanMeta-">getRequest</a></span>(<a href="../../../../org/apache/juneau/httppart/bean/RequestBeanMeta.html" title="class in org.apache.juneau.httppart.bean">RequestBeanMeta</a> rbm)</code> |
| <div class="block">Same as <a href="../../../../org/apache/juneau/rest/RestRequest.html#getRequest-java.lang.Class-"><code>getRequest(Class)</code></a> but used on pre-instantiated <a href="../../../../org/apache/juneau/httppart/bean/RequestBeanMeta.html" title="class in org.apache.juneau.httppart.bean"><code>RequestBeanMeta</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getResourceDescription--">getResourceDescription</a></span>()</code> |
| <div class="block">Returns the localized resource description.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getResourceTitle--">getResourceTitle</a></span>()</code> |
| <div class="block">Returns the localized resource title.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/httppart/bean/ResponseBeanMeta.html" title="class in org.apache.juneau.httppart.bean">ResponseBeanMeta</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getResponseBeanMeta-java.lang.Object-">getResponseBeanMeta</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> |
| <div class="block">Returns metadata about the specified response object if it's annotated with <a href="../../../../org/apache/juneau/http/annotation/Response.html" title="annotation in org.apache.juneau.http.annotation"><code>@Response</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/ResponsePartMeta.html" title="class in org.apache.juneau.rest">ResponsePartMeta</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getResponseBodyMeta-java.lang.Object-">getResponseBodyMeta</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> |
| <div class="block">Returns metadata about the specified response object if it's annotated with <a href="../../../../org/apache/juneau/http/annotation/ResponseBody.html" title="annotation in org.apache.juneau.http.annotation"><code>@ResponseBody</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/ResponsePartMeta.html" title="class in org.apache.juneau.rest">ResponsePartMeta</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getResponseHeaderMeta-java.lang.Object-">getResponseHeaderMeta</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> |
| <div class="block">Returns metadata about the specified response object if it's annotated with <a href="../../../../org/apache/juneau/http/annotation/ResponseHeader.html" title="annotation in org.apache.juneau.http.annotation"><code>@ResponseHeader</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/serializer/SerializerGroup.html" title="class in org.apache.juneau.serializer">SerializerGroup</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getSerializers--">getSerializers</a></span>()</code> |
| <div class="block">Returns the serializers associated with this request.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/serializer/SerializerSessionArgs.html" title="class in org.apache.juneau.serializer">SerializerSessionArgs</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getSerializerSessionArgs--">getSerializerSessionArgs</a></span>()</code> |
| <div class="block">Returns the session arguments to pass to serializers.</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getServletPath--">getServletPath</a></span>()</code> </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getSiteName--">getSiteName</a></span>()</code> |
| <div class="block">Returns the localized site name.</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getSwagger--">getSwagger</a></span>()</code> |
| <div class="block">Returns the localized swagger associated with the resource.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getUri-boolean-java.util.Map-">getUri</a></span>(boolean includeQuery, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> addQueryParams)</code> |
| <div class="block">Returns the URI for this request.</div> |
| </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau">UriContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getUriContext--">getUriContext</a></span>()</code> |
| <div class="block">Returns the URI context of the request.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau">UriResolver</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getUriResolver--">getUriResolver</a></span>()</code> |
| <div class="block">Shortcut for calling <a href="../../../../org/apache/juneau/rest/RestRequest.html#getUriResolver--"><code>getUriResolver()</code></a> using <a href="../../../../org/apache/juneau/UriResolution.html#ROOT_RELATIVE"><code>UriResolution.ROOT_RELATIVE</code></a> and |
| <a href="../../../../org/apache/juneau/UriRelativity.html#RESOURCE"><code>UriRelativity.RESOURCE</code></a></div> |
| </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau">UriResolver</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getUriResolver-org.apache.juneau.UriResolution-org.apache.juneau.UriRelativity-">getUriResolver</a></span>(<a href="../../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau">UriResolution</a> resolution, |
| <a href="../../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau">UriRelativity</a> relativity)</code> |
| <div class="block">Returns a URI resolver that can be used to convert URIs to absolute or root-relative form.</div> |
| </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getVarResolverSession--">getVarResolverSession</a></span>()</code> |
| <div class="block">Request-level variable resolver session.</div> |
| </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getWidgets--">getWidgets</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#isDebug--">isDebug</a></span>()</code> |
| <div class="block">Returns <jk>true</jk> if debug mode is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#isPlainText--">isPlainText</a></span>()</code> |
| <div class="block">Returns <jk>true</jk> if <c>&plainText=true</c> was specified as a URL parameter.</div> |
| </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#prop-java.lang.String-java.lang.Object-">prop</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#setCharacterEncoding-java.lang.String-">setCharacterEncoding</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> charset)</code> |
| <div class="block">Sets the charset to expect on the request body.</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#setDebug--">setDebug</a></span>()</code> |
| <div class="block">Shortcut for calling <c>setDebug(<jk>true</jk>)</c>.</div> |
| </td> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#setDebug-java.lang.Boolean-">setDebug</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> b)</code> |
| <div class="block">Sets the <js>"Debug"</js> attribute to the specified boolean.</div> |
| </td> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#setException-java.lang.Throwable-">setException</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> t)</code> |
| <div class="block">Sets the <js>"Exception"</js> attribute to the specified throwable.</div> |
| </td> |
| </tr> |
| <tr id="i76" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#setNoTrace--">setNoTrace</a></span>()</code> |
| <div class="block">Shortcut for calling <c>setNoTrace(<jk>true</jk>)</c>.</div> |
| </td> |
| </tr> |
| <tr id="i77" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#setNoTrace-java.lang.Boolean-">setNoTrace</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> b)</code> |
| <div class="block">Sets the <js>"NoTrace"</js> attribute to the specified boolean.</div> |
| </td> |
| </tr> |
| <tr id="i78" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.servlet.http.HttpServletRequestWrapper"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class javax.servlet.http.<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequestWrapper</a></h3> |
| <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#authenticate-javax.servlet.http.HttpServletResponse-" title="class or interface in javax.servlet.http">authenticate</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#changeSessionId--" title="class or interface in javax.servlet.http">changeSessionId</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getAuthType--" title="class or interface in javax.servlet.http">getAuthType</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getCookies--" title="class or interface in javax.servlet.http">getCookies</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getDateHeader-java.lang.String-" title="class or interface in javax.servlet.http">getDateHeader</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getHeaderNames--" title="class or interface in javax.servlet.http">getHeaderNames</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getIntHeader-java.lang.String-" title="class or interface in javax.servlet.http">getIntHeader</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getPart-java.lang.String-" title="class or interface in javax.servlet.http">getPart</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getParts--" title="class or interface in javax.servlet.http">getParts</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getPathInfo--" title="class or interface in javax.servlet.http">getPathInfo</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getPathTranslated--" title="class or interface in javax.servlet.http">getPathTranslated</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getQueryString--" title="class or interface in javax.servlet.http">getQueryString</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getRemoteUser--" title="class or interface in javax.servlet.http">getRemoteUser</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getRequestedSessionId--" title="class or interface in javax.servlet.http">getRequestedSessionId</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getRequestURI--" title="class or interface in javax.servlet.http">getRequestURI</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getRequestURL--" title="class or interface in javax.servlet.http">getRequestURL</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getSession--" title="class or interface in javax.servlet.http">getSession</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getSession-boolean-" title="class or interface in javax.servlet.http">getSession</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getUserPrincipal--" title="class or interface in javax.servlet.http">getUserPrincipal</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#isRequestedSessionIdFromCookie--" title="class or interface in javax.servlet.http">isRequestedSessionIdFromCookie</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#isRequestedSessionIdFromUrl--" title="class or interface in javax.servlet.http">isRequestedSessionIdFromUrl</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#isRequestedSessionIdFromURL--" title="class or interface in javax.servlet.http">isRequestedSessionIdFromURL</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#isRequestedSessionIdValid--" title="class or interface in javax.servlet.http">isRequestedSessionIdValid</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#isUserInRole-java.lang.String-" title="class or interface in javax.servlet.http">isUserInRole</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#login-java.lang.String-java.lang.String-" title="class or interface in javax.servlet.http">login</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#logout--" title="class or interface in javax.servlet.http">logout</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#upgrade-java.lang.Class-" title="class or interface in javax.servlet.http">upgrade</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.servlet.ServletRequestWrapper"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class javax.servlet.<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet">ServletRequestWrapper</a></h3> |
| <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getAsyncContext--" title="class or interface in javax.servlet">getAsyncContext</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getAttribute-java.lang.String-" title="class or interface in javax.servlet">getAttribute</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getAttributeNames--" title="class or interface in javax.servlet">getAttributeNames</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getContentLengthLong--" title="class or interface in javax.servlet">getContentLengthLong</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getContentType--" title="class or interface in javax.servlet">getContentType</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getDispatcherType--" title="class or interface in javax.servlet">getDispatcherType</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getLocalAddr--" title="class or interface in javax.servlet">getLocalAddr</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getLocalName--" title="class or interface in javax.servlet">getLocalName</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getLocalPort--" title="class or interface in javax.servlet">getLocalPort</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getParameter-java.lang.String-" title="class or interface in javax.servlet">getParameter</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getParameterMap--" title="class or interface in javax.servlet">getParameterMap</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getParameterNames--" title="class or interface in javax.servlet">getParameterNames</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getParameterValues-java.lang.String-" title="class or interface in javax.servlet">getParameterValues</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getProtocol--" title="class or interface in javax.servlet">getProtocol</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getRealPath-java.lang.String-" title="class or interface in javax.servlet">getRealPath</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getRemoteAddr--" title="class or interface in javax.servlet">getRemoteAddr</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getRemoteHost--" title="class or interface in javax.servlet">getRemoteHost</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getRemotePort--" title="class or interface in javax.servlet">getRemotePort</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getRequest--" title="class or interface in javax.servlet">getRequest</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getRequestDispatcher-java.lang.String-" title="class or interface in javax.servlet">getRequestDispatcher</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getScheme--" title="class or interface in javax.servlet">getScheme</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getServerName--" title="class or interface in javax.servlet">getServerName</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getServerPort--" title="class or interface in javax.servlet">getServerPort</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getServletContext--" title="class or interface in javax.servlet">getServletContext</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#isAsyncStarted--" title="class or interface in javax.servlet">isAsyncStarted</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#isAsyncSupported--" title="class or interface in javax.servlet">isAsyncSupported</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#isSecure--" title="class or interface in javax.servlet">isSecure</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#isWrapperFor-java.lang.Class-" title="class or interface in javax.servlet">isWrapperFor</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#isWrapperFor-javax.servlet.ServletRequest-" title="class or interface in javax.servlet">isWrapperFor</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#removeAttribute-java.lang.String-" title="class or interface in javax.servlet">removeAttribute</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#setAttribute-java.lang.String-java.lang.Object-" title="class or interface in javax.servlet">setAttribute</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#setRequest-javax.servlet.ServletRequest-" title="class or interface in javax.servlet">setRequest</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#startAsync--" title="class or interface in javax.servlet">startAsync</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#startAsync-javax.servlet.ServletRequest-javax.servlet.ServletResponse-" title="class or interface in javax.servlet">startAsync</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.servlet.ServletRequest"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface javax.servlet.<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a></h3> |
| <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getAsyncContext--" title="class or interface in javax.servlet">getAsyncContext</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getAttribute-java.lang.String-" title="class or interface in javax.servlet">getAttribute</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getAttributeNames--" title="class or interface in javax.servlet">getAttributeNames</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getContentLengthLong--" title="class or interface in javax.servlet">getContentLengthLong</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getContentType--" title="class or interface in javax.servlet">getContentType</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getDispatcherType--" title="class or interface in javax.servlet">getDispatcherType</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getLocalAddr--" title="class or interface in javax.servlet">getLocalAddr</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getLocalName--" title="class or interface in javax.servlet">getLocalName</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getLocalPort--" title="class or interface in javax.servlet">getLocalPort</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getParameter-java.lang.String-" title="class or interface in javax.servlet">getParameter</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getParameterMap--" title="class or interface in javax.servlet">getParameterMap</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getParameterNames--" title="class or interface in javax.servlet">getParameterNames</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getParameterValues-java.lang.String-" title="class or interface in javax.servlet">getParameterValues</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getProtocol--" title="class or interface in javax.servlet">getProtocol</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getRealPath-java.lang.String-" title="class or interface in javax.servlet">getRealPath</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getRemoteAddr--" title="class or interface in javax.servlet">getRemoteAddr</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getRemoteHost--" title="class or interface in javax.servlet">getRemoteHost</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getRemotePort--" title="class or interface in javax.servlet">getRemotePort</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getRequestDispatcher-java.lang.String-" title="class or interface in javax.servlet">getRequestDispatcher</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getScheme--" title="class or interface in javax.servlet">getScheme</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getServerName--" title="class or interface in javax.servlet">getServerName</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getServerPort--" title="class or interface in javax.servlet">getServerPort</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getServletContext--" title="class or interface in javax.servlet">getServletContext</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#isAsyncStarted--" title="class or interface in javax.servlet">isAsyncStarted</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#isAsyncSupported--" title="class or interface in javax.servlet">isAsyncSupported</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#isSecure--" title="class or interface in javax.servlet">isSecure</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#removeAttribute-java.lang.String-" title="class or interface in javax.servlet">removeAttribute</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#setAttribute-java.lang.String-java.lang.Object-" title="class or interface in javax.servlet">setAttribute</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#startAsync--" title="class or interface in javax.servlet">startAsync</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#startAsync-javax.servlet.ServletRequest-javax.servlet.ServletResponse-" title="class or interface in javax.servlet">startAsync</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getDescription--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescription</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.243">getDescription</a>()</pre> |
| <div class="block">Returns a string of the form <js>"HTTP method-name full-url"</js></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A description string of the request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../org/apache/juneau/rest/RequestProperties.html" title="class in org.apache.juneau.rest">RequestProperties</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.297">getProperties</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Retrieve the properties active for this request. |
| |
| <div class='warn'> |
| <b>Deprecated</b> - Use <a href="../../../../org/apache/juneau/rest/RestRequest.html#getAttributes--"><code>getAttributes()</code></a> |
| </div> |
| |
| <p> |
| This contains all resource and method level properties from the following: |
| <ul class='javatree'> |
| <li class='ja'><a href="../../../../org/apache/juneau/rest/annotation/Rest.html#properties--"><code>Rest.properties()</code></a> |
| <li class='ja'><a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#properties--"><code>RestMethod.properties()</code></a> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestContextBuilder.html#set-java.lang.String-java.lang.Object-"><code>RestContextBuilder.set(String, Object)</code></a> |
| </ul> |
| |
| <p> |
| The returned object is modifiable and allows you to override session-level properties before |
| they get passed to the serializers. |
| <br>However, properties are open-ended, and can be used for any purpose. |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>( |
| properties={ |
| <ja>@Property</ja>(name=<jsf>SERIALIZER_sortMaps</jsf>, value=<js>"false"</js>) |
| } |
| ) |
| <jk>public</jk> Map doGet(RestRequest req, <ja>@Query</ja>(<js>"sortMaps"</js>) Boolean sortMaps) { |
| |
| <jc>// Override value if specified through query parameter.</jc> |
| <jk>if</jk> (sortMaps != <jk>null</jk>) |
| req.getProperties().put(<jsf>SERIALIZER_sortMaps</jsf>, sortMaps); |
| |
| <jk>return</jk> <jsm>getMyMap</jsm>(); |
| } |
| </p> |
| |
| <ul class='seealso'> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestRequest.html#prop-java.lang.String-java.lang.Object-"><code>prop(String, Object)</code></a> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestConfigurableProperties'>Overview > juneau-rest-server > Configurable Properties</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The properties active for this request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prop-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prop</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.313">prop</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Shortcut for calling <c>getProperties().append(name, value);</c> fluently. |
| |
| <div class='warn'> |
| <b>Deprecated</b> - <a href="../../../../org/apache/juneau/rest/RequestAttributes.html#put-java.lang.String-java.lang.Object-"><code>RequestAttributes.put(String, Object)</code></a> or <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#setAttribute-java.lang.String-java.lang.Object-" title="class or interface in javax.servlet"><code>ServletRequestWrapper.setAttribute(String, Object)</code></a> |
| </div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The property name.</dd> |
| <dd><code>value</code> - The property value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object (for method chaining).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaders</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RequestHeaders.html" title="class in org.apache.juneau.rest">RequestHeaders</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.367">getHeaders</a>()</pre> |
| <div class="block">Request headers. |
| |
| <p> |
| Returns a <a href="../../../../org/apache/juneau/rest/RequestHeaders.html" title="class in org.apache.juneau.rest"><code>RequestHeaders</code></a> object that encapsulates access to HTTP headers on the request. |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>(...) |
| <jk>public</jk> Object myMethod(RestRequest req) { |
| |
| <jc>// Get access to headers.</jc> |
| RequestHeaders h = req.getHeaders(); |
| |
| <jc>// Add a default value.</jc> |
| h.addDefault(<js>"ETag"</js>, <jsf>DEFAULT_UUID</jsf>); |
| |
| <jc>// Get a header value as a POJO.</jc> |
| UUID etag = h.get(<js>"ETag"</js>, UUID.<jk>class</jk>); |
| |
| <jc>// Get a standard header.</jc> |
| CacheControl = h.getCacheControl(); |
| } |
| </p> |
| |
| <ul class='notes'> |
| <li> |
| This object is modifiable. |
| <li> |
| Values are converted from strings using the registered <a href="../../../../org/apache/juneau/rest/RestContext.html#REST_partParser"><code>part-parser</code></a> on the resource class. |
| <li> |
| The <a href="../../../../org/apache/juneau/rest/RequestHeaders.html" title="class in org.apache.juneau.rest"><code>RequestHeaders</code></a> object can also be passed as a parameter on the method. |
| <li> |
| The <a href="../../../../org/apache/juneau/http/annotation/Header.html" title="annotation in org.apache.juneau.http.annotation"><code>@Header</code></a> annotation can be used to access individual header values. |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestMethod.RestmRequestHeaders'>Overview > juneau-rest-server > @RestMethod > RequestHeaders</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The headers on this request. |
| <br>Never <jk>null</jk>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeader</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.372">getHeader</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true#getHeader-java.lang.String-" title="class or interface in javax.servlet.http">getHeader</a></code> in interface <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getHeader-java.lang.String-" title="class or interface in javax.servlet.http">getHeader</a></code> in class <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequestWrapper</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHeaders-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaders</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.377">getHeaders</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true#getHeaders-java.lang.String-" title="class or interface in javax.servlet.http">getHeaders</a></code> in interface <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getHeaders-java.lang.String-" title="class or interface in javax.servlet.http">getHeaders</a></code> in class <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequestWrapper</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProduces--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProduces</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.389">getProduces</a>()</pre> |
| <div class="block">Returns the media types that are valid for <c>Accept</c> headers on the request.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The set of media types registered in the serializer group of this request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConsumes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConsumes</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.398">getConsumes</a>()</pre> |
| <div class="block">Returns the media types that are valid for <c>Content-Type</c> headers on the request.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The set of media types registered in the parser group of this request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPropertyStore--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPropertyStore</h4> |
| <pre>public <a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.412">getPropertyStore</a>()</pre> |
| <div class="block">Returns the <a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau"><code>PropertyStore</code></a> for this request. |
| |
| <p> |
| Consists of a read-only roll-up of all configuration properties defined on this method and class.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The property store for this request. |
| <br>Never <jk>null</jk>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCharacterEncoding-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCharacterEncoding</h4> |
| <pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.420">setCharacterEncoding</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> charset)</pre> |
| <div class="block">Sets the charset to expect on the request body.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#setCharacterEncoding-java.lang.String-" title="class or interface in javax.servlet">setCharacterEncoding</a></code> in interface <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#setCharacterEncoding-java.lang.String-" title="class or interface in javax.servlet">setCharacterEncoding</a></code> in class <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet">ServletRequestWrapper</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCharacterEncoding--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCharacterEncoding</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.428">getCharacterEncoding</a>() |
| throws <a href="../../../../org/apache/juneau/http/exception/UnsupportedMediaType.html" title="class in org.apache.juneau.http.exception">UnsupportedMediaType</a></pre> |
| <div class="block">Returns the charset specified on the <c>Content-Type</c> header, or <js>"UTF-8"</js> if not specified.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getCharacterEncoding--" title="class or interface in javax.servlet">getCharacterEncoding</a></code> in interface <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getCharacterEncoding--" title="class or interface in javax.servlet">getCharacterEncoding</a></code> in class <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet">ServletRequestWrapper</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/juneau/http/exception/UnsupportedMediaType.html" title="class in org.apache.juneau.http.exception">UnsupportedMediaType</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCharset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCharset</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.454">getCharset</a>()</pre> |
| <div class="block">Wrapper around <a href="../../../../org/apache/juneau/rest/RestRequest.html#getCharacterEncoding--"><code>getCharacterEncoding()</code></a> that converts the value to a <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset"><code>Charset</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The request character encoding converted to a <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset"><code>Charset</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocale--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocale</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.460">getLocale</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getLocale--" title="class or interface in javax.servlet">getLocale</a></code> in interface <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getLocale--" title="class or interface in javax.servlet">getLocale</a></code> in class <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet">ServletRequestWrapper</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocales--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocales</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.477">getLocales</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getLocales--" title="class or interface in javax.servlet">getLocales</a></code> in interface <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getLocales--" title="class or interface in javax.servlet">getLocales</a></code> in class <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet">ServletRequestWrapper</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttributes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributes</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RequestAttributes.html" title="class in org.apache.juneau.rest">RequestAttributes</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.534">getAttributes</a>()</pre> |
| <div class="block">Request attributes. |
| |
| <p> |
| Returns a <a href="../../../../org/apache/juneau/rest/RequestAttributes.html" title="class in org.apache.juneau.rest"><code>RequestAttributes</code></a> object that encapsulates access to attributes on the request. |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>(...) |
| <jk>public</jk> Object myMethod(RestRequest req) { |
| |
| <jc>// Get access to attributes.</jc> |
| RequestAttributes a = req.getAttributes(); |
| |
| <jc>// Get a header value as a POJO.</jc> |
| UUID etag = a.get(<js>"ETag"</js>, UUID.<jk>class</jk>); |
| } |
| </p> |
| |
| <ul class='notes'> |
| <li> |
| This object is modifiable. |
| <li> |
| Values are converted from strings using the registered <a href="../../../../org/apache/juneau/rest/RestContext.html#REST_partParser"><code>part-parser</code></a> on the resource class. |
| <li> |
| The <a href="../../../../org/apache/juneau/rest/RequestAttributes.html" title="class in org.apache.juneau.rest"><code>RequestAttributes</code></a> object can also be passed as a parameter on the method. |
| <li> |
| The <a href="../../../../org/apache/juneau/rest/annotation/Attr.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Attr</code></a> annotation can be used to access individual attribute values. |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestMethod.RestmRequestAttributes'>Overview > juneau-rest-server > @RestMethod > RequestAttributes</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The headers on this request. |
| <br>Never <jk>null</jk>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttribute-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttribute</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.545">getAttribute</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> def)</pre> |
| <div class="block">Same as <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getAttribute-java.lang.String-" title="class or interface in javax.servlet"><code>ServletRequestWrapper.getAttribute(String)</code></a> but returns a default value if not found.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The request attribute name.</dd> |
| <dd><code>def</code> - The default value if the attribute doesn't exist.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The request attribute value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="attr-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>attr</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.557">attr</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">Shorthand method for calling <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#setAttribute-java.lang.String-java.lang.Object-" title="class or interface in javax.servlet"><code>ServletRequestWrapper.setAttribute(String, Object)</code></a> fluently.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The request attribute name.</dd> |
| <dd><code>value</code> - The request attribute value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object (for method chaining).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQuery</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RequestQuery.html" title="class in org.apache.juneau.rest">RequestQuery</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.611">getQuery</a>()</pre> |
| <div class="block">Query parameters. |
| |
| <p> |
| Returns a <a href="../../../../org/apache/juneau/rest/RequestQuery.html" title="class in org.apache.juneau.rest"><code>RequestQuery</code></a> object that encapsulates access to URL GET parameters. |
| |
| <p> |
| Similar to <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getParameterMap--" title="class or interface in javax.servlet"><code>ServletRequestWrapper.getParameterMap()</code></a> but only looks for query parameters in the URL and not form posts. |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>(...) |
| <jk>public void</jk> doGet(RestRequest req) { |
| |
| <jc>// Get access to query parameters on the URL.</jc> |
| RequestQuery q = req.getQuery(); |
| |
| <jc>// Get query parameters converted to various types.</jc> |
| <jk>int</jk> p1 = q.get(<js>"p1"</js>, 0, <jk>int</jk>.<jk>class</jk>); |
| String p2 = q.get(<js>"p2"</js>, String.<jk>class</jk>); |
| UUID p3 = q.get(<js>"p3"</js>, UUID.<jk>class</jk>); |
| } |
| </p> |
| |
| <ul class='notes'> |
| <li> |
| This object is modifiable. |
| <li> |
| This method can be used to retrieve query parameters without triggering the underlying servlet API to load and parse the request body. |
| <li> |
| Values are converted from strings using the registered <a href="../../../../org/apache/juneau/rest/RestContext.html#REST_partParser"><code>part-parser</code></a> on the resource class. |
| <li> |
| The <a href="../../../../org/apache/juneau/rest/RequestQuery.html" title="class in org.apache.juneau.rest"><code>RequestQuery</code></a> object can also be passed as a parameter on the method. |
| <li> |
| The <a href="../../../../org/apache/juneau/http/annotation/Query.html" title="annotation in org.apache.juneau.http.annotation"><code>@Query</code></a> annotation can be used to access individual query parameter values. |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestMethod.RestmRequestQuery'>Overview > juneau-rest-server > @RestMethod > RequestQuery</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The query parameters as a modifiable map. |
| <br>Never <jk>null</jk>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQuery-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQuery</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.621">getQuery</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Shortcut for calling <c>getQuery().getString(name)</c>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The query parameter name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The query parameter value, or <jk>null</jk> if not found.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFormData--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFormData</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RequestFormData.html" title="class in org.apache.juneau.rest">RequestFormData</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.675">getFormData</a>() |
| throws <a href="../../../../org/apache/juneau/http/exception/InternalServerError.html" title="class in org.apache.juneau.http.exception">InternalServerError</a></pre> |
| <div class="block">Form-data. |
| |
| <p> |
| Returns a <a href="../../../../org/apache/juneau/rest/RequestFormData.html" title="class in org.apache.juneau.rest"><code>RequestFormData</code></a> object that encapsulates access to form post parameters. |
| |
| <p> |
| Similar to <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getParameterMap--" title="class or interface in javax.servlet"><code>ServletRequestWrapper.getParameterMap()</code></a>, but only looks for form data in the HTTP body. |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>(...) |
| <jk>public void</jk> doPost(RestRequest req) { |
| |
| <jc>// Get access to parsed form data parameters.</jc> |
| RequestFormData fd = req.getFormData(); |
| |
| <jc>// Get form data parameters converted to various types.</jc> |
| <jk>int</jk> p1 = fd.get(<js>"p1"</js>, 0, <jk>int</jk>.<jk>class</jk>); |
| String p2 = fd.get(<js>"p2"</js>, String.<jk>class</jk>); |
| UUID p3 = fd.get(<js>"p3"</js>, UUID.<jk>class</jk>); |
| } |
| </p> |
| |
| <ul class='notes'> |
| <li> |
| This object is modifiable. |
| <li> |
| Values are converted from strings using the registered <a href="../../../../org/apache/juneau/rest/RestContext.html#REST_partParser"><code>part-parser</code></a> on the resource class. |
| <li> |
| The <a href="../../../../org/apache/juneau/rest/RequestFormData.html" title="class in org.apache.juneau.rest"><code>RequestFormData</code></a> object can also be passed as a parameter on the method. |
| <li> |
| The <a href="../../../../org/apache/juneau/http/annotation/FormData.html" title="annotation in org.apache.juneau.http.annotation"><code>@FormDAta</code></a> annotation can be used to access individual form data parameter values. |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestMethod.RestmRequestFormData'>Overview > juneau-rest-server > @RestMethod > RequestFormData</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The URL-encoded form data from the request. |
| <br>Never <jk>null</jk>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/juneau/http/exception/InternalServerError.html" title="class in org.apache.juneau.http.exception">InternalServerError</a></code> - If query parameters could not be parsed.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/juneau/http/annotation/FormData.html" title="annotation in org.apache.juneau.http.annotation"><code>FormData</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFormData-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFormData</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.702">getFormData</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Shortcut for calling <c>getFormData().getString(name)</c>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The form data parameter name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The form data parameter value, or <jk>null</jk> if not found.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPathMatch--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPathMatch</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RequestPath.html" title="class in org.apache.juneau.rest">RequestPath</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.753">getPathMatch</a>()</pre> |
| <div class="block">Request path match. |
| |
| <p> |
| Returns a <a href="../../../../org/apache/juneau/rest/RequestPath.html" title="class in org.apache.juneau.rest"><code>RequestPath</code></a> object that encapsulates access to everything related to the URL path. |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>(..., path=<js>"/{foo}/{bar}/{baz}/*"</js>) |
| <jk>public void</jk> doGet(RestRequest req) { |
| |
| <jc>// Get access to path data.</jc> |
| RequestPathMatch pm = req.getPathMatch(); |
| |
| <jc>// Example URL: /123/qux/true/quux</jc> |
| |
| <jk>int</jk> foo = pm.getInt(<js>"foo"</js>); <jc>// =123</jc> |
| String bar = pm.getString(<js>"bar"</js>); <jc>// =qux</jc> |
| <jk>boolean</jk> baz = pm.getBoolean(<js>"baz"</js>); <jc>// =true</jc> |
| String remainder = pm.getRemainder(); <jc>// =quux</jc> |
| } |
| </p> |
| |
| <ul class='notes'> |
| <li> |
| This object is modifiable. |
| <li> |
| Values are converted from strings using the registered <a href="../../../../org/apache/juneau/rest/RestContext.html#REST_partParser"><code>part-parser</code></a> on the resource class. |
| <li> |
| The <a href="../../../../org/apache/juneau/rest/RequestPath.html" title="class in org.apache.juneau.rest"><code>RequestPath</code></a> object can also be passed as a parameter on the method. |
| <li> |
| The <a href="../../../../org/apache/juneau/http/annotation/Path.html" title="annotation in org.apache.juneau.http.annotation"><code>@Path</code></a> annotation can be used to access individual values. |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestMethod.RestmRequestPathMatch'>Overview > juneau-rest-server > @RestMethod > RequestPathMatch</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The path data from the URL. |
| <br>Never <jk>null</jk>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPath-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPath</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.763">getPath</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Shortcut for calling <c>getPathMatch().get(name)</c>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The path variable name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The path variable value, or <jk>null</jk> if not found.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPathRemainder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPathRemainder</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.772">getPathRemainder</a>()</pre> |
| <div class="block">Shortcut for calling <c>getPathMatch().getRemainder()</c>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The path remainder value, or <jk>null</jk> if not found.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBody--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBody</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RequestBody.html" title="class in org.apache.juneau.rest">RequestBody</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.812">getBody</a>()</pre> |
| <div class="block">Request body. |
| |
| <p> |
| Returns a <a href="../../../../org/apache/juneau/rest/RequestBody.html" title="class in org.apache.juneau.rest"><code>RequestBody</code></a> object that encapsulates access to the HTTP request body. |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>(...) |
| <jk>public void</jk> doPost2(RestRequest req) { |
| |
| <jc>// Convert body to a linked list of Person objects.</jc> |
| List<Person> l = req.getBody().asType(LinkedList.<jk>class</jk>, Person.<jk>class</jk>); |
| .. |
| } |
| </p> |
| |
| <ul class='notes'> |
| <li> |
| The <a href="../../../../org/apache/juneau/rest/RequestBody.html" title="class in org.apache.juneau.rest"><code>RequestBody</code></a> object can also be passed as a parameter on the method. |
| <li> |
| The <a href="../../../../org/apache/juneau/http/annotation/Body.html" title="annotation in org.apache.juneau.http.annotation"><code>@Body</code></a> annotation can be used to access the body as well. |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestMethod.RestmRequestBody'>Overview > juneau-rest-server > @RestMethod > RequestBody</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The body of this HTTP request. |
| <br>Never <jk>null</jk>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReader</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html?is-external=true" title="class or interface in java.io">BufferedReader</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.827">getReader</a>() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Returns the HTTP body content as a <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a>. |
| |
| <p> |
| If <code>allowHeaderParams</code> init parameter is true, then first looks for <code>&body=xxx</code> in the URL query |
| string. |
| |
| <p> |
| Automatically handles GZipped input streams.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getReader--" title="class or interface in javax.servlet">getReader</a></code> in interface <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getReader--" title="class or interface in javax.servlet">getReader</a></code> in class <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet">ServletRequestWrapper</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInputStream--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputStream</h4> |
| <pre>public <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletInputStream.html?is-external=true" title="class or interface in javax.servlet">ServletInputStream</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.841">getInputStream</a>() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Returns the HTTP body content as an <a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>. |
| |
| <p> |
| Automatically handles GZipped input streams.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getInputStream--" title="class or interface in javax.servlet">getInputStream</a></code> in interface <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getInputStream--" title="class or interface in javax.servlet">getInputStream</a></code> in class <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet">ServletRequestWrapper</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The negotiated input stream.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If any error occurred while trying to get the input stream or wrap it in the GZIP wrapper.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContextPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContextPath</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.855">getContextPath</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true#getContextPath--" title="class or interface in javax.servlet.http">getContextPath</a></code> in interface <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getContextPath--" title="class or interface in javax.servlet.http">getContextPath</a></code> in class <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequestWrapper</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAuthorityPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthorityPath</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.865">getAuthorityPath</a>()</pre> |
| <div class="block">Returns the URI authority portion of the request.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The URI authority portion of the request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServletPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServletPath</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.880">getServletPath</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true#getServletPath--" title="class or interface in javax.servlet.http">getServletPath</a></code> in interface <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getServletPath--" title="class or interface in javax.servlet.http">getServletPath</a></code> in class <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequestWrapper</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUriContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUriContext</h4> |
| <pre>public <a href="../../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau">UriContext</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.895">getUriContext</a>()</pre> |
| <div class="block">Returns the URI context of the request. |
| |
| <p> |
| The URI context contains all the information about the URI of the request, such as the servlet URI, context |
| path, etc...</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The URI context of the request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUriResolver-org.apache.juneau.UriResolution-org.apache.juneau.UriRelativity-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUriResolver</h4> |
| <pre>public <a href="../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau">UriResolver</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.908">getUriResolver</a>(<a href="../../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau">UriResolution</a> resolution, |
| <a href="../../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau">UriRelativity</a> relativity)</pre> |
| <div class="block">Returns a URI resolver that can be used to convert URIs to absolute or root-relative form.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resolution</code> - The URI resolution rule.</dd> |
| <dd><code>relativity</code> - The relative URI relativity rule.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The URI resolver for this request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUriResolver--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUriResolver</h4> |
| <pre>public <a href="../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau">UriResolver</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.918">getUriResolver</a>()</pre> |
| <div class="block">Shortcut for calling <a href="../../../../org/apache/juneau/rest/RestRequest.html#getUriResolver--"><code>getUriResolver()</code></a> using <a href="../../../../org/apache/juneau/UriResolution.html#ROOT_RELATIVE"><code>UriResolution.ROOT_RELATIVE</code></a> and |
| <a href="../../../../org/apache/juneau/UriRelativity.html#RESOURCE"><code>UriRelativity.RESOURCE</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The URI resolver for this request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUri-boolean-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUri</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.934">getUri</a>(boolean includeQuery, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> addQueryParams)</pre> |
| <div class="block">Returns the URI for this request. |
| |
| <p> |
| Similar to <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getRequestURI--" title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getRequestURI()</code></a> but returns the value as a <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a>. |
| It also gives you the capability to override the query parameters (e.g. add new query parameters to the existing |
| URI).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>includeQuery</code> - If <jk>true</jk> include the query parameters on the request.</dd> |
| <dd><code>addQueryParams</code> - Augment the request URI with the specified query parameters.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new URI.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInfoProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInfoProvider</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RestInfoProvider.html" title="interface in org.apache.juneau.rest">RestInfoProvider</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1001">getInfoProvider</a>()</pre> |
| <div class="block">Resource information provider. |
| |
| <p> |
| Returns a <a href="../../../../org/apache/juneau/rest/RestInfoProvider.html" title="interface in org.apache.juneau.rest"><code>RestInfoProvider</code></a> object that encapsulates all the textual meta-data on this resource such as |
| descriptions, titles, and Swagger documentation. |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>(...) |
| <jk>public void</jk> doGet(RestRequest req) { |
| |
| <jc>// Get information provider.</jc> |
| RestInfoProvider p = req.getInfoProvider(); |
| |
| <jc>// Get localized strings.</jc> |
| String resourceTitle = p.getTitle(req); |
| String methodDescription = p.getMethodDescription(req.getMethod(), req); |
| Contact contact = p.getContact(req); |
| .. |
| } |
| </p> |
| |
| <ul class='notes'> |
| <li> |
| The <a href="../../../../org/apache/juneau/rest/RestInfoProvider.html" title="interface in org.apache.juneau.rest"><code>RestInfoProvider</code></a> object can also be passed as a parameter on the method. |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='jf'><a href="../../../../org/apache/juneau/rest/RestContext.html#REST_infoProvider"><code>RestContext.REST_infoProvider</code></a> |
| <li class='jic'><a href="../../../../org/apache/juneau/rest/RestInfoProvider.html" title="interface in org.apache.juneau.rest"><code>RestInfoProvider</code></a> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getSiteName--"><code>getSiteName()</code></a> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getResourceTitle--"><code>getResourceTitle()</code></a> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getResourceDescription--"><code>getResourceDescription()</code></a> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getMethodSummary--"><code>getMethodSummary()</code></a> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getMethodDescription--"><code>getMethodDescription()</code></a> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestSwagger'>Overview > juneau-rest-server > Swagger</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The info provider on the resource. |
| <br>Never <jk>null</jk>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSwagger--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSwagger</h4> |
| <pre>public <a href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1035">getSwagger</a>()</pre> |
| <div class="block">Returns the localized swagger associated with the resource. |
| |
| <p> |
| A shortcut for calling <c>getInfoProvider().getSwagger(request);</c> |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>(...) |
| <jk>public</jk> List<Tag> getSwaggerTags(RestRequest req) { |
| <jk>return</jk> req.getSwagger().getTags(); |
| } |
| </p> |
| |
| <ul class='notes'> |
| <li> |
| The <a href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger"><code>Swagger</code></a> object can also be passed as a parameter on the method. |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='jf'><a href="../../../../org/apache/juneau/rest/RestContext.html#REST_infoProvider"><code>RestContext.REST_infoProvider</code></a> |
| <li class='jic'><a href="../../../../org/apache/juneau/rest/RestInfoProvider.html" title="interface in org.apache.juneau.rest"><code>RestInfoProvider</code></a> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getInfoProvider--"><code>getInfoProvider()</code></a> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestSwagger'>Overview > juneau-rest-server > Swagger</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The swagger associated with the resource. |
| <br>Never <jk>null</jk>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSiteName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSiteName</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1068">getSiteName</a>()</pre> |
| <div class="block">Returns the localized site name. |
| |
| <p> |
| The site name is intended to be a title that can be applied to the entire site. |
| |
| <p> |
| 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: |
| <p class='bcode w800'> |
| <ja>@HtmlDocConfig</ja>( |
| header={ |
| <js>"<h1>$R{siteName}</h1>"</js>, |
| <js>"<h2>$R{resourceTitle}</h2>"</js> |
| } |
| ) |
| </p> |
| |
| <p> |
| Equivalent to calling <a href="../../../../org/apache/juneau/rest/RestInfoProvider.html#getSiteName-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getSiteName(RestRequest)</code></a> with this object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The localized site name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResourceTitle--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResourceTitle</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1084">getResourceTitle</a>()</pre> |
| <div class="block">Returns the localized resource title. |
| |
| <p> |
| Equivalent to calling <a href="../../../../org/apache/juneau/rest/RestInfoProvider.html#getTitle-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getTitle(RestRequest)</code></a> with this object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The localized resource title.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResourceDescription--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResourceDescription</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1100">getResourceDescription</a>()</pre> |
| <div class="block">Returns the localized resource description. |
| |
| <p> |
| Equivalent to calling <a href="../../../../org/apache/juneau/rest/RestInfoProvider.html#getDescription-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getDescription(RestRequest)</code></a> with this object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The localized resource description.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMethodSummary--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMethodSummary</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1116">getMethodSummary</a>()</pre> |
| <div class="block">Returns the localized method summary. |
| |
| <p> |
| Equivalent to calling <a href="../../../../org/apache/juneau/rest/RestInfoProvider.html#getMethodSummary-java.lang.reflect.Method-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getMethodSummary(Method, RestRequest)</code></a> with this object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The localized method description.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMethodDescription--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMethodDescription</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1132">getMethodDescription</a>()</pre> |
| <div class="block">Returns the localized method description. |
| |
| <p> |
| Equivalent to calling <a href="../../../../org/apache/juneau/rest/RestInfoProvider.html#getMethodDescription-java.lang.reflect.Method-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getMethodDescription(Method, RestRequest)</code></a> with this object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The localized method description.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSerializers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSerializers</h4> |
| <pre>public <a href="../../../../org/apache/juneau/serializer/SerializerGroup.html" title="class in org.apache.juneau.serializer">SerializerGroup</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1153">getSerializers</a>()</pre> |
| <div class="block">Returns the serializers associated with this request. |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestSerializers'>Overview > juneau-rest-server > Serializers</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The serializers associated with this request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParsers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParsers</h4> |
| <pre>public <a href="../../../../org/apache/juneau/parser/ParserGroup.html" title="class in org.apache.juneau.parser">ParserGroup</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1166">getParsers</a>()</pre> |
| <div class="block">Returns the parsers associated with this request. |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestParsers'>Overview > juneau-rest-server > Parsers</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The parsers associated with this request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPartParser--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartParser</h4> |
| <pre>public <a href="../../../../org/apache/juneau/httppart/HttpPartParserSession.html" title="interface in org.apache.juneau.httppart">HttpPartParserSession</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1175">getPartParser</a>()</pre> |
| <div class="block">Returns the part serializer associated with this request.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The part serializer associated with this request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPartSerializer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartSerializer</h4> |
| <pre>public <a href="../../../../org/apache/juneau/httppart/HttpPartSerializerSession.html" title="interface in org.apache.juneau.httppart">HttpPartSerializerSession</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1184">getPartSerializer</a>()</pre> |
| <div class="block">Returns the part serializer associated with this request.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The part serializer associated with this request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMethod--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMethod</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1196">getMethod</a>()</pre> |
| <div class="block">Returns the method of this request. |
| |
| <p> |
| If <c>allowHeaderParams</c> init parameter is <jk>true</jk>, then first looks for |
| <c>&method=xxx</c> in the URL query string.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true#getMethod--" title="class or interface in javax.servlet.http">getMethod</a></code> in interface <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getMethod--" title="class or interface in javax.servlet.http">getMethod</a></code> in class <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequestWrapper</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentLength</h4> |
| <pre>public int <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1201">getContentLength</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getContentLength--" title="class or interface in javax.servlet">getContentLength</a></code> in interface <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getContentLength--" title="class or interface in javax.servlet">getContentLength</a></code> in class <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true" title="class or interface in javax.servlet">ServletRequestWrapper</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isPlainText--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPlainText</h4> |
| <pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1221">isPlainText</a>()</pre> |
| <div class="block">Returns <jk>true</jk> if <c>&plainText=true</c> was specified as a URL parameter. |
| |
| <p> |
| This indicates that the <c>Content-Type</c> of the output should always be set to <js>"text/plain"</js> |
| to make it easy to render in a browser. |
| |
| <p> |
| This feature is useful for debugging.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><jk>true</jk> if <code>&amp;plainText=true</code> was specified as a URL parameter</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMessages--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessages</h4> |
| <pre>public <a href="../../../../org/apache/juneau/cp/Messages.html" title="class in org.apache.juneau.cp">Messages</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1253">getMessages</a>()</pre> |
| <div class="block">Returns the resource bundle for the request locale. |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>(...) |
| <jk>public</jk> String sayHello(RestRequest req, <ja>@Query</ja>(<js>"user"</js>) String user) { |
| |
| <jc>// Return a localized message.</jc> |
| <jk>return</jk> req.getMessages().getString(<js>"hello.message"</js>, user); |
| } |
| </p> |
| |
| <ul class='notes'> |
| <li> |
| The <a href="../../../../org/apache/juneau/cp/Messages.html" title="class in org.apache.juneau.cp"><code>Messages</code></a> object can also be passed as a parameter on the method. |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='jf'><a href="../../../../org/apache/juneau/rest/RestContext.html#REST_messages"><code>RestContext.REST_messages</code></a> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getMessage-java.lang.String-java.lang.Object...-"><code>getMessage(String,Object...)</code></a> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestMessages'>Overview > juneau-rest-server > Messages</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The resource bundle. |
| <br>Never <jk>null</jk>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMessage-java.lang.String-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessage</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1264">getMessage</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args)</pre> |
| <div class="block">Shortcut method for calling <a href="../../../../org/apache/juneau/rest/RestRequest.html#getMessages--"><code>getMessages()</code></a> and <a href="../../../../org/apache/juneau/cp/Messages.html#getString-java.lang.String-java.lang.Object...-"><code>Messages.getString(String,Object...)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The message key.</dd> |
| <dd><code>args</code> - Optional <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true" title="class or interface in java.text"><code>MessageFormat</code></a>-style arguments.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The localized message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContext</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest">RestContext</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1277">getContext</a>()</pre> |
| <div class="block">Returns the resource context handling the request. |
| |
| <p> |
| Can be used to access servlet-init parameters or annotations during requests, such as in calls to |
| <a href="../../../../org/apache/juneau/rest/RestGuard.html#guard-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-"><code>RestGuard.guard(RestRequest, RestResponse)</code></a>..</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The resource context handling the request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getJavaMethod--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJavaMethod</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect">Method</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1296">getJavaMethod</a>()</pre> |
| <div class="block">Returns the java method handling the request. |
| |
| <p> |
| Can be used to access the method name or method annotations during requests, such as in calls to |
| <a href="../../../../org/apache/juneau/rest/RestGuard.html#guard-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-"><code>RestGuard.guard(RestRequest, RestResponse)</code></a>. |
| |
| <ul class='notes'> |
| <li> |
| This returns <jk>null</jk> when evaluating servlet-level guards since the method has not been resolved at that |
| point of execution. |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The Java method handling the request, or <c>null</c> if the method has not yet been resolved.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBeanSession--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBeanSession</h4> |
| <pre>public <a href="../../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau">BeanSession</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1305">getBeanSession</a>()</pre> |
| <div class="block">Returns the <a href="../../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau"><code>BeanSession</code></a> associated with this request.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The request bean session.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDebug--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDebug</h4> |
| <pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1318">isDebug</a>()</pre> |
| <div class="block">Returns <jk>true</jk> if debug mode is enabled. |
| |
| Debug mode is enabled by simply adding <js>"?debug=true"</js> to the query string or adding a <c>Debug: true</c> header on the request.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><jk>true</jk> if debug mode is enabled.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setException-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setException</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1332">setException</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> t)</pre> |
| <div class="block">Sets the <js>"Exception"</js> attribute to the specified throwable. |
| |
| <p> |
| This exception is used by <a href="../../../../org/apache/juneau/rest/BasicRestCallLogger.html" title="class in org.apache.juneau.rest"><code>BasicRestCallLogger</code></a> for logging purposes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>t</code> - The attribute value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object (for method chaining).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNoTrace-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNoTrace</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1346">setNoTrace</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> b)</pre> |
| <div class="block">Sets the <js>"NoTrace"</js> attribute to the specified boolean. |
| |
| <p> |
| This flag is used by <a href="../../../../org/apache/juneau/rest/BasicRestCallLogger.html" title="class in org.apache.juneau.rest"><code>BasicRestCallLogger</code></a> and tells it not to log the current request.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>b</code> - The attribute value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object (for method chaining).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNoTrace--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNoTrace</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1356">setNoTrace</a>()</pre> |
| <div class="block">Shortcut for calling <c>setNoTrace(<jk>true</jk>)</c>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object (for method chaining).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDebug-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDebug</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1370">setDebug</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> b) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Sets the <js>"Debug"</js> attribute to the specified boolean. |
| |
| <p> |
| This flag is used by <a href="../../../../org/apache/juneau/rest/BasicRestCallLogger.html" title="class in org.apache.juneau.rest"><code>BasicRestCallLogger</code></a> to help determine how a request should be logged.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>b</code> - The attribute value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object (for method chaining).</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If body could not be cached.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDebug--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDebug</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1383">setDebug</a>() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Shortcut for calling <c>setDebug(<jk>true</jk>)</c>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object (for method chaining).</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If body could not be cached.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVarResolverSession--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVarResolverSession</h4> |
| <pre>public <a href="../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1418">getVarResolverSession</a>()</pre> |
| <div class="block">Request-level variable resolver session. |
| |
| <p> |
| Used to resolve SVL variables in text. |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>(...) |
| <jk>public</jk> String sayHello(RestRequest req) { |
| |
| <jc>// Get var resolver session.</jc> |
| VarResolverSession session = getVarResolverSession(); |
| |
| <jc>// Use it to construct a customized message from a query parameter.</jc> |
| <jk>return</jk> session.resolve(<js>"Hello $RQ{user}!"</js>); |
| } |
| </p> |
| |
| <ul class='notes'> |
| <li> |
| The <a href="../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl"><code>VarResolverSession</code></a> object can also be passed as a parameter on the method. |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview > juneau-rest-server > SVL Variables</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The variable resolver for this request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClasspathHttpResource-java.lang.String-boolean-org.apache.juneau.http.MediaType-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClasspathHttpResource</h4> |
| <pre>public <a href="../../../../org/apache/juneau/http/BasicHttpResource.html" title="class in org.apache.juneau.http">BasicHttpResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1459">getClasspathHttpResource</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| boolean resolveVars, |
| <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType, |
| boolean cached) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Returns an instance of a <a href="../../../../org/apache/juneau/http/BasicHttpResource.html" title="class in org.apache.juneau.http"><code>BasicHttpResource</code></a> that represents the contents of a resource text file from the |
| classpath. |
| |
| <p> |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <jc>// A rest method that (unsafely!) returns the contents of a localized file </jc> |
| <jc>// from the classpath and resolves any SVL variables embedded in it.</jc> |
| <ja>@RestMethod</ja>(...) |
| <jk>public</jk> String myMethod(RestRequest req, <ja>@Query</ja>(<js>"file"</js>) String file) { |
| <jk>return</jk> req.getClasspathResourceAsString(file, <jk>true</jk>); |
| } |
| </p> |
| |
| <ul class='seealso'> |
| <li class='jf'><a href="../../../../org/apache/juneau/rest/RestContext.html#REST_classpathResourceFinder"><code>RestContext.REST_classpathResourceFinder</code></a> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getClasspathHttpResource-java.lang.String-boolean-"><code>getClasspathHttpResource(String, boolean)</code></a> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getClasspathHttpResource-java.lang.String-"><code>getClasspathHttpResource(String)</code></a> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the resource (i.e. the value normally passed to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getResourceAsStream-java.lang.String-" title="class or interface in java.lang"><code>Class.getResourceAsStream(String)</code></a>.</dd> |
| <dd><code>resolveVars</code> - If <jk>true</jk>, any SVL variables will be |
| resolved by the variable resolver returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getVarResolverSession--"><code>getVarResolverSession()</code></a>. |
| <br>See <a href="../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables.</dd> |
| <dd><code>mediaType</code> - The value to set as the <js>"Content-Type"</js> header for this object.</dd> |
| <dd><code>cached</code> - If <jk>true</jk>, the resource will be read into a byte array for fast serialization.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new reader resource, or <jk>null</jk> if resource could not be found.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown by underlying stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClasspathResourceAsString-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClasspathResourceAsString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1477">getClasspathResourceAsString</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Returns a classpath resource as a string,</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The resource name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The resource contents, or <jk>null</jk> if they could not be found.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If a problem occurred reading the resource.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClasspathResourceAsString-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClasspathResourceAsString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1489">getClasspathResourceAsString</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| boolean resolveVars) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Returns a classpath resource as a string,</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The resource name.</dd> |
| <dd><code>resolveVars</code> - Resolve any SVL variables in the string.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The resource contents, or <jk>null</jk> if they could not be found.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If a problem occurred reading the resource.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClasspathHttpResource-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClasspathHttpResource</h4> |
| <pre>public <a href="../../../../org/apache/juneau/http/BasicHttpResource.html" title="class in org.apache.juneau.http">BasicHttpResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1508">getClasspathHttpResource</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| boolean resolveVars) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Same as <a href="../../../../org/apache/juneau/rest/RestRequest.html#getClasspathHttpResource-java.lang.String-boolean-org.apache.juneau.http.MediaType-boolean-"><code>getClasspathHttpResource(String, boolean, MediaType, boolean)</code></a> except uses the resource mime-type map |
| constructed using <a href="../../../../org/apache/juneau/rest/RestContextBuilder.html#mimeTypes-java.lang.String...-"><code>RestContextBuilder.mimeTypes(String...)</code></a> to determine the media type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the resource (i.e. the value normally passed to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getResourceAsStream-java.lang.String-" title="class or interface in java.lang"><code>Class.getResourceAsStream(String)</code></a>.</dd> |
| <dd><code>resolveVars</code> - If <jk>true</jk>, any SVL variables will be |
| resolved by the variable resolver returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getVarResolverSession--"><code>getVarResolverSession()</code></a>. |
| <br>See <a href="../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new reader resource, or <jk>null</jk> if resource could not be found.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown by underlying stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClasspathHttpResource-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClasspathHttpResource</h4> |
| <pre>public <a href="../../../../org/apache/juneau/http/BasicHttpResource.html" title="class in org.apache.juneau.http">BasicHttpResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1519">getClasspathHttpResource</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Same as <a href="../../../../org/apache/juneau/rest/RestRequest.html#getClasspathHttpResource-java.lang.String-boolean-"><code>getClasspathHttpResource(String, boolean)</code></a> with <code>resolveVars == <jk>false</jk></code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the resource (i.e. the value normally passed to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getResourceAsStream-java.lang.String-" title="class or interface in java.lang"><code>Class.getResourceAsStream(String)</code></a>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new reader resource, or <jk>null</jk> if resource could not be found.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown by underlying stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfig</h4> |
| <pre>public <a href="../../../../org/apache/juneau/config/Config.html" title="class in org.apache.juneau.config">Config</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1564">getConfig</a>()</pre> |
| <div class="block">Config file associated with the resource. |
| |
| <p> |
| Returns a config file with session-level variable resolution. |
| |
| The config file is identified via one of the following: |
| <ul class='javatree'> |
| <li class='ja'><a href="../../../../org/apache/juneau/rest/annotation/Rest.html#config--"><code>Rest.config()</code></a> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestContextBuilder.html#config-org.apache.juneau.config.Config-"><code>RestContextBuilder.config(Config)</code></a> |
| </ul> |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>(...) |
| <jk>public void</jk> doGet(RestRequest req) { |
| |
| <jc>// Get config file.</jc> |
| Config cf = req.getConfig(); |
| |
| <jc>// Get simple values from config file.</jc> |
| <jk>int</jk> timeout = cf.getInt(<js>"MyResource/timeout"</js>, 10000); |
| |
| <jc>// Get complex values from config file.</jc> |
| MyBean b = cf.getObject(<js>"MyResource/myBean"</js>, MyBean.<jk>class</jk>); |
| } |
| </p> |
| |
| <ul class='notes'> |
| <li> |
| The <a href="../../../../org/apache/juneau/config/Config.html" title="class in org.apache.juneau.config"><code>Config</code></a> object can also be passed as a parameter on the method. |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestConfigurationFiles'>Overview > juneau-rest-server > Configuration Files</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The config file associated with the resource, or <jk>null</jk> if resource does not have a config file |
| associated with it.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWidgets--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWidgets</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1582">getWidgets</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the widgets used for resolving <js>"$W{...}"</js> string variables. |
| |
| <div class='warn'> |
| <b>Deprecated</b> - No replacement. |
| </div></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The widgets used for resolving <js>"$W{...}"</js> string variables. |
| Never <jk>null</jk>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRequest-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequest</h4> |
| <pre>public <T> T <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1627">getRequest</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> c)</pre> |
| <div class="block">Creates a proxy interface to retrieve HTTP parts of this request as a proxy bean. |
| |
| <h5 class='section'>Examples:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>(path=<js>"/mypath/{p1}/{p2}/*"</js>) |
| <jk>public void</jk> myMethod(@Request MyRequest rb) {...} |
| |
| <jk>public interface</jk> MyRequest { |
| |
| <ja>@Path</ja> <jc>// Path variable name inferred from getter.</jc> |
| String getP1(); |
| |
| <ja>@Path</ja>(<js>"p2"</js>) |
| String getX(); |
| |
| <ja>@Path</ja>(<js>"/*"</js>) |
| String getRemainder(); |
| |
| <ja>@Query</ja> |
| String getQ1(); |
| |
| <jc>// Schema-based query parameter: Pipe-delimited lists of comma-delimited lists of integers.</jc> |
| <ja>@Query</ja>( |
| collectionFormat=<js>"pipes"</js> |
| items=<ja>@Items</ja>( |
| items=<ja>@SubItems</ja>( |
| collectionFormat=<js>"csv"</js> |
| type=<js>"integer"</js> |
| ) |
| ) |
| ) |
| <jk>int</jk>[][] getQ3(); |
| |
| <ja>@Header</ja>(<js>"*"</js>) |
| Map<String,Object> getHeaders(); |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>c</code> - The request bean interface to instantiate.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new request bean proxy for this REST request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRequest-org.apache.juneau.httppart.bean.RequestBeanMeta-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequest</h4> |
| <pre>public <T> T <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1637">getRequest</a>(<a href="../../../../org/apache/juneau/httppart/bean/RequestBeanMeta.html" title="class in org.apache.juneau.httppart.bean">RequestBeanMeta</a> rbm)</pre> |
| <div class="block">Same as <a href="../../../../org/apache/juneau/rest/RestRequest.html#getRequest-java.lang.Class-"><code>getRequest(Class)</code></a> but used on pre-instantiated <a href="../../../../org/apache/juneau/httppart/bean/RequestBeanMeta.html" title="class in org.apache.juneau.httppart.bean"><code>RequestBeanMeta</code></a> objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rbm</code> - The metadata about the request bean interface to create.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new request bean proxy for this REST request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1675">toString</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSerializerSessionArgs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSerializerSessionArgs</h4> |
| <pre>public <a href="../../../../org/apache/juneau/serializer/SerializerSessionArgs.html" title="class in org.apache.juneau.serializer">SerializerSessionArgs</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1706">getSerializerSessionArgs</a>()</pre> |
| <div class="block">Returns the session arguments to pass to serializers.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The session arguments to pass to serializers.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParserSessionArgs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParserSessionArgs</h4> |
| <pre>public <a href="../../../../org/apache/juneau/parser/ParserSessionArgs.html" title="class in org.apache.juneau.parser">ParserSessionArgs</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1726">getParserSessionArgs</a>()</pre> |
| <div class="block">Returns the session arguments to pass to parsers.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The session arguments to pass to parsers.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLogger--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLogger</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../org/apache/juneau/rest/RestCallLogger.html" title="interface in org.apache.juneau.rest">RestCallLogger</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1775">getLogger</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Logger. |
| |
| <div class='warn'> |
| <b>Deprecated</b> - Use standard logging APIs |
| </div> |
| |
| <p> |
| Shortcut for calling <c>getContext().getLogger()</c>. |
| |
| <h5 class='section'>Example:</h5> |
| <p class='bcode w800'> |
| <ja>@RestMethod</ja>(...) |
| <jk>public void</jk> doGet(RestRequest req) { |
| |
| req.getLogger().logObjects(<jsf>FINE</jsf>, <js>"Request query parameters = {0}"</js>, req.getQuery()); |
| } |
| </p> |
| |
| <ul class='notes'> |
| <li> |
| The <a href="../../../../org/apache/juneau/rest/RestLogger.html" title="interface in org.apache.juneau.rest"><code>RestLogger</code></a> object can also be passed as a parameter on the method. |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='jf'><a href="../../../../org/apache/juneau/rest/RestContext.html#REST_logger"><code>RestContext.REST_logger</code></a> |
| <li class='jac'><a href="../../../../org/apache/juneau/rest/RestLogger.html" title="interface in org.apache.juneau.rest"><code>RestLogger</code></a> |
| <li class='jm'><a href="../../../../org/apache/juneau/rest/RestServlet.html#log-java.util.logging.Level-java.lang.String-java.lang.Object...-"><code>RestServlet.log(Level, String, Object...)</code></a> |
| <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-server.RestLoggingAndDebugging'>Overview > juneau-rest-server > Logging / Debugging</a> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The logger associated with the resource context. |
| <br>Never <jk>null</jk>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCallLoggerConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCallLoggerConfig</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/RestCallLoggerConfig.html" title="class in org.apache.juneau.rest">RestCallLoggerConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1784">getCallLoggerConfig</a>()</pre> |
| <div class="block">Returns the logging configuration defined on the Java method that this request is executing against.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The logging configuration defined on the Java method that this request is executing against.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResponseBeanMeta-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResponseBeanMeta</h4> |
| <pre>public <a href="../../../../org/apache/juneau/httppart/bean/ResponseBeanMeta.html" title="class in org.apache.juneau.httppart.bean">ResponseBeanMeta</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1806">getResponseBeanMeta</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> |
| <div class="block">Returns metadata about the specified response object if it's annotated with <a href="../../../../org/apache/juneau/http/annotation/Response.html" title="annotation in org.apache.juneau.http.annotation"><code>@Response</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>o</code> - The response POJO.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the specified response object, or <jk>null</jk> if it's not annotated with <a href="../../../../org/apache/juneau/http/annotation/Response.html" title="annotation in org.apache.juneau.http.annotation"><code>@Response</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResponseHeaderMeta-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResponseHeaderMeta</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/ResponsePartMeta.html" title="class in org.apache.juneau.rest">ResponsePartMeta</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1816">getResponseHeaderMeta</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> |
| <div class="block">Returns metadata about the specified response object if it's annotated with <a href="../../../../org/apache/juneau/http/annotation/ResponseHeader.html" title="annotation in org.apache.juneau.http.annotation"><code>@ResponseHeader</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>o</code> - The response POJO.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the specified response object, or <jk>null</jk> if it's not annotated with <a href="../../../../org/apache/juneau/http/annotation/ResponseHeader.html" title="annotation in org.apache.juneau.http.annotation"><code>@ResponseHeader</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResponseBodyMeta-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResponseBodyMeta</h4> |
| <pre>public <a href="../../../../org/apache/juneau/rest/ResponsePartMeta.html" title="class in org.apache.juneau.rest">ResponsePartMeta</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1826">getResponseBodyMeta</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> |
| <div class="block">Returns metadata about the specified response object if it's annotated with <a href="../../../../org/apache/juneau/http/annotation/ResponseBody.html" title="annotation in org.apache.juneau.http.annotation"><code>@ResponseBody</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>o</code> - The response POJO.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the specified response object, or <jk>null</jk> if it's not annotated with <a href="../../../../org/apache/juneau/http/annotation/ResponseBody.html" title="annotation in org.apache.juneau.http.annotation"><code>@ResponseBody</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getJsonSchemaGenerator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJsonSchemaGenerator</h4> |
| <pre>public <a href="../../../../org/apache/juneau/jsonschema/JsonSchemaGenerator.html" title="class in org.apache.juneau.jsonschema">JsonSchemaGenerator</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1835">getJsonSchemaGenerator</a>()</pre> |
| <div class="block">Returns the schema generator with settings assigned on this method and class.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The schema generator.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInner--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getInner</h4> |
| <pre>protected <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1844">getInner</a>()</pre> |
| <div class="block">Returns the wrapped servlet request.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The wrapped servlet request.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/juneau/rest/RestParamType.html" title="enum in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/juneau/rest/RestResourceResolver.html" title="interface in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/juneau/rest/RestRequest.html" target="_top">Frames</a></li> |
| <li><a href="RestRequest.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2016–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |