http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/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 c9a79eb..e229ee6 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html @@ -151,47 +151,35 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </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#contact--">contact</a></span></code> -<div class="block">Optional contact information for the exposed API.</div> -</td> -</tr> -<tr class="altColor"> <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/RestConverter.html" title="interface in org.apache.juneau.rest">RestConverter</a>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#converters--">converters</a></span></code> <div class="block">Class-level converters.</div> </td> </tr> -<tr class="rowColor"> +<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#defaultRequestHeaders--">defaultRequestHeaders</a></span></code> <div class="block">Specifies default values for request headers.</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#defaultResponseHeaders--">defaultResponseHeaders</a></span></code> <div class="block">Specifies default values for response headers.</div> </td> </tr> -<tr class="rowColor"> +<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#description--">description</a></span></code> <div class="block">Optional servlet description.</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/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>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#encoders--">encoders</a></span></code> <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.</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#externalDocs--">externalDocs</a></span></code> -<div class="block">Optional external documentation information for the exposed API.</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#favicon--">favicon</a></span></code> @@ -205,15 +193,15 @@ 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/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>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#infoProvider--">infoProvider</a></span></code> -<div class="block">Specifies the class used to retrieve title/description/swagger information about a resource.</div> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation">HtmlDoc</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#htmldoc--">htmldoc</a></span></code> +<div class="block">Provides HTML-doc-specific metadata on this method.</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#license--">license</a></span></code> -<div class="block">Optional license information for the exposed API.</div> +<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/RestInfoProvider.html" title="class in org.apache.juneau.rest">RestInfoProvider</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#infoProvider--">infoProvider</a></span></code> +<div class="block">Specifies the class used to retrieve title/description/swagger information about a resource.</div> </td> </tr> <tr class="altColor"> @@ -229,66 +217,48 @@ 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#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/rest/RestParam.html" title="class in org.apache.juneau.rest">RestParam</a>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#paramResolvers--">paramResolvers</a></span></code> <div class="block">Class-level Java method parameter resolvers.</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/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/parser/ParserListener.html" title="class in org.apache.juneau.parser">ParserListener</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#parserListener--">parserListener</a></span></code> <div class="block">Specifies the parser listener class to use for listening for non-fatal errors.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <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> <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.</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#path--">path</a></span></code> <div class="block">Identifies the URL subpath relative to the parent resource.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <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><?>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pojoSwaps--">pojoSwaps</a></span></code> <div class="block">Class-level POJO swaps.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">Property</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#properties--">properties</a></span></code> <div class="block">Class-level properties.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <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/RestResourceResolver.html" title="class in org.apache.juneau.rest">RestResourceResolver</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#resourceResolver--">resourceResolver</a></span></code> <div class="block">Specifies the resolver class to use for resolving child resources by class name.</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/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>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#responseHandlers--">responseHandlers</a></span></code> <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 @@ -296,40 +266,34 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota HTTP responses.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <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/serializer/SerializerListener.html" title="class in org.apache.juneau.serializer">SerializerListener</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#serializerListener--">serializerListener</a></span></code> <div class="block">Specifies the serializer listener class to use for listening for non-fatal errors.</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/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>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#serializers--">serializers</a></span></code> <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.</div> </td> </tr> -<tr class="rowColor"> +<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#staticFiles--">staticFiles</a></span></code> <div class="block">Defines paths and locations of statically served files.</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#stylesheet--">stylesheet</a></span></code> <div class="block">The stylesheet to use for HTML views.</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#tags--">tags</a></span></code> -<div class="block">Optional tagging information for the exposed API.</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#termsOfService--">termsOfService</a></span></code> -<div class="block">Optional servlet terms-of-service for this API.</div> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/annotation/ResourceSwagger.html" title="annotation in org.apache.juneau.rest.annotation">ResourceSwagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#swagger--">swagger</a></span></code> +<div class="block">Provides swagger-specific metadata on this resource.</div> </td> </tr> <tr class="rowColor"> @@ -339,9 +303,10 @@ 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#version--">version</a></span></code> -<div class="block">Provides the version of the application API (not to be confused with the specification version).</div> +<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/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a>>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#widgets--">widgets</a></span></code> +<div class="block">Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly + generate arbitrary replacement text.</div> </td> </tr> </table> @@ -848,7 +813,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <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">title</a></pre> <div class="block">Optional servlet title. <p> - 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. + It is used to populate the Swagger title field and as a default value for the <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#title--"><code>HtmlDoc.title()</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. @@ -877,7 +842,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <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.380">description</a></pre> <div class="block">Optional servlet description. <p> - 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. + It is used to populate the Swagger description field and as a default value for the <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#description--"><code>HtmlDoc.description()</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. @@ -897,240 +862,13 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="termsOfService--"> -<!-- --> -</a> -<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.396">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. - <p> - The default value pulls the description from the <code>termsOfService</code> entry in the servlet resource bundle. - (e.g. <js>"termsOfService = foo"</js> or <js>"MyServlet.termsOfService = foo"</js>). - <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). - <p> - Corresponds to the swagger field <code>/info/termsOfService</code>. - <p> - The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getTermsOfService-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getTermsOfService(RestRequest)</code></a> method.</div> -<dl> -<dt>Default:</dt> -<dd>""</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="contact--"> -<!-- --> -</a> -<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.426">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. - <p> - A simplified JSON string with the following fields: - <p class='bcode'> - { - name: string, - url: string, - email: string - } - </p> - <p> - The default value pulls the description from the <code>contact</code> entry in the servlet resource bundle. - (e.g. <js>"contact = {name:'John Smith',email:'[email protected]'}"</js> or <js>"MyServlet.contact = {name:'John Smith',email:'[email protected]'}"</js>). - - <h5 class='section'>Example:</h5> - <p class='bcode'> - <ja>@RestResource</ja>(contact=<js>"{name:'John Smith',email:'[email protected]'}"</js>) - </p> - <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). - <p> - Corresponds to the swagger field <code>/info/contact</code>. - <p> - The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getContact-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getContact(RestRequest)</code></a> method.</div> -<dl> -<dt>Default:</dt> -<dd>""</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="license--"> -<!-- --> -</a> -<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.455">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. - <p> - A simplified JSON string with the following fields: - <p class='bcode'> - { - name: string, - url: string - } - </p> - <p> - The default value pulls the description from the <code>license</code> entry in the servlet resource bundle. - (e.g. <js>"license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js> or <js>"MyServlet.license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>). - - <h5 class='section'>Example:</h5> - <p class='bcode'> - <ja>@RestResource</ja>(license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>) - </p> - <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). - <p> - Corresponds to the swagger field <code>/info/license</code>. - <p> - The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getLicense-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getLicense(RestRequest)</code></a> method.</div> -<dl> -<dt>Default:</dt> -<dd>""</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="version--"> -<!-- --> -</a> -<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.471">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. - <p> - The default value pulls the description from the <code>version</code> entry in the servlet resource bundle. - (e.g. <js>"version = 2.0"</js> or <js>"MyServlet.version = 2.0"</js>). - <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). - <p> - Corresponds to the swagger field <code>/info/version</code>. - <p> - The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getVersion-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getVersion(RestRequest)</code></a> method.</div> -<dl> -<dt>Default:</dt> -<dd>""</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="tags--"> -<!-- --> -</a> -<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.506">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. - <p> - A simplified JSON string with the following fields: - <p class='bcode'> - [ - { - name: string, - description: string, - externalDocs: { - description: string, - url: string - } - } - ] - </p> - <p> - The default value pulls the description from the <code>tags</code> entry in the servlet resource bundle. - (e.g. <js>"tags = [{name:'Foo',description:'Foobar'}]"</js> or <js>"MyServlet.tags = [{name:'Foo',description:'Foobar'}]"</js>). - - <h5 class='section'>Example:</h5> - <p class='bcode'> - <ja>@RestResource</ja>(tags=<js>"[{name:'Foo',description:'Foobar'}]"</js>) - </p> - <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). - <p> - Corresponds to the swagger field <code>/tags</code>. - <p> - The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getTags-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getTags(RestRequest)</code></a> method.</div> -<dl> -<dt>Default:</dt> -<dd>""</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="externalDocs--"> -<!-- --> -</a> -<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.535">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. - <p> - A simplified JSON string with the following fields: - <p class='bcode'> - { - description: string, - url: string - } - </p> - <p> - The default value pulls the description from the <code>externalDocs</code> entry in the servlet resource bundle. - (e.g. <js>"externalDocs = {url:'http://juneau.apache.org'}"</js> or <js>"MyServlet.externalDocs = {url:'http://juneau.apache.org'}"</js>). - - <h5 class='section'>Example:</h5> - <p class='bcode'> - <ja>@RestResource</ja>(externalDocs=<js>"{url:'http://juneau.apache.org'}"</js>) - </p> - <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). - <p> - Corresponds to the swagger field <code>/tags</code>. - <p> - The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getExternalDocs-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getExternalDocs(RestRequest)</code></a> method.</div> -<dl> -<dt>Default:</dt> -<dd>""</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> <li class="blockList"><a name="config--"> <!-- --> </a> <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.546">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.391">config</a></pre> <div class="block">Optional location of configuration file for this servlet. <p> The configuration file . @@ -1153,7 +891,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.596">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.441">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. @@ -1215,7 +953,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.628">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.473">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 @@ -1259,7 +997,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.662">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.507">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. @@ -1305,7 +1043,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.674">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.519">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 @@ -1329,7 +1067,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.699">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.544">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: @@ -1366,7 +1104,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.709">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.554">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. @@ -1388,7 +1126,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.719">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.564">callHandler</a></pre> <div class="block">Specifies the REST call handler class. <p> This class handles the basic lifecycle of an HTTP REST call. @@ -1410,7 +1148,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.728">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.573">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. @@ -1425,174 +1163,143 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="pageTitle--"> +<li class="blockList"><a name="serializerListener--"> <!-- --> </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.763">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. - <ul class='doctree'> - <li 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. - </ul></div> +<h4>serializerListener</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/SerializerListener.html" title="class in org.apache.juneau.serializer">SerializerListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.578">serializerListener</a></pre> +<div class="block">Specifies the serializer listener class to use for listening for non-fatal errors.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>org.apache.juneau.serializer.SerializerListener.class</dd> </dl> </li> </ul> </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="pageText--"> +<li class="blockList"><a name="parserListener--"> <!-- --> </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.800">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. - <ul class='doctree'> - <li 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. - </ul></div> +<h4>parserListener</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/ParserListener.html" title="class in org.apache.juneau.parser">ParserListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.583">parserListener</a></pre> +<div class="block">Specifies the parser listener class to use for listening for non-fatal errors.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>org.apache.juneau.parser.ParserListener.class</dd> </dl> </li> </ul> </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="pageLinks--"> +<li class="blockList"><a name="widgets--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>pageLinks</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.832">pageLinks</a></pre> -<div class="block">Specifies the page hyperlinks to use on the HTML view of all pages produced by this resource. +<h4>widgets</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/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.593">widgets</a></pre> +<div class="block">Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly + generate arbitrary replacement text. <p> - The page links is positioned immediately under the title and text. + Widgets are inherited from parent to child, but can be overridden by reusing the widget name. <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:'request:/..',options:'servlet:/?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> - This field can also use URIs of any support type in <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a>. - <p> - The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setPageLinks-java.lang.String-"><code>RestConfig.setPageLinks(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setPageLinks-java.lang.Object-"><code>RestResponse.setPageLinks(Object)</code></a> methods.</div> + See <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#htmldoc--"><code>htmldoc()</code></a> for an example of usage.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>{}</dd> </dl> </li> </ul> </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="serializerListener--"> +<li class="blockList"><a name="swagger--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>serializerListener</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/SerializerListener.html" title="class in org.apache.juneau.serializer">SerializerListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.837">serializerListener</a></pre> -<div class="block">Specifies the serializer listener class to use for listening for non-fatal errors.</div> +<h4>swagger</h4> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/ResourceSwagger.html" title="annotation in org.apache.juneau.rest.annotation">ResourceSwagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.617">swagger</a></pre> +<div class="block">Provides swagger-specific metadata on this resource. + <p> + Used to populate the auto-generated OPTIONS swagger documentation. + + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + path=<js>"/addressBook"</js>, + + <jc>// Swagger info.</jc> + swagger=<ja>@ResourceSwagger</ja>( + contact=<js>"{name:'John Smith',email:'[email protected]'}"</js>, + license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>, + version=<js>"2.0"</js>, + termsOfService=<js>"You're on your own."</js>, + tags=<js>"[{name:'Java',description:'Java utility',externalDocs:{description:'Home page',url:'http://juneau.apache.org'}}]"</js>, + externalDocs=<js>"{description:'Home page',url:'http://juneau.apache.org'}"</js> + ) + ) + </p></div> <dl> <dt>Default:</dt> -<dd>org.apache.juneau.serializer.SerializerListener.class</dd> +<dd>@org.apache.juneau.rest.annotation.ResourceSwagger</dd> </dl> </li> </ul> </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="parserListener--"> +<li class="blockList"><a name="htmldoc--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> -<h4>parserListener</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/ParserListener.html" title="class in org.apache.juneau.parser">ParserListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.842">parserListener</a></pre> -<div class="block">Specifies the parser listener class to use for listening for non-fatal errors.</div> +<h4>htmldoc</h4> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation">HtmlDoc</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.656">htmldoc</a></pre> +<div class="block">Provides HTML-doc-specific metadata on this method. + <p> + Used to customize the output from the HTML Doc serializer. + <p class='bcode'> + <ja>@RestResource</ja>( + path=<js>"/addressBook"</js>, + + <jc>// Links on the HTML rendition page. + // "request:/..." URIs are relative to the request URI. + // "servlet:/..." URIs are relative to the servlet URI. + // "$C{...}" variables are pulled from the config file.</jc> + htmldoc=<ja>@HtmlDoc</ja>( + links=<js>"{up:'request:/..',options:'servlet:/?method=OPTIONS',source:'$C{Source/gitHub}/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java'}"</js>, + aside=<js>""</js> + + <js>"<div style='max-width:400px;min-width:200px'>"</js> + + <js>" <p>Proof-of-concept resource that shows off the capabilities of working with POJO resources.</p>"</js> + + <js>" <p>Provides examples of: </p>"</js> + + <js>" <ul>"</js> + + <js>" <li>XML and RDF namespaces"</js> + + <js>" <li>Swagger documentation"</js> + + <js>" <li>Widgets"</js> + + <js>" </ul>"</js> + + <js>" <p style='text-weight:bold;text-decoration:underline;'>Available Content Types</p>"</js> + + <js>" $W{contentTypeLinks}"</js> + + <js>"</div>"</js>, + footer=<js>"$W{poweredByJuneau}"</js> + ), + + <jc>// Widgets for $W variables above.</jc> + widgets={ + PoweredByJuneauWidget.<jk>class</jk>, + ContentTypeLinksWidget.<jk>class</jk> + } + ) + </p></div> <dl> <dt>Default:</dt> -<dd>org.apache.juneau.parser.ParserListener.class</dd> +<dd>@org.apache.juneau.rest.annotation.HtmlDoc</dd> </dl> </li> </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/rest/annotation/package-frame.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/package-frame.html b/content/site/apidocs/org/apache/juneau/rest/annotation/package-frame.html index 200645c..3836df2 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/package-frame.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/package-frame.html @@ -22,14 +22,17 @@ <li><a href="HasFormData.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">HasFormData</a></li> <li><a href="HasQuery.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">HasQuery</a></li> <li><a href="Header.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">Header</a></li> +<li><a href="HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">HtmlDoc</a></li> <li><a href="Messages.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">Messages</a></li> <li><a href="Method.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">Method</a></li> +<li><a href="MethodSwagger.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">MethodSwagger</a></li> <li><a href="Parameter.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">Parameter</a></li> <li><a href="Path.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">Path</a></li> <li><a href="PathRemainder.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">PathRemainder</a></li> <li><a href="Properties.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">Properties</a></li> <li><a href="Property.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">Property</a></li> <li><a href="Query.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">Query</a></li> +<li><a href="ResourceSwagger.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">ResourceSwagger</a></li> <li><a href="Response.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">Response</a></li> <li><a href="RestMethod.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">RestMethod</a></li> <li><a href="RestResource.html" title="annotation in org.apache.juneau.rest.annotation" target="classFrame">RestResource</a></li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/rest/annotation/package-summary.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/package-summary.html b/content/site/apidocs/org/apache/juneau/rest/annotation/package-summary.html index 8027d28..5fd71ed 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/package-summary.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/package-summary.html @@ -139,23 +139,35 @@ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation">HtmlDoc</a></td> +<td class="colLast"> +<div class="block">Contains all the configurable annotations for the <a href="../../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html"><code>HtmlDocSerializer</code></a>.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/annotation/Messages.html" title="annotation in org.apache.juneau.rest.annotation">Messages</a></td> <td class="colLast"> <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 the resource bundle for the request locale.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/annotation/Method.html" title="annotation in org.apache.juneau.rest.annotation">Method</a></td> <td class="colLast"> <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 the HTTP method.</div> </td> </tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.html" title="annotation in org.apache.juneau.rest.annotation">MethodSwagger</a></td> +<td class="colLast"> +<div class="block">Extended annotation for <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#swagger--"><code>RestMethod.swagger()</code></a>.</div> +</td> +</tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation">Parameter</a></td> <td class="colLast"> -<div class="block">Annotation used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#parameters--"><code>RestMethod.parameters()</code></a> to identify content and header descriptions +<div class="block">Annotation used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.html#parameters--"><code>MethodSwagger.parameters()</code></a> to identify content and header descriptions on specific method requests.</div> </td> </tr> @@ -194,18 +206,24 @@ </td> </tr> <tr class="rowColor"> -<td class="colFirst"><a href="../../../../../org/apache/juneau/rest/annotation/Response.html" title="annotation in org.apache.juneau.rest.annotation">Response</a></td> +<td class="colFirst"><a href="../../../../../org/apache/juneau/rest/annotation/ResourceSwagger.html" title="annotation in org.apache.juneau.rest.annotation">ResourceSwagger</a></td> <td class="colLast"> -<div class="block">Annotation used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#responses--"><code>RestMethod.responses()</code></a> to identify possible responses by the method.</div> +<div class="block">Extended annotation for <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#swagger--"><code>@RestResource.swagger()</code></a>.</div> </td> </tr> <tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/juneau/rest/annotation/Response.html" title="annotation in org.apache.juneau.rest.annotation">Response</a></td> +<td class="colLast"> +<div class="block">Annotation used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.html#responses--"><code>MethodSwagger.responses()</code></a> to identify possible responses by the method.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation">RestMethod</a></td> <td class="colLast"> <div class="block">Identifies a REST Java method on a <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>RestServlet</code></a> implementation class.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html" title="annotation in org.apache.juneau.rest.annotation">RestResource</a></td> <td class="colLast"> <div class="block">Used to denote that a class is a REST resource and to associate metadata on it.</div> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/rest/annotation/package-tree.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/package-tree.html b/content/site/apidocs/org/apache/juneau/rest/annotation/package-tree.html index 051a778..aba06cf 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/package-tree.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/package-tree.html @@ -81,14 +81,17 @@ <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">RestResource</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">RestMethod</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/Response.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Response</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> +<li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/ResourceSwagger.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">ResourceSwagger</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/Query.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Query</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Property</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/Properties.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Properties</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/PathRemainder.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">PathRemainder</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/Path.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Path</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Parameter</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> +<li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">MethodSwagger</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/Method.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Method</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/Messages.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Messages</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> +<li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">HtmlDoc</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/Header.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Header</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/HasQuery.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">HasQuery</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li> <li type="circle">org.apache.juneau.rest.annotation.<a href="../../../../../org/apache/juneau/rest/annotation/HasFormData.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">HasFormData</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>)</li>
