http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/57ce76c3/content/site/apidocs/org/apache/juneau/rest/RestRequest.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestRequest.html b/content/site/apidocs/org/apache/juneau/rest/RestRequest.html index 4d24028..f9c5a0a 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestRequest.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestRequest.html @@ -18,7 +18,7 @@ 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":10,"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":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10}; +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":10,"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":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -471,36 +471,43 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ </td> </tr> <tr id="i50" 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="i51" class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestRequest.html#getURL-java.lang.String-">getURL</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path)</code> <div class="block">Returns a resolved URL.</div> </td> </tr> -<tr id="i51" class="rowColor"> +<tr id="i52" class="altColor"> <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">Returns the variable resolver session for this request using session objects created by <a href="../../../../org/apache/juneau/rest/RestCallHandler.html#getSessionObjects-org.apache.juneau.rest.RestRequest-"><code>RestCallHandler.getSessionObjects(RestRequest)</code></a>.</div> </td> </tr> -<tr id="i52" class="altColor"> +<tr id="i53" class="rowColor"> <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 <code>&plainText=true</code> was specified as a URL parameter.</div> </td> </tr> -<tr id="i53" class="rowColor"> +<tr id="i54" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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#resolveVars-java.lang.String-">resolveVars</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> input)</code> <div class="block">Shortcut for calling <code>getVarResolverSession().resolve(input)</code>.</div> </td> </tr> -<tr id="i54" class="altColor"> +<tr id="i55" class="rowColor"> <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="http://docs.oracle.com/javase/7/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="i55" class="rowColor"> +<tr id="i56" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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> @@ -853,13 +860,31 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ </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.478">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="getPathInfoUndecoded--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPathInfoUndecoded</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.476">getPathInfoUndecoded</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.487">getPathInfoUndecoded</a>()</pre> <div class="block">Same as <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true#getPathInfo--"; title="class or interface in javax.servlet.http"><code>HttpServletRequest.getPathInfo()</code></a> except returns the path undecoded.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -873,7 +898,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getPathInfoParts</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.489">getPathInfoParts</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.500">getPathInfoParts</a>()</pre> <div class="block">Returns the value <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getPathInfo--"; title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getPathInfo()</code></a> split on the <js>'/'</js> character. <p> If path info is <jk>null</jk>, returns an empty list. @@ -891,7 +916,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getURL</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.521">getURL</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path) +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.532">getURL</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/net/MalformedURLException.html?is-external=true"; title="class or interface in java.net">MalformedURLException</a></pre> <div class="block">Returns a resolved URL. <p> @@ -916,7 +941,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getServletParentURI</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.534">getServletParentURI</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.545">getServletParentURI</a>()</pre> <div class="block">Returns the URI of the parent of this servlet.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -930,7 +955,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getRequestParentURI</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.578">getRequestParentURI</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.589">getRequestParentURI</a>()</pre> <div class="block">Returns the URI of the parent resource. <p> Trailing slashes in the path are ignored by this method. @@ -978,7 +1003,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getTrimmedRequestURI</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.593">getTrimmedRequestURI</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.604">getTrimmedRequestURI</a>()</pre> <div class="block">Same as <a href="http://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 trims trailing slashes from the result.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -992,7 +1017,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getTrimmedRequestURL</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.602">getTrimmedRequestURL</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.613">getTrimmedRequestURL</a>()</pre> <div class="block">Same as <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getRequestURL--"; title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getRequestURL()</code></a> but trims trailing slashes from the result.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1006,7 +1031,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getServletURI</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.611">getServletURI</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.622">getServletURI</a>()</pre> <div class="block">Gets the URI of the servlet (e.g. <js>"https://localhost:9080/contextPath/servletPath";</js>).</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1020,7 +1045,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getRelativeServletURI</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.626">getRelativeServletURI</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.637">getRelativeServletURI</a>()</pre> <div class="block">Gets the path-absolute relative URI of the servlet (e.g. <js>"/contextPath/servletPath"</js>).</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1034,7 +1059,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getServletURIBuilder</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.637">getServletURIBuilder</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.648">getServletURIBuilder</a>()</pre> <div class="block">Returns a <code>StringBuffer</code> prefilled with the string <code><js>"/[contextPath]/[servletPath]"</js></code>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1048,7 +1073,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getServletTitle</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.653">getServletTitle</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.664">getServletTitle</a>()</pre> <div class="block">Returns the localized servlet 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> @@ -1064,7 +1089,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getServletDescription</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.664">getServletDescription</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.675">getServletDescription</a>()</pre> <div class="block">Returns the localized servlet 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> @@ -1080,7 +1105,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getMethodSummary</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.675">getMethodSummary</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.686">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.String-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getMethodSummary(String, RestRequest)</code></a> with this object.</div> @@ -1096,7 +1121,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getMethodDescription</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.686">getMethodDescription</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.697">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.String-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getMethodDescription(String, RestRequest)</code></a> with this object.</div> @@ -1112,7 +1137,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getPageTitle</h4> -<pre>protected <a href="http://docs.oracle.com/javase/7/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.695">getPageTitle</a>()</pre> +<pre>protected <a href="http://docs.oracle.com/javase/7/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.706">getPageTitle</a>()</pre> <div class="block">Returns the localized page title for HTML views.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1126,7 +1151,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getPageText</h4> -<pre>protected <a href="http://docs.oracle.com/javase/7/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.712">getPageText</a>()</pre> +<pre>protected <a href="http://docs.oracle.com/javase/7/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.723">getPageText</a>()</pre> <div class="block">Returns the localized page text for HTML views.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1140,7 +1165,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getPageLinks</h4> -<pre>protected <a href="http://docs.oracle.com/javase/7/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.731">getPageLinks</a>()</pre> +<pre>protected <a href="http://docs.oracle.com/javase/7/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.742">getPageLinks</a>()</pre> <div class="block">Returns the localized page links for HTML views.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1154,7 +1179,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getSerializerGroup</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.750">getSerializerGroup</a>()</pre> +<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.761">getSerializerGroup</a>()</pre> <div class="block">Returns the serializers associated with this request.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1168,7 +1193,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getParserGroup</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.759">getParserGroup</a>()</pre> +<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.770">getParserGroup</a>()</pre> <div class="block">Returns the parsers associated with this request.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1182,7 +1207,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getMethod</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.770">getMethod</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.781">getMethod</a>()</pre> <div class="block">Returns the method of this request. <p> If <code>allowHeaderParams</code> init parameter is <jk>true</jk>, then first looks for <code>&method=xxx</code> in the URL query string.</div> @@ -1200,7 +1225,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getHttpMethod</h4> -<pre>public <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.781">getHttpMethod</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.792">getHttpMethod</a>()</pre> <div class="block">Returns the HTTP 1.1 method name of the request as an enum. <p> Note that non-RFC2616 method names resolve as <a href="../../../../org/apache/juneau/http/HttpMethod.html#OTHER"><code>HttpMethod.OTHER</code></a>.</div> @@ -1216,7 +1241,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getContentLength</h4> -<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.786">getContentLength</a>()</pre> +<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.797">getContentLength</a>()</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="http://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="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true"; title="class or interface in javax.servlet">ServletRequest</a></code></dd> @@ -1231,7 +1256,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>isPlainText</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.804">isPlainText</a>()</pre> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.815">isPlainText</a>()</pre> <div class="block">Returns <jk>true</jk> if <code>&plainText=true</code> was specified as a URL parameter. <p> This indicates that the <code>Content-Type</code> of the output should always be set to <js>"text/plain"</js> @@ -1250,7 +1275,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getMessage</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.815">getMessage</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, +<pre>public <a href="http://docs.oracle.com/javase/7/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.826">getMessage</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, <a href="http://docs.oracle.com/javase/7/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/utils/MessageBundle.html#getString-java.util.Locale-java.lang.String-java.lang.Object...-"><code>MessageBundle.getString(Locale, String, Object...)</code></a> based on the request locale.</div> <dl> @@ -1268,7 +1293,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getResourceBundle</h4> -<pre>public <a href="../../../../org/apache/juneau/utils/MessageBundle.html" title="class in org.apache.juneau.utils">MessageBundle</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.824">getResourceBundle</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/utils/MessageBundle.html" title="class in org.apache.juneau.utils">MessageBundle</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.835">getResourceBundle</a>()</pre> <div class="block">Returns the resource bundle for the request locale.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1282,7 +1307,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <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.836">getContext</a>()</pre> +<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.847">getContext</a>()</pre> <div class="block">Returns the servlet handling the request. <p> Can be used to access servlet-init parameters or annotations during requests, @@ -1299,7 +1324,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getJavaMethod</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.854">getJavaMethod</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.865">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 @@ -1322,7 +1347,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <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.863">getBeanSession</a>()</pre> +<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.874">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> @@ -1336,7 +1361,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <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.872">getVarResolverSession</a>()</pre> +<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.883">getVarResolverSession</a>()</pre> <div class="block">Returns the variable resolver session for this request using session objects created by <a href="../../../../org/apache/juneau/rest/RestCallHandler.html#getSessionObjects-org.apache.juneau.rest.RestRequest-"><code>RestCallHandler.getSessionObjects(RestRequest)</code></a>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1350,7 +1375,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>resolveVars</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.884">resolveVars</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> input)</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.895">resolveVars</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> input)</pre> <div class="block">Shortcut for calling <code>getVarResolverSession().resolve(input)</code>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1366,7 +1391,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getReaderResource</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.898">getReaderResource</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, +<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.909">getReaderResource</a>(<a href="http://docs.oracle.com/javase/7/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) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> @@ -1390,7 +1415,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getReaderResource</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.918">getReaderResource</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, +<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.929">getReaderResource</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, boolean resolveVars) throws <a href="http://docs.oracle.com/javase/7/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#getReaderResource-java.lang.String-boolean-org.apache.juneau.http.MediaType-"><code>getReaderResource(String, boolean, MediaType)</code></a> except uses the resource mime-type map @@ -1413,7 +1438,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getReaderResource</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.929">getReaderResource</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name) +<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.940">getReaderResource</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name) throws <a href="http://docs.oracle.com/javase/7/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#getReaderResource-java.lang.String-boolean-"><code>getReaderResource(String, boolean)</code></a> with <code>resolveVars == <jk>false</jk></code></div> <dl> @@ -1432,7 +1457,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getConfigFile</h4> -<pre>public <a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini">ConfigFile</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.938">getConfigFile</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini">ConfigFile</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.949">getConfigFile</a>()</pre> <div class="block">Returns the config file associated with the servlet.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1446,7 +1471,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <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.949">getSwagger</a>()</pre> +<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.960">getSwagger</a>()</pre> <div class="block">Returns the localized swagger associated with the servlet.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1460,7 +1485,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getSwaggerFromFile</h4> -<pre>protected <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.965">getSwaggerFromFile</a>()</pre> +<pre>protected <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.976">getSwaggerFromFile</a>()</pre> <div class="block">Returns the localized Swagger from the file system. <p> Looks for a file called <js>"{ServletClass}_{locale}.json"</js> in the same package @@ -1479,7 +1504,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/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.974">toString</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/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.985">toString</a>()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/57ce76c3/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html index 12abff3..e8e1fe6 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html @@ -1514,7 +1514,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>pageLinks</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/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/annotation/RestResource.html#line.829">pageLinks</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/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/annotation/RestResource.html#line.831">pageLinks</a></pre> <div class="block">Specifies the page hyperlinks to use on the HTML view of all pages produced by this resource. <p> The page links is positioned immediately under the title and text. @@ -1524,7 +1524,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p class='bcode'> <ja>@RestResource</ja>( properties={ - <ja>@Property</ja>(name=<jsf>HTMLDOC_links</jsf>, value=<js>"{up:'$R{requestParentURI}',options:'?method=OPTIONS'}"</js>) + <ja>@Property</ja>(name=<jsf>HTMLDOC_links</jsf>, value=<js>"{up:'request:/..',options:'servlet:/?method=OPTIONS'}"</js>) } ) <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault { @@ -1540,6 +1540,8 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). <p> + This field can also use URIs of any support type in <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a>. + <p> The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setPageLinks-java.lang.String-"><code>RestConfig.setPageLinks(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setPageLinks-java.lang.Object-"><code>RestResponse.setPageLinks(Object)</code></a> methods.</div> <dl> <dt>Default:</dt>
