http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/content/site/apidocs/org/apache/juneau/rest/RestResponse.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestResponse.html b/content/site/apidocs/org/apache/juneau/rest/RestResponse.html index 65be367..988cc62 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestResponse.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestResponse.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}; +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}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -122,7 +122,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public final class <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.50">RestResponse</a> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.53">RestResponse</a> extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletResponseWrapper</a></pre> <div class="block">Represents an HTTP response for a REST resource. <p> @@ -136,7 +136,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <p class='bcode'> <ja>@RestMethod</ja>(name=<js>"GET"</js>) <jk>public void</jk> doGet(RestRequest req, RestResponse res) { - res.setProperty(HtmlSerializerContext.<jsf>HTMLDOC_title</jsf>, <js>"My title"</js>) + res.setPageTitle(<js>"My title"</js>) .setOutput(<js>"Simple string response"</js>); } </p> @@ -293,6 +293,24 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ </tr> <tr id="i19" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setPageLinks-java.lang.Object-">setPageLinks</a></span>(<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> links)</code> +<div class="block">Sets the page text for HTML views.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setPageText-java.lang.Object-">setPageText</a></span>(<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> text)</code> +<div class="block">Sets the page text for HTML views.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setPageTitle-java.lang.Object-">setPageTitle</a></span>(<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> title)</code> +<div class="block">Sets the page title for HTML views.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setProperty-java.lang.String-java.lang.Object-">setProperty</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> 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> value)</code> <div class="block">Add a serializer property to send to the serializers to override a default value.</div> @@ -347,7 +365,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/RestResponse.html#line.120">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/RestResponse.html#line.123">getSerializerGroup</a>()</pre> <div class="block">Gets the serializer group for the response.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -361,7 +379,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getSupportedMediaTypes</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.129">getSupportedMediaTypes</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.132">getSupportedMediaTypes</a>()</pre> <div class="block">Returns the media types that are valid for <code>Accept</code> headers on the request.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -375,7 +393,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getSupportedEncodings</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</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>> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.139">getSupportedEncodings</a>() +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</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>> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.142">getSupportedEncodings</a>() throws <a href="../../../../org/apache/juneau/rest/RestServletException.html" title="class in org.apache.juneau.rest">RestServletException</a></pre> <div class="block">Returns the codings that are valid for <code>Accept-Encoding</code> and <code>Content-Encoding</code> headers on the request.</div> <dl> @@ -392,7 +410,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>setOutput</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.160">setOutput</a>(<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> output)</pre> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.163">setOutput</a>(<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> output)</pre> <div class="block">Sets the HTTP output on the response. <p> Calling this method is functionally equivalent to returning the object in the REST Java method. @@ -419,7 +437,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>setProperty</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.181">setProperty</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="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.184">setProperty</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> value)</pre> <div class="block">Add a serializer property to send to the serializers to override a default value. <p> @@ -445,7 +463,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getProperties</h4> -<pre>public <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.191">getProperties</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.194">getProperties</a>()</pre> <div class="block">Returns the properties set via <a href="../../../../org/apache/juneau/rest/RestResponse.html#setProperty-java.lang.String-java.lang.Object-"><code>setProperty(String, Object)</code></a>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -459,7 +477,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>setOutputs</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.210">setOutputs</a>(<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>... output)</pre> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.213">setOutputs</a>(<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>... output)</pre> <div class="block">Shortcut method that allows you to use varargs to simplify setting array output. <h5 class='section'>Example:</h5> @@ -484,7 +502,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getOutput</h4> -<pre>public <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> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.220">getOutput</a>()</pre> +<pre>public <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> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.223">getOutput</a>()</pre> <div class="block">Returns the output that was set by calling <a href="../../../../org/apache/juneau/rest/RestResponse.html#setOutput-java.lang.Object-"><code>setOutput(Object)</code></a>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -498,7 +516,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>hasOutput</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.229">hasOutput</a>()</pre> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.232">hasOutput</a>()</pre> <div class="block">Returns <jk>true</jk> if this response has any output associated with it.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -512,7 +530,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>sendPlainText</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.240">sendPlainText</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> text) +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.243">sendPlainText</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> text) 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">Sets the output to a plain-text message regardless of the content type.</div> <dl> @@ -531,7 +549,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getNegotiatedOutputStream</h4> -<pre>public <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletOutputStream.html?is-external=true"; title="class or interface in javax.servlet">ServletOutputStream</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.254">getNegotiatedOutputStream</a>() +<pre>public <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletOutputStream.html?is-external=true"; title="class or interface in javax.servlet">ServletOutputStream</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.257">getNegotiatedOutputStream</a>() 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">Equivalent to <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#getOutputStream--"; title="class or interface in javax.servlet"><code>ServletResponse.getOutputStream()</code></a>, except wraps the output stream if an <a href="../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>Encoder</code></a> was found that matched @@ -550,7 +568,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getOutputStream</h4> -<pre>public <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletOutputStream.html?is-external=true"; title="class or interface in javax.servlet">ServletOutputStream</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.305">getOutputStream</a>() +<pre>public <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletOutputStream.html?is-external=true"; title="class or interface in javax.servlet">ServletOutputStream</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.308">getOutputStream</a>() 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> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> @@ -568,7 +586,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getOutputStreamCalled</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.316">getOutputStreamCalled</a>()</pre> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.319">getOutputStreamCalled</a>()</pre> <div class="block">Returns <jk>true</jk> if <a href="../../../../org/apache/juneau/rest/RestResponse.html#getOutputStream--"><code>getOutputStream()</code></a> has been called.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -582,7 +600,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getWriter</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.326">getWriter</a>() +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.329">getWriter</a>() 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">Returns the writer to the response body. This methods bypasses any specified encoders and returns a regular unbuffered writer. @@ -603,7 +621,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getDirectWriter</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.339">getDirectWriter</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> contentType) +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.342">getDirectWriter</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> contentType) 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">Convenience method meant to be used when rendering directly to a browser with no buffering. Sets the header <js>"x-content-type-options=nosniff"</js> so that output is rendered @@ -624,7 +642,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getNegotiatedWriter</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.354">getNegotiatedWriter</a>() +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.357">getNegotiatedWriter</a>() 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">Equivalent to <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#getWriter--"; title="class or interface in javax.servlet"><code>ServletResponse.getWriter()</code></a>, except wraps the output stream if an <a href="../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>Encoder</code></a> was found that matched @@ -644,7 +662,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getMediaType</h4> -<pre>public <a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.379">getMediaType</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.382">getMediaType</a>()</pre> <div class="block">Returns the <code>Content-Type</code> header stripped of the charset attribute if present.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -658,7 +676,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>sendRedirect</h4> -<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.391">sendRedirect</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> uri) +<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.394">sendRedirect</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> uri) 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">Redirects to the specified URI. <p> @@ -681,7 +699,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getUrlEncodingSerializer</h4> -<pre>public <a href="../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.403">getUrlEncodingSerializer</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.406">getUrlEncodingSerializer</a>()</pre> <div class="block">Returns the URL-encoding serializer associated with this response.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -692,10 +710,10 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <a name="setHeader-java.lang.String-java.lang.String-"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>setHeader</h4> -<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.408">setHeader</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 void <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.411">setHeader</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, <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> value)</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> @@ -705,6 +723,82 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ </dl> </li> </ul> +<a name="setPageTitle-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPageTitle</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.436">setPageTitle</a>(<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> title)</pre> +<div class="block">Sets the page title for HTML views. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#pageTitle--"><code>@RestResource#pageTitle()</code></a>/ + <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#pageTitle--"><code>@RestMethod#pageTitle()</code></a> annotations. + <p> + This is a shortcut for calling <code>setProperty(<jsf>HTMLDOC_title</jsf>, title);</code> + <p class='info'> + <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate a page title with delayed serialization so as not to + waste string concatenation cycles on non-HTML views. + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>title</code> - The localized page title to render on the page. + Object will be converted to a string using <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"><code>Object.toString()</code></a>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setPageText-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPageText</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.455">setPageText</a>(<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> text)</pre> +<div class="block">Sets the page text for HTML views. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#pageText--"><code>@RestResource#pageText()</code></a>/ + <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#pageText--"><code>@RestMethod#pageText()</code></a> annotations. + <p> + This is a shortcut for calling <code>setProperty(<jsf>HTMLDOC_text</jsf>, text);</code> + <p class='info'> + <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate page text with delayed serialization so as not to + waste string concatenation cycles on non-HTML views. + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>text</code> - The localized page text to render on the page.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setPageLinks-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setPageLinks</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.474">setPageLinks</a>(<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> links)</pre> +<div class="block">Sets the page text for HTML views. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#pageLinks--"><code>@RestResource#pageLinks()</code></a>/ + <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#pageLinks--"><code>@RestMethod#pageLinks()</code></a> annotations. + <p> + This is a shortcut for calling <code>setProperty(<jsf>HTMLDOC_links</jsf>, links);</code> + <p class='info'> + <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate page links with delayed serialization so as not to + waste string concatenation cycles on non-HTML views. + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>links</code> - The localized page links render on the page.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> </li> </ul> </li>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html b/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html index d5a99dd..2af0748 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html @@ -131,8 +131,13 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre><a href="../../../../org/apache/juneau/rest/annotation/RestResource.html" title="annotation in org.apache.juneau.rest.annotation">@RestResource</a>(<a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#serializers--">serializers</a>={<a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html">HtmlDocSerializer.class</a>,<a href="../../../../org/apache/juneau/html/HtmlStrippedDocSerializer.html" title="class in org.apache.juneau.html">HtmlStrippedDocSerializer.class</a>,<a href="../../../../org/apache/juneau/html/HtmlSchemaDocSerializer.html" title="class in org.apache.juneau.html">HtmlSchemaDocSerializer.class</a>,<a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer.class</a>,<a href="../../../../org/apache/juneau/json/JsonSerializer.Simple.html" title="class in org.apache.juneau.json">JsonSerializer.Simple.class</a>,<a href="../../../../org/apac he/juneau/json/JsonSchemaSerializer.html" title="class in org.apache.juneau.json">JsonSchemaSerializer.class</a>,<a href="../../../../org/apache/juneau/xml/XmlDocSerializer.html" title="class in org.apache.juneau.xml">XmlDocSerializer.class</a>,<a href="../../../../org/apache/juneau/xml/XmlSchemaDocSerializer.html" title="class in org.apache.juneau.xml">XmlSchemaDocSerializer.class</a>,<a href="../../../../org/apache/juneau/uon/UonSerializer.html" title="class in org.apache.juneau.uon">UonSerializer.class</a>,<a href="../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer.class</a>,<a href="../../../../org/apache/juneau/msgpack/MsgPackSerializer.html" title="class in org.apache.juneau.msgpack">MsgPackSerializer.class</a>,<a href="../../../../org/apache/juneau/soap/SoapXmlSerializer.html" title="class in org.apache.juneau.soap">SoapXmlSerializer.class</a>,<a href="../../../../org/apache/juneau/plainte xt/PlainTextSerializer.html" title="class in org.apache.juneau.plaintext">PlainTextSerializer.class</a>,<a href="../../../../org/apache/juneau/jso/JsoSerializer.html" title="class in org.apache.juneau.jso">JsoSerializer.class</a>},<a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#parsers--">parsers</a>={<a href="../../../../org/apache/juneau/json/JsonParser.html" title="class in org.apache.juneau.json">JsonParser.class</a>,<a href="../../../../org/apache/juneau/xml/XmlParser.html" title="class in org.apache.juneau.xml">XmlParser.class</a>,<a href="../../../../org/apache/juneau/html/HtmlParser.html" title="class in org.apache.juneau.html">HtmlParser.class</a>,<a href="../../../../org/apache/juneau/uon/UonParser.html" title="class in org.apache.juneau.uon">UonParser.class</a>,<a href="../../../../org/apache/juneau/urlencoding/UrlEncodingParser.html" title="class in org.apache.juneau.urlencoding">UrlEncodingParser.class</a>,<a href="../../../../org/apache/juneau/ msgpack/MsgPackParser.html" title="class in org.apache.juneau.msgpack">MsgPackParser.class</a>,<a href="../../../../org/apache/juneau/plaintext/PlainTextParser.html" title="class in org.apache.juneau.plaintext">PlainTextParser.class</a>},<a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#properties--">properties</a>={<a href="../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">@Property</a>(<a href="../../../../org/apache/juneau/rest/annotation/Property.html#name--">name</a>="RestServlet.allowMethodParam",<a href="../../../../org/apache/juneau/rest/annotation/Property.html#value--">value</a>="OPTIONS"),<a href="../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">@Property</a>(<a href="../../../../org/apache/juneau/rest/annotation/Property.html#name--">name</a>="HtmlSerializer.title",<a href="../../../../org/apache/juneau/rest/annotat ion/Property.html#value--">value</a>="$R{servletTitle}"),<a href="../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">@Property</a>(<a href="../../../../org/apache/juneau/rest/annotation/Property.html#name--">name</a>="HtmlSerializer.description",<a href="../../../../org/apache/juneau/rest/annotation/Property.html#value--">value</a>="$R{servletDescription}")},<a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#stylesheet--">stylesheet</a>="styles/juneau.css",<a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#favicon--">favicon</a>="juneau.png",<a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#staticFiles--">staticFiles</a>="{htdocs:\'htdocs\'}") -public abstract class <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.195">RestServletDefault</a> +<pre><a href="../../../../org/apache/juneau/rest/annotation/RestResource.html" title="annotation in org.apache.juneau.rest.annotation">@RestResource</a>(<a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#serializers--">serializers</a>={<a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html">HtmlDocSerializer.class</a>,<a href="../../../../org/apache/juneau/html/HtmlStrippedDocSerializer.html" title="class in org.apache.juneau.html">HtmlStrippedDocSerializer.class</a>,<a href="../../../../org/apache/juneau/html/HtmlSchemaDocSerializer.html" title="class in org.apache.juneau.html">HtmlSchemaDocSerializer.class</a>,<a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer.class</a>,<a href="../../../../org/apache/juneau/json/JsonSerializer.Simple.html" title="class in org.apache.juneau.json">JsonSerializer.Simple.class</a>,<a href="../../../../org/apac he/juneau/json/JsonSchemaSerializer.html" title="class in org.apache.juneau.json">JsonSchemaSerializer.class</a>,<a href="../../../../org/apache/juneau/xml/XmlDocSerializer.html" title="class in org.apache.juneau.xml">XmlDocSerializer.class</a>,<a href="../../../../org/apache/juneau/xml/XmlSchemaDocSerializer.html" title="class in org.apache.juneau.xml">XmlSchemaDocSerializer.class</a>,<a href="../../../../org/apache/juneau/uon/UonSerializer.html" title="class in org.apache.juneau.uon">UonSerializer.class</a>,<a href="../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer.class</a>,<a href="../../../../org/apache/juneau/msgpack/MsgPackSerializer.html" title="class in org.apache.juneau.msgpack">MsgPackSerializer.class</a>,<a href="../../../../org/apache/juneau/soap/SoapXmlSerializer.html" title="class in org.apache.juneau.soap">SoapXmlSerializer.class</a>,<a href="../../../../org/apache/juneau/plainte xt/PlainTextSerializer.html" title="class in org.apache.juneau.plaintext">PlainTextSerializer.class</a>,<a href="../../../../org/apache/juneau/jso/JsoSerializer.html" title="class in org.apache.juneau.jso">JsoSerializer.class</a>}, + <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#parsers--">parsers</a>={<a href="../../../../org/apache/juneau/json/JsonParser.html" title="class in org.apache.juneau.json">JsonParser.class</a>,<a href="../../../../org/apache/juneau/xml/XmlParser.html" title="class in org.apache.juneau.xml">XmlParser.class</a>,<a href="../../../../org/apache/juneau/html/HtmlParser.html" title="class in org.apache.juneau.html">HtmlParser.class</a>,<a href="../../../../org/apache/juneau/uon/UonParser.html" title="class in org.apache.juneau.uon">UonParser.class</a>,<a href="../../../../org/apache/juneau/urlencoding/UrlEncodingParser.html" title="class in org.apache.juneau.urlencoding">UrlEncodingParser.class</a>,<a href="../../../../org/apache/juneau/msgpack/MsgPackParser.html" title="class in org.apache.juneau.msgpack">MsgPackParser.class</a>,<a href="../../../../org/apache/juneau/plaintext/PlainTextParser.html" title="class in org.apache.juneau.plaintext">PlainT extParser.class</a>}, + <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#properties--">properties</a>=<a href="../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">@Property</a>(<a href="../../../../org/apache/juneau/rest/annotation/Property.html#name--">name</a>="RestServlet.allowMethodParam",<a href="../../../../org/apache/juneau/rest/annotation/Property.html#value--">value</a>="OPTIONS"), + <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#stylesheet--">stylesheet</a>="styles/juneau.css", + <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#favicon--">favicon</a>="juneau.png", + <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#staticFiles--">staticFiles</a>="{htdocs:\'htdocs\'}") +public abstract class <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.190">RestServletDefault</a> extends <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a></pre> <div class="block">Subclass of <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>RestServlet</code></a> with default serializers and parsers defined. <p> @@ -353,7 +358,7 @@ extends <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="cla <ul class="blockListLast"> <li class="blockList"> <h4>RestServletDefault</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.195">RestServletDefault</a>()</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.190">RestServletDefault</a>()</pre> </li> </ul> </li> @@ -370,8 +375,12 @@ extends <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="cla <ul class="blockListLast"> <li class="blockList"> <h4>getOptions</h4> -<pre><a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation">@RestMethod</a>(<a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#name--">name</a>="OPTIONS",<a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#path--">path</a>="/*",<a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#properties--">properties</a>={<a href="../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">@Property</a>(<a href="../../../../org/apache/juneau/rest/annotation/Property.html#name--">name</a>="HtmlDocSerializer.links.map",<a href="../../../../org/apache/juneau/rest/annotation/Property.html#value--">value</a>="{back:\'$R{servletURI}\'}"),<a href="../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">@Property</a>(<a href="../../../../org/apache/juneau/rest /annotation/Property.html#name--">name</a>="HtmlSerializer.description",<a href="../../../../org/apache/juneau/rest/annotation/Property.html#value--">value</a>="Resource options")},<a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#description--">description</a>="Resource options") -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/RestServletDefault.html#line.211">getOptions</a>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</pre> +<pre><a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation">@RestMethod</a>(<a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#name--">name</a>="OPTIONS", + <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#path--">path</a>="/*", + <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#pageLinks--">pageLinks</a>="{back:\'$R{servletURI}\'}", + <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#summary--">summary</a>="Resource options", + <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#description--">description</a>="Description of this resource") +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/RestServletDefault.html#line.204">getOptions</a>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</pre> <div class="block">[OPTIONS /*] - Show resource options.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/content/site/apidocs/org/apache/juneau/rest/RestUtils.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestUtils.html b/content/site/apidocs/org/apache/juneau/rest/RestUtils.html index 9644e49..ab33041 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestUtils.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestUtils.html @@ -108,7 +108,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public final class <a href="../../../../src-html/org/apache/juneau/rest/RestUtils.html#line.26">RestUtils</a> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/rest/RestUtils.html#line.27">RestUtils</a> extends <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></pre> <div class="block">Various reusable utility methods.</div> </li> @@ -224,7 +224,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>RestUtils</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RestUtils.html#line.26">RestUtils</a>()</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RestUtils.html#line.27">RestUtils</a>()</pre> </li> </ul> </li> @@ -241,7 +241,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getHttpResponseText</h4> -<pre>public static <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/RestUtils.html#line.34">getHttpResponseText</a>(int rc)</pre> +<pre>public static <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/RestUtils.html#line.35">getHttpResponseText</a>(int rc)</pre> <div class="block">Returns readable text for an HTTP response code.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/content/site/apidocs/org/apache/juneau/rest/annotation/Path.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Path.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Path.html index 2f1808f..d772dba 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Path.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Path.html @@ -96,7 +96,7 @@ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER"; title="class or interface in java.lang.annotation">PARAMETER</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true"; title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Path.html#line.64">Path</a></pre> +public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Path.html#line.73">Path</a></pre> <div class="block">Annotation that can be applied to a parameter of a <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation"><code>RestMethod</code></a> annotated method to identify it as a variable in a URL path pattern converted to a POJO. @@ -134,6 +134,15 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ja>@Path</ja>(<js>"baz"</js>) UUID baz, <ja>@Path</ja>(<js>"foo"</js>) String foo, <ja>@Path</ja>(<js>"bar"</js>) <jk>int</jk> bar) { ... } + </p> + You can also use <code>{#}</code> notation to specify path parameters without specifying names. + <p> + <p class='bcode'> + <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/myurl/{0}/{1}/{2}/*"</js>) + <jk>public void</jk> doGet(RestRequest req, RestResponse res, + <ja>@Path</ja> String foo, <ja>@Path</ja> <jk>int</jk> bar, <ja>@Path</ja> UUID baz) { + ... + } </p></div> </li> </ul> @@ -180,7 +189,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>value</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/Path.html#line.71">value</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/Path.html#line.80">value</a></pre> <div class="block">URL variable name. <p> Optional if the attributes are specified in the same order as in the URL path pattern.</div> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html b/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html index dc7c37d..6e9e573 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html @@ -179,23 +179,35 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </td> </tr> <tr 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/annotation/RestMethod.html#links--">links</a></span></code> -<div class="block">TODO</div> -</td> -</tr> -<tr class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestMatcher.html" title="class in org.apache.juneau.rest">RestMatcher</a>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#matchers--">matchers</a></span></code> <div class="block">Method matchers.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <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/annotation/RestMethod.html#name--">name</a></span></code> <div class="block">REST method name.</div> </td> </tr> +<tr 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/annotation/RestMethod.html#pageLinks--">pageLinks</a></span></code> +<div class="block">Overrides the HTML page links defined on the servlet via the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageLinks--"><code>@RestResource.pageLinks()</code></a> annotation.</div> +</td> +</tr> +<tr class="rowColor"> +<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/annotation/RestMethod.html#pageText--">pageText</a></span></code> +<div class="block">Overrides the HTML page text defined on the servlet via the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageText--"><code>@RestResource.pageText()</code></a> annotation.</div> +</td> +</tr> +<tr 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/annotation/RestMethod.html#pageTitle--">pageTitle</a></span></code> +<div class="block">Overrides the HTML page title defined on the servlet via the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageTitle--"><code>@RestResource.pageTitle()</code></a> annotation.</div> +</td> +</tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation">Parameter</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#parameters--">parameters</a></span></code> @@ -289,7 +301,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>name</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/RestMethod.html#line.63">name</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/RestMethod.html#line.64">name</a></pre> <div class="block">REST method name. <p> Typically <js>"GET"</js>, <js>"PUT"</js>, <js>"POST"</js>, <js>"DELETE"</js>, or <js>"OPTIONS"</js>. @@ -305,6 +317,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <li><js>""</js> - Auto-detect. <br>The method name is determined based on the Java method name. <br>For example, if the method is <code>doPost(...)</code>, then the method name is automatically detected as <js>"POST"</js>. + <br>Otherwise, defaults to <js>"GET"</js>. <li><js>"PROXY"</js> - Remote-proxy interface. <br>This denotes a Java method that returns an object (usually an interface, often annotated with the <a href="../../../../../org/apache/juneau/annotation/Remoteable.html" title="annotation in org.apache.juneau.annotation"><code>@Remoteable</code></a> annotation) to be used as a remote proxy using <code>RestClient.getRemoteableProxy(Class<T> interfaceClass, String url)</code>. @@ -329,12 +342,23 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>path</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/RestMethod.html#line.72">path</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/RestMethod.html#line.84">path</a></pre> <div class="block">Optional path pattern for the specified method. <p> Appending <js>"/*"</js> to the end of the path pattern will make it match any remainder too.<br> Not appending <js>"/*"</js> to the end of the pattern will cause a 404 (Not found) error to occur - if the exact pattern is not found.</div> + if the exact pattern is not found. + <p> + The path can contain variables that get resolved to <a href="../../../../../org/apache/juneau/rest/annotation/Path.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Path</code></a> parameters: + <p class='bcode'> + <jc>// Example 1</jc> + <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/myurl/{foo}/{bar}/{baz}/*"</js>) + + <jc>// Example 2</jc> + <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/myurl/{0}/{1}/{2}/*"</js>) + </p> + <p> + Refer to <a href="../../../../../org/apache/juneau/rest/annotation/Path.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Path</code></a> on how path variables get resolved.</div> <dl> <dt>Default:</dt> <dd>"/*"</dd> @@ -350,7 +374,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>priority</h4> -<pre>public abstract int <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.82">priority</a></pre> +<pre>public abstract int <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.94">priority</a></pre> <div class="block">URL path pattern priority. <p> To force path patterns to be checked before other path patterns, use a higher priority number. @@ -372,7 +396,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>guards</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest">RestGuard</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.93">guards</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest">RestGuard</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.105">guards</a></pre> <div class="block">Method guards. <p> Associates one or more <a href="../../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest"><code>RestGuards</code></a> with a method call. @@ -395,7 +419,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>converters</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest">RestConverter</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.106">converters</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest">RestConverter</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.118">converters</a></pre> <div class="block">Method response converters. <p> Associates one or more <a href="../../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest"><code>RestConverters</code></a> with a method call. @@ -420,7 +444,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>matchers</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestMatcher.html" title="class in org.apache.juneau.rest">RestMatcher</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.118">matchers</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestMatcher.html" title="class in org.apache.juneau.rest">RestMatcher</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.130">matchers</a></pre> <div class="block">Method matchers. <p> Associates one more more <a href="../../../../../org/apache/juneau/rest/RestMatcher.html" title="class in org.apache.juneau.rest"><code>RestMatchers</code></a> with this method. @@ -444,7 +468,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>serializers</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.142">serializers</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.154">serializers</a></pre> <div class="block">Overrides the list of serializers assigned at the method level. <p> Use this annotation when the list of serializers assigned to a method differs from the list of serializers assigned at the servlet level. @@ -480,7 +504,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>serializersInherit</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.164">serializersInherit</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.176">serializersInherit</a></pre> <div class="block">Used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#serializers--"><code>serializers()</code></a> to identify what class-level settings are inherited by the method serializer group. <p> Possible values: @@ -514,7 +538,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>parsers</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.188">parsers</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.200">parsers</a></pre> <div class="block">Overrides the list of parsers assigned at the method level. <p> Use this annotation when the list of parsers assigned to a method differs from the list of parsers assigned at the servlet level. @@ -550,7 +574,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>parsersInherit</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.209">parsersInherit</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.221">parsersInherit</a></pre> <div class="block">Used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#parsers--"><code>parsers()</code></a> to identify what class-level settings are inherited by the method parser group. <p> Possible values: @@ -583,7 +607,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>encoders</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders">Encoder</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.234">encoders</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders">Encoder</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.246">encoders</a></pre> <div class="block">Appends to the list of <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>encoders</code></a> specified on the servlet. <p> Use this annotation when the list of encoders assigned to a method differs from the list of encoders assigned at the servlet level. @@ -620,7 +644,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>inheritEncoders</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.239">inheritEncoders</a></pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.251">inheritEncoders</a></pre> <div class="block">Specifies whether the method should inherit encoders from the servlet.</div> <dl> <dt>Default:</dt> @@ -637,7 +661,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>properties</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">Property</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.246">properties</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">Property</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.258">properties</a></pre> <div class="block">Same as <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#properties--"><code>RestResource.properties()</code></a>, except defines property values by default when this method is called. <p> This is equivalent to simply calling <code>res.addProperties()</code> in the Java method, but is provided for convenience.</div> @@ -656,7 +680,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>beanFilters</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.251">beanFilters</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.263">beanFilters</a></pre> <div class="block">Appends the specified bean filters to all serializers and parsers used by this method.</div> <dl> <dt>Default:</dt> @@ -673,7 +697,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>pojoSwaps</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.256">pojoSwaps</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.268">pojoSwaps</a></pre> <div class="block">Appends the specified POJO swaps to all serializers and parsers used by this method.</div> <dl> <dt>Default:</dt> @@ -690,7 +714,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>defaultRequestHeaders</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/RestMethod.html#line.281">defaultRequestHeaders</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/RestMethod.html#line.293">defaultRequestHeaders</a></pre> <div class="block">Specifies default values for request headers. <p> Strings are of the format <js>"Header-Name: header-value"</js>. @@ -727,7 +751,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>summary</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/RestMethod.html#line.300">summary</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/RestMethod.html#line.312">summary</a></pre> <div class="block">Optional summary for the exposed API. <p> This summary is used in the following locations: @@ -758,7 +782,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>description</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/RestMethod.html#line.319">description</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/RestMethod.html#line.331">description</a></pre> <div class="block">Optional description for the exposed API. <p> This description is used in the following locations: @@ -789,7 +813,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>externalDocs</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/RestMethod.html#line.346">externalDocs</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/RestMethod.html#line.358">externalDocs</a></pre> <div class="block">Optional external documentation information for the exposed API. <p> Used to populate the Swagger external documentation field. @@ -828,7 +852,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>tags</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/RestMethod.html#line.368">tags</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/RestMethod.html#line.380">tags</a></pre> <div class="block">Optional tagging information for the exposed API. <p> Used to populate the Swagger tags field. @@ -862,7 +886,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>deprecated</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.387">deprecated</a></pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.399">deprecated</a></pre> <div class="block">Optional deprecated flag for the exposed API. <p> Used to populate the Swagger deprecated field. @@ -893,7 +917,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>parameters</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation">Parameter</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.424">parameters</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation">Parameter</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.436">parameters</a></pre> <div class="block">Optional parameter descriptions. <p> This annotation is provided for documentation purposes and is used to populate the method <js>"parameters"</js> column @@ -942,7 +966,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>responses</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Response.html" title="annotation in org.apache.juneau.rest.annotation">Response</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.460">responses</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Response.html" title="annotation in org.apache.juneau.rest.annotation">Response</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.472">responses</a></pre> <div class="block">Optional output description. <p> This annotation is provided for documentation purposes and is used to populate the method <js>"responses"</js> column @@ -990,7 +1014,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>clientVersion</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/RestMethod.html#line.518">clientVersion</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/RestMethod.html#line.530">clientVersion</a></pre> <div class="block">Specifies whether this method can be called based on the client version. <p> The client version is identified via the HTTP request header identified by <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#clientVersionHeader--"><code>RestResource.clientVersionHeader()</code></a> which @@ -1054,14 +1078,48 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="links--"> +<li class="blockList"><a name="pageTitle--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pageTitle</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/RestMethod.html#line.535">pageTitle</a></pre> +<div class="block">Overrides the HTML page title defined on the servlet via the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageTitle--"><code>@RestResource.pageTitle()</code></a> annotation.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="pageText--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pageText</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/RestMethod.html#line.540">pageText</a></pre> +<div class="block">Overrides the HTML page text defined on the servlet via the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageText--"><code>@RestResource.pageText()</code></a> annotation.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="pageLinks--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> -<h4>links</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/RestMethod.html#line.523">links</a></pre> -<div class="block">TODO</div> +<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/RestMethod.html#line.545">pageLinks</a></pre> +<div class="block">Overrides the HTML page links defined on the servlet via the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageLinks--"><code>@RestResource.pageLinks()</code></a> annotation.</div> <dl> <dt>Default:</dt> <dd>""</dd>
