http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html b/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html index 971d6d7..d697c65 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.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#METHOD"; title="class or interface in java.lang.annotation">METHOD</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/RestMethod.html#line.37">RestMethod</a></pre> +public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.36">RestMethod</a></pre> <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. <p> Refer to <a class='doclink' href='../package-summary.html#TOC'>org.apache.juneau.rest</a> doc for information on using this class.</div> @@ -276,13 +276,6 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <div class="block">Provides swagger-specific metadata on this method.</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/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/RestMethod.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> </li> </ul> @@ -304,7 +297,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>name</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.80">name</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.79">name</a></pre> <div class="block">REST method name. <p> @@ -359,7 +352,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/RestMethod.html#line.103">path</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.102">path</a></pre> <div class="block">Optional path pattern for the specified method. <p> @@ -394,7 +387,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>priority</h4> -<pre>public abstract int <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.114">priority</a></pre> +<pre>public abstract int <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.113">priority</a></pre> <div class="block">URL path pattern priority. <p> @@ -417,7 +410,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>guards</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest">RestGuard</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.127">guards</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest">RestGuard</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.126">guards</a></pre> <div class="block">Method guards. <p> @@ -442,7 +435,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>converters</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest">RestConverter</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.144">converters</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest">RestConverter</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.143">converters</a></pre> <div class="block">Method response converters. <p> @@ -471,7 +464,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>matchers</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestMatcher.html" title="class in org.apache.juneau.rest">RestMatcher</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.159">matchers</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestMatcher.html" title="class in org.apache.juneau.rest">RestMatcher</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.158">matchers</a></pre> <div class="block">Method matchers. <p> @@ -498,7 +491,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>serializers</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.187">serializers</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.186">serializers</a></pre> <div class="block">Overrides the list of serializers assigned at the method level. <p> @@ -538,7 +531,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>serializersInherit</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.211">serializersInherit</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.210">serializersInherit</a></pre> <div class="block">Used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#serializers--"><code>serializers()</code></a> to identify what class-level settings are inherited by the method serializer group. @@ -574,7 +567,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>parsers</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.239">parsers</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.238">parsers</a></pre> <div class="block">Overrides the list of parsers assigned at the method level. <p> @@ -614,7 +607,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>parsersInherit</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.263">parsersInherit</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.262">parsersInherit</a></pre> <div class="block">Used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#parsers--"><code>parsers()</code></a> to identify what class-level settings are inherited by the method parser group. @@ -650,7 +643,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>encoders</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders">Encoder</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.293">encoders</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders">Encoder</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.292">encoders</a></pre> <div class="block">Appends to the list of <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>encoders</code></a> specified on the servlet. <p> @@ -692,7 +685,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>inheritEncoders</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.298">inheritEncoders</a></pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.297">inheritEncoders</a></pre> <div class="block">Specifies whether the method should inherit encoders from the servlet.</div> <dl> <dt>Default:</dt> @@ -709,7 +702,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>properties</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">Property</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.307">properties</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">Property</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.306">properties</a></pre> <div class="block">Same as <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#properties--"><code>RestResource.properties()</code></a>, except defines property values by default when this method is called. <p> @@ -730,7 +723,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>flags</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.315">flags</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.314">flags</a></pre> <div class="block">Shortcut for setting <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#properties--"><code>properties()</code></a> of simple boolean types. <p> @@ -750,7 +743,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>beanFilters</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.320">beanFilters</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.319">beanFilters</a></pre> <div class="block">Appends the specified bean filters to all serializers and parsers used by this method.</div> <dl> <dt>Default:</dt> @@ -767,7 +760,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>pojoSwaps</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.325">pojoSwaps</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.324">pojoSwaps</a></pre> <div class="block">Appends the specified POJO swaps to all serializers and parsers used by this method.</div> <dl> <dt>Default:</dt> @@ -784,7 +777,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>bpIncludes</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.364">bpIncludes</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.363">bpIncludes</a></pre> <div class="block">Shortcut for specifying the <a href="../../../../../org/apache/juneau/BeanContext.html#BEAN_includeProperties"><code>BeanContext.BEAN_includeProperties</code></a> property on all serializers. <p> @@ -835,7 +828,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>bpExcludes</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.402">bpExcludes</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.401">bpExcludes</a></pre> <div class="block">Shortcut for specifying the <a href="../../../../../org/apache/juneau/BeanContext.html#BEAN_excludeProperties"><code>BeanContext.BEAN_excludeProperties</code></a> property on all serializers. <p> @@ -885,7 +878,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>defaultRequestHeaders</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.436">defaultRequestHeaders</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.435">defaultRequestHeaders</a></pre> <div class="block">Specifies default values for request headers. <p> @@ -931,7 +924,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>defaultQuery</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.459">defaultQuery</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.458">defaultQuery</a></pre> <div class="block">Specifies default values for query parameters. <p> @@ -966,7 +959,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>defaultFormData</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.483">defaultFormData</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.482">defaultFormData</a></pre> <div class="block">Specifies default values for form-data parameters. <p> @@ -1021,7 +1014,8 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota servlet resource bundle. (e.g. <js>"MyClass.myMethod.summary = foo"</js> or <js>"myMethod.summary = foo"</js>). <p> - This field value can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/paths/{path}/{method}/summary</code>.</div> @@ -1040,7 +1034,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>description</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.536">description</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.537">description</a></pre> <div class="block">Optional description for the exposed API. <p> @@ -1060,7 +1054,8 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <js>"myMethod.description = foo"</js>). <p> - This field value can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/paths/{path}/{method}/description</code>.</div> @@ -1079,7 +1074,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>clientVersion</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.602">clientVersion</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.603">clientVersion</a></pre> <div class="block">Specifies whether this method can be called based on the client version. <p> @@ -1151,34 +1146,13 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="widgets--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<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/RestMethod.html#line.611">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> - Widgets are inherited from parent to child, but can be overridden by reusing the widget name.</div> -<dl> -<dt>Default:</dt> -<dd>{}</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> <li class="blockList"><a name="swagger--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>swagger</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.html" title="annotation in org.apache.juneau.rest.annotation">MethodSwagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.616">swagger</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.html" title="annotation in org.apache.juneau.rest.annotation">MethodSwagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.608">swagger</a></pre> <div class="block">Provides swagger-specific metadata on this method.</div> <dl> <dt>Default:</dt> @@ -1195,7 +1169,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <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/RestMethod.html#line.624">htmldoc</a></pre> +<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/RestMethod.html#line.616">htmldoc</a></pre> <div class="block">Provides HTML-doc-specific metadata on this method. <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/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 81913c1..0d31fc8 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.49">RestResource</a></pre> +public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.48">RestResource</a></pre> <div class="block">Used to denote that a class is a REST resource and to associate metadata on it. <p> @@ -288,29 +288,28 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </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#siteName--">siteName</a></span></code> +<div class="block">Optional site name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/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="../../../../../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"> +<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#title--">title</a></span></code> <div class="block">Optional servlet title.</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/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> </li> </ul> @@ -332,7 +331,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.69">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.68">messages</a></pre> <div class="block">Identifies the location of the resource bundle for this class. <p> @@ -364,7 +363,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.86">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.85">guards</a></pre> <div class="block">Class-level guards. <p> @@ -393,7 +392,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.107">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.106">converters</a></pre> <div class="block">Class-level converters. <p> @@ -426,7 +425,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.128">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.127">beanFilters</a></pre> <div class="block">Class-level bean filters. <p> @@ -459,7 +458,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.148">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.147">pojoSwaps</a></pre> <div class="block">Class-level POJO swaps. <p> @@ -491,7 +490,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>paramResolvers</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/RestParam.html" title="class in org.apache.juneau.rest">RestParam</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.184">paramResolvers</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/RestParam.html" title="class in org.apache.juneau.rest">RestParam</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.183">paramResolvers</a></pre> <div class="block">Class-level Java method parameter resolvers. <p> @@ -539,7 +538,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.223">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.222">properties</a></pre> <div class="block">Class-level properties. <p> @@ -590,7 +589,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>flags</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.231">flags</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.230">flags</a></pre> <div class="block">Shortcut for setting <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#properties--"><code>properties()</code></a> of simple boolean types. <p> @@ -610,7 +609,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.243">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.242">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> @@ -634,7 +633,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.255">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.254">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> @@ -658,7 +657,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.268">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.267">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. @@ -683,7 +682,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.292">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.291">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> @@ -719,7 +718,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.323">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.322">defaultRequestHeaders</a></pre> <div class="block">Specifies default values for request headers. <p> @@ -762,7 +761,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.354">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.353">defaultResponseHeaders</a></pre> <div class="block">Specifies default values for response headers. <p> @@ -805,7 +804,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.403">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.402">children</a></pre> <div class="block">Defines children of this resource. <p> @@ -866,7 +865,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.420">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.419">path</a></pre> <div class="block">Identifies the URL subpath relative to the parent resource. <p> @@ -889,17 +888,45 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </li> </ul> <ul class="blockList"> +<li class="blockList"><a name="siteName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>siteName</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.435">siteName</a></pre> +<div class="block">Optional site name. + + <p> + Used as a label for the overall site. + This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getSiteName--"><code>RestRequest.getSiteName()</code></a> method. + + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. + + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getSiteName-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getSiteName(RestRequest)</code></a> method.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> <li class="blockList"><a name="title--"> <!-- --> </a> <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.442">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.458">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/HtmlDoc.html#title--"><code>HtmlDoc.title()</code></a> value. + It is used to populate the Swagger title field. This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getServletTitle--"><code>RestRequest.getServletTitle()</code></a> method. <p> @@ -907,7 +934,8 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota (e.g. <js>"title = foo"</js> or <js>"MyServlet.title = foo"</js>). <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/info/title</code>. @@ -929,12 +957,11 @@ 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.465">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.481">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/HtmlDoc.html#description--"><code>HtmlDoc.description()</code></a> - value. + It is used to populate the Swagger description field. This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getServletDescription--"><code>RestRequest.getServletDescription()</code></a> method. <p> @@ -942,7 +969,8 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota (e.g. <js>"description = foo"</js> or <js>"MyServlet.description = foo"</js>). <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/info/description</code>. @@ -964,14 +992,15 @@ 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.479">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.496">config</a></pre> <div class="block">Optional location of configuration file for this servlet. <p> The configuration file . <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setConfigFile-org.apache.juneau.ini.ConfigFile-"><code>RestConfig.setConfigFile(ConfigFile)</code></a> method.</div> @@ -990,7 +1019,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.517">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.534">favicon</a></pre> <div class="block">The favicon to use for HTML views. <p> @@ -1040,7 +1069,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.556">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.573">staticFiles</a></pre> <div class="block">Defines paths and locations of statically served files. <p> @@ -1091,7 +1120,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.571">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.588">clientVersionHeader</a></pre> <div class="block">Specifies the HTTP header name used to identify the client version. <p> @@ -1118,7 +1147,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.602">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.619">resourceResolver</a></pre> <div class="block">Specifies the resolver class to use for resolving child resources by class name. <p> @@ -1161,7 +1190,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.615">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.632">logger</a></pre> <div class="block">Specifies the logger class to use for logging. <p> @@ -1186,7 +1215,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.628">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.645">callHandler</a></pre> <div class="block">Specifies the REST call handler class. <p> @@ -1211,7 +1240,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.640">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.657">infoProvider</a></pre> <div class="block">Specifies the class used to retrieve title/description/swagger information about a resource. <p> @@ -1235,7 +1264,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <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.645">serializerListener</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/SerializerListener.html" title="class in org.apache.juneau.serializer">SerializerListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.662">serializerListener</a></pre> <div class="block">Specifies the serializer listener class to use for listening for non-fatal errors.</div> <dl> <dt>Default:</dt> @@ -1252,7 +1281,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <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.650">parserListener</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/ParserListener.html" title="class in org.apache.juneau.parser">ParserListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.667">parserListener</a></pre> <div class="block">Specifies the parser listener class to use for listening for non-fatal errors.</div> <dl> <dt>Default:</dt> @@ -1263,37 +1292,13 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="widgets--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<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.662">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> - Widgets are inherited from parent to child, but can be overridden by reusing the widget name. - - <p> - 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> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> <li class="blockList"><a name="swagger--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <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.687">swagger</a></pre> +<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.692">swagger</a></pre> <div class="block">Provides swagger-specific metadata on this resource. <p> @@ -1330,7 +1335,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <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.732">htmldoc</a></pre> +<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.736">htmldoc</a></pre> <div class="block">Provides HTML-doc-specific metadata on this method. <p> @@ -1344,6 +1349,11 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota // "servlet:/..." URIs are relative to the servlet URI. // "$C{...}" variables are pulled from the config file.</jc> htmldoc=<ja>@HtmlDoc</ja>( + <jc>// Widgets for $W variables.</jc> + widgets={ + PoweredByJuneau.<jk>class</jk>, + ContentTypeLinks.<jk>class</jk> + } links={ <js>"up: request:/.."</js>, <js>"options: servlet:/?method=OPTIONS"</js>, @@ -1359,17 +1369,11 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <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>" $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> - } + footer=<js>"$W{PoweredByJuneau}"</js> + ) ) </p></div> <dl> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html b/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html index 1c461e8..7d7205d 100644 --- a/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html +++ b/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html @@ -137,7 +137,7 @@ var activeTableTab = "activeTableTab"; <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#htmldoc--">htmldoc</a>=, <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#favicon--">favicon</a>="htdocs/juneau.png", <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#staticFiles--">staticFiles</a>="{htdocs:\'htdocs\',styles:\'styles\'}") -public abstract class <a href="../../../../../src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html#line.254">RestServletJenaDefault</a> +public abstract class <a href="../../../../../src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html#line.258">RestServletJenaDefault</a> extends <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a></pre> <div class="block">Subclass of <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>RestServlet</code></a> with default sets of serializers and parsers that include RDF support. @@ -410,7 +410,7 @@ extends <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title=" <ul class="blockListLast"> <li class="blockList"> <h4>RestServletJenaDefault</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html#line.254">RestServletJenaDefault</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html#line.258">RestServletJenaDefault</a>()</pre> </li> </ul> </li> @@ -430,9 +430,9 @@ extends <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title=" <pre><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation">@RestMethod</a>(<a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#name--">name</a>="OPTIONS", <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#path--">path</a>="/*", <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#htmldoc--">htmldoc</a>=, - <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#summary--">summary</a>="Resource options", - <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#description--">description</a>="Swagger documentation") -public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html#line.275">getOptions</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</pre> + <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#summary--">summary</a>="Swagger documentation", + <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#description--">description</a>="Auto-generated swagger documentation for this resource") +public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html#line.278">getOptions</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</pre> <div class="block">[OPTIONS /*] - Show resource options.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt>
