You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/04/01 23:58:23 UTC
[35/51] [partial] incubator-juneau-website git commit: Javadoc
updates.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/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 3fdc1cc..6124112 100644
--- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html
+++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.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#TYPE" title="class or interface in java.lang.annotation">TYPE</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/RestResource.html#line.45">RestResource</a></pre>
+public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.46">RestResource</a></pre>
<div class="block">Used to denote that a class is a REST resource and to associate metadata on it.
<p>
Usually used on a subclass of <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>RestServlet</code></a>, but can be used to annotate any class that you want to expose as a REST resource.
@@ -217,23 +217,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/RestResource.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/RestLogger.html" title="class in org.apache.juneau.rest">RestLogger</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#logger--">logger</a></span></code>
<div class="block">Specifies the logger class to use for logging.</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/RestResource.html#messages--">messages</a></span></code>
<div class="block">Identifies the location of the resource bundle for this class.</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/RestResource.html#pageLinks--">pageLinks</a></span></code>
+<div class="block">Specifies the page hyperlinks to use on the HTML view of all pages produced by this resource.</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/RestResource.html#pageText--">pageText</a></span></code>
+<div class="block">Specifies the page text to use on the HTML view of all pages produced by this resource.</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/RestResource.html#pageTitle--">pageTitle</a></span></code>
+<div class="block">Specifies the page title to use on the HTML view of all pages produced by this resource.</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/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#parsers--">parsers</a></span></code>
@@ -335,7 +347,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>messages</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.63">messages</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.64">messages</a></pre>
<div class="block">Identifies the location of the resource bundle for this class.
<p>
This annotation is used to provide localized messages for the following methods:
@@ -365,7 +377,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/RestResource.html#line.77">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/RestResource.html#line.78">guards</a></pre>
<div class="block">Class-level 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 all REST methods defined
@@ -391,7 +403,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/RestResource.html#line.92">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/RestResource.html#line.93">converters</a></pre>
<div class="block">Class-level converters.
<p>
Associates one or more <a href="../../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest"><code>converters</code></a> with a resource class.
@@ -418,7 +430,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/RestResource.html#line.110">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/RestResource.html#line.111">beanFilters</a></pre>
<div class="block">Class-level bean filters.
<p>
Shortcut to add bean filters to the bean contexts of the objects returned by the following methods:
@@ -448,7 +460,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/RestResource.html#line.127">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/RestResource.html#line.128">pojoSwaps</a></pre>
<div class="block">Class-level POJO swaps.
<p>
Shortcut to add POJO swaps to the bean contexts of the objects returned by the following methods:
@@ -477,7 +489,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/RestResource.html#line.160">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/RestResource.html#line.161">properties</a></pre>
<div class="block">Class-level properties.
<p>
Shortcut for specifying class-level properties on this servlet to the objects returned by the following methods:
@@ -522,7 +534,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/RestResource.html#line.169">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/RestResource.html#line.170">serializers</a></pre>
<div class="block">Specifies a list of <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializer</code></a> classes to add to the list of serializers available for this servlet.
<p>
This annotation can only be used on <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializer</code></a> classes that have no-arg constructors.
@@ -543,7 +555,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/RestResource.html#line.178">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/RestResource.html#line.179">parsers</a></pre>
<div class="block">Specifies a list of <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser"><code>Parser</code></a> classes to add to the list of parsers available for this servlet.
<p>
This annotation can only be used on <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser"><code>Parser</code></a> classes that have no-arg constructors.
@@ -564,7 +576,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>responseHandlers</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/ResponseHandler.html" title="interface in org.apache.juneau.rest">ResponseHandler</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.189">responseHandlers</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/ResponseHandler.html" title="interface in org.apache.juneau.rest">ResponseHandler</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.190">responseHandlers</a></pre>
<div class="block">Specifies a list of <a href="../../../../../org/apache/juneau/rest/ResponseHandler.html" title="interface in org.apache.juneau.rest"><code>ResponseHandler</code></a> classes that know how to convert POJOs returned
by REST methods or set via <a href="../../../../../org/apache/juneau/rest/RestResponse.html#setOutput-java.lang.Object-"><code>RestResponse.setOutput(Object)</code></a> into appropriate
HTTP responses.
@@ -587,7 +599,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/RestResource.html#line.209">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/RestResource.html#line.210">encoders</a></pre>
<div class="block">Specifies a list of <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>Encoder</code></a> to associate with this servlet.
<p>
These can be used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses.
@@ -619,7 +631,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/RestResource.html#line.234">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/RestResource.html#line.235">defaultRequestHeaders</a></pre>
<div class="block">Specifies default values for request headers.
<p>
Strings are of the format <js>"Header-Name: header-value"</js>.
@@ -656,7 +668,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>defaultResponseHeaders</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.258">defaultResponseHeaders</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.259">defaultResponseHeaders</a></pre>
<div class="block">Specifies default values for response headers.
<p>
Strings are of the format <js>"Header-Name: header-value"</js>.
@@ -692,7 +704,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>children</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/RestResource.html#line.300">children</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/RestResource.html#line.301">children</a></pre>
<div class="block">Defines children of this resource.
<p>
A REST child resource is simply another servlet that is initialized as part of the parent
@@ -746,7 +758,7 @@ 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/RestResource.html#line.313">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/RestResource.html#line.314">path</a></pre>
<div class="block">Identifies the URL subpath relative to the parent resource.
<p>
Typically, this annotation is only applicable to resources defined as children through the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#children--"><code>children()</code></a>
@@ -771,10 +783,10 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>title</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.330">title</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.331">title</a></pre>
<div class="block">Optional servlet title.
<p>
- It is used to populate the Swagger title field and to display on HTML pages.
+ It is used to populate the Swagger title field and as a default value for the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageTitle--"><code>pageTitle()</code></a> value.
This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getServletTitle--"><code>RestRequest.getServletTitle()</code></a> method.
<p>
The default value pulls the label from the <code>label</code> entry in the servlet resource bundle.
@@ -800,10 +812,10 @@ 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/RestResource.html#line.347">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/RestResource.html#line.348">description</a></pre>
<div class="block">Optional servlet description.
<p>
- It is used to populate the Swagger description field and to display on HTML pages.
+ It is used to populate the Swagger description field and as a default value for the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageText--"><code>pageText()</code></a> value.
This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getServletDescription--"><code>RestRequest.getServletDescription()</code></a> method.
<p>
The default value pulls the description from the <code>description</code> entry in the servlet resource bundle.
@@ -829,7 +841,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>termsOfService</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.363">termsOfService</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.364">termsOfService</a></pre>
<div class="block">Optional servlet terms-of-service for this API.
<p>
It is used to populate the Swagger terms-of-service field.
@@ -857,7 +869,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>contact</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.393">contact</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.394">contact</a></pre>
<div class="block">Optional contact information for the exposed API.
<p>
It is used to populate the Swagger contact field and to display on HTML pages.
@@ -899,7 +911,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>license</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.422">license</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.423">license</a></pre>
<div class="block">Optional license information for the exposed API.
<p>
It is used to populate the Swagger license field and to display on HTML pages.
@@ -940,7 +952,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>version</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.438">version</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.439">version</a></pre>
<div class="block">Provides the version of the application API (not to be confused with the specification version).
<p>
It is used to populate the Swagger version field and to display on HTML pages.
@@ -968,7 +980,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/RestResource.html#line.473">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/RestResource.html#line.474">tags</a></pre>
<div class="block">Optional tagging information for the exposed API.
<p>
It is used to populate the Swagger tags field and to display on HTML pages.
@@ -1015,7 +1027,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/RestResource.html#line.502">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/RestResource.html#line.503">externalDocs</a></pre>
<div class="block">Optional external documentation information for the exposed API.
<p>
It is used to populate the Swagger external documentation field and to display on HTML pages.
@@ -1056,7 +1068,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>config</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.513">config</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.514">config</a></pre>
<div class="block">Optional location of configuration file for this servlet.
<p>
The configuration file .
@@ -1079,7 +1091,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>stylesheet</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.563">stylesheet</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.564">stylesheet</a></pre>
<div class="block">The stylesheet to use for HTML views.
<p>
The name is a path to a stylesheet located in either the classpath or working directory.
@@ -1141,7 +1153,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>favicon</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.595">favicon</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.596">favicon</a></pre>
<div class="block">The favicon to use for HTML views.
<p>
The name is a path to an icon file located in either the classpath or working directory in a similar way
@@ -1185,7 +1197,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>staticFiles</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.629">staticFiles</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.630">staticFiles</a></pre>
<div class="block">Defines paths and locations of statically served files.
<p>
This is a JSON map of paths to packages/directories located on either the classpath or working directory.
@@ -1231,7 +1243,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>clientVersionHeader</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.641">clientVersionHeader</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.642">clientVersionHeader</a></pre>
<div class="block">Specifies the HTTP header name used to identify the client version.
<p>
The client version is used to support backwards compatibility for breaking REST interface
@@ -1255,7 +1267,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>resourceResolver</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/RestResourceResolver.html" title="class in org.apache.juneau.rest">RestResourceResolver</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.666">resourceResolver</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/RestResourceResolver.html" title="class in org.apache.juneau.rest">RestResourceResolver</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.667">resourceResolver</a></pre>
<div class="block">Specifies the resolver class to use for resolving child resources by class name.
<p>
The default implementation simply instantiates the class using one of the following constructors:
@@ -1292,7 +1304,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>logger</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/RestLogger.html" title="class in org.apache.juneau.rest">RestLogger</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.676">logger</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/RestLogger.html" title="class in org.apache.juneau.rest">RestLogger</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.677">logger</a></pre>
<div class="block">Specifies the logger class to use for logging.
<p>
The default logger performs basic error logging to the Java logger.
@@ -1314,7 +1326,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>callHandler</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/RestCallHandler.html" title="class in org.apache.juneau.rest">RestCallHandler</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.686">callHandler</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/RestCallHandler.html" title="class in org.apache.juneau.rest">RestCallHandler</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.687">callHandler</a></pre>
<div class="block">Specifies the REST call handler class.
<p>
This class handles the basic lifecycle of an HTTP REST call.
@@ -1336,7 +1348,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota
<ul class="blockList">
<li class="blockList">
<h4>infoProvider</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/RestInfoProvider.html" title="class in org.apache.juneau.rest">RestInfoProvider</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.695">infoProvider</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/RestInfoProvider.html" title="class in org.apache.juneau.rest">RestInfoProvider</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.696">infoProvider</a></pre>
<div class="block">Specifies the class used to retrieve title/description/swagger information about a resource.
<p>
Subclasses can be used to customize the documentation on a resource.
@@ -1351,14 +1363,134 @@ 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/RestResource.html#line.731">pageTitle</a></pre>
+<div class="block">Specifies the page title to use on the HTML view of all pages produced by this resource.
+ <p>
+ This annotation has no effect on any serializers other than <a href="../../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html"><code>HtmlDocSerializer</code></a> and is a shorthand method
+ for setting the <a href="../../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_title"><code>HtmlDocSerializerContext.HTMLDOC_title</code></a> property:
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ properties={
+ <ja>@Property</ja>(name=<jsf>HTMLDOC_title</jsf>, value=<js>"My Resource Page"</js>)
+ }
+ )
+ <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {
+ </p>
+ <p>
+ If not specified, the page title is pulled from one of the following locations:
+ <ol>
+ <li><code>{servletClass}.{methodName}.pageTitle</code> resource bundle value.
+ <li><code>{servletClass}.pageTitle</code> resource bundle value.
+ <li><code><ja>@RestResource</ja>(title)</code> annotation.
+ <li><code>{servletClass}.title</code> resource bundle value.
+ <li><code>info/title</code> entry in swagger file.
+ <ol>
+ <p>
+ This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
+ <p>
+ The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setPageTitle-java.lang.String-"><code>RestConfig.setPageTitle(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setPageTitle-java.lang.Object-"><code>RestResponse.setPageTitle(Object)</code></a> methods.
+ <p class='info'>
+ In most cases, you'll simply want to use the <code>@RestResource(title)</code> annotation to specify the page title.
+ However, this annotation is provided in cases where you want the page title to be different that the one
+ shown in the swagger document.
+ </p>
+ <b>Note:</b> - In most cases, you can</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/RestResource.html#line.767">pageText</a></pre>
+<div class="block">Specifies the page text to use on the HTML view of all pages produced by this resource.
+ <p>
+ The page text is portion of the page immediately under the title and above the links.
+ <p>
+ This annotation has no effect on any serializers other than <a href="../../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html"><code>HtmlDocSerializer</code></a> and is a shorthand method
+ for setting the <a href="../../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_text"><code>HtmlDocSerializerContext.HTMLDOC_text</code></a> property:
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ properties={
+ <ja>@Property</ja>(name=<jsf>HTMLDOC_text</jsf>, value=<js>"This is my awesome resource page"</js>)
+ }
+ )
+ <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {
+ </p>
+ If not specified, the page title is pulled from one of the following locations:
+ <ol>
+ <li><code>{servletClass}.{methodName}.pageText</code> resource bundle value.
+ <li><code>{servletClass}.pageText</code> resource bundle value.
+ <li><code><ja>@RestMethod</ja>(summary)</code> annotation.
+ <li><code>{servletClass}.{methodName}.summary</code> resource bundle value.
+ <li><code>summary</code> entry in swagger file for method.
+ <li><code>{servletClass}.description</code> resource bundle value.
+ <li><code>info/description</code> entry in swagger file.
+ <ol>
+ <p>
+ This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
+ <p>
+ The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setPageText-java.lang.String-"><code>RestConfig.setPageText(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setPageText-java.lang.Object-"><code>RestResponse.setPageText(Object)</code></a> methods.
+ <p class='info'>
+ In most cases, you'll simply want to use the <code>@RestResource(description)</code> or <code>@RestMethod(summary)</code> annotations to specify the page text.
+ However, this annotation is provided in cases where you want the text to be different that the values shown in the swagger document.
+ </p></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/RestResource.html#line.700">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/RestResource.html#line.797">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.
+ <p>
+ This annotation has no effect on any serializers other than <a href="../../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html"><code>HtmlDocSerializer</code></a> and is a shorthand method
+ for setting the <a href="../../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_text"><code>HtmlDocSerializerContext.HTMLDOC_text</code></a> property:
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ properties={
+ <ja>@Property</ja>(name=<jsf>HTMLDOC_links</jsf>, value=<js>"{up:'$R{requestParentURI}',options:'?method=OPTIONS'}"</js>)
+ }
+ )
+ <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {
+ </p>
+ <p>
+ The format of this value is a lax-JSON string of key/value pairs where the keys are the link text and the values are relative (to the servlet) or
+ absolute URLs.
+ If not specified, the page title is pulled from one of the following locations:
+ <ol>
+ <li><code>{servletClass}.{methodName}.pageLinks</code> resource bundle value.
+ <li><code>{servletClass}.pageLinks</code> resource bundle value.
+ <ol>
+ <p>
+ This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
+ <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>
<dd>""</dd>