http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/rest/annotation/FormData.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/FormData.html b/content/site/apidocs/org/apache/juneau/rest/annotation/FormData.html index 7d8faa8..a92287d 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/FormData.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/FormData.html @@ -123,7 +123,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <h6 class='topic'>Important note concerning FORM posts</h6> <p> - This annotation should not be combined with the <a href="../../../../../org/apache/juneau/rest/annotation/Body.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Body</code></a> annotation or <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getBody-java.lang.Class-"><code>RestRequest.getBody(Class)</code></a> method + This annotation should not be combined with the <a href="../../../../../org/apache/juneau/rest/annotation/Body.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Body</code></a> annotation or <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getBody--"><code>RestRequest.getBody()</code></a> method for <code>application/x-www-form-urlencoded POST</code> posts, since it will trigger the underlying servlet API to parse the body content as key-value pairs resulting in empty content. <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/rest/annotation/HasFormData.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/HasFormData.html b/content/site/apidocs/org/apache/juneau/rest/annotation/HasFormData.html index ec0d2e6..254261f 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/HasFormData.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/HasFormData.html @@ -151,7 +151,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <h6 class='topic'>Important note concerning FORM posts</h6> <p> - This annotation should not be combined with the <a href="../../../../../org/apache/juneau/rest/annotation/Body.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Body</code></a> annotation or <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getBody-java.lang.Class-"><code>RestRequest.getBody(Class)</code></a> method + This annotation should not be combined with the <a href="../../../../../org/apache/juneau/rest/annotation/Body.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Body</code></a> annotation or <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getBody--"><code>RestRequest.getBody()</code></a> method for <code>application/x-www-form-urlencoded POST</code> posts, since it will trigger the underlying servlet API to parse the body content as key-value pairs, resulting in empty content. <p> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/rest/annotation/HasQuery.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/HasQuery.html b/content/site/apidocs/org/apache/juneau/rest/annotation/HasQuery.html index 7ece79d..fb8b8c6 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/HasQuery.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/HasQuery.html @@ -103,7 +103,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota Unlike <a href="../../../../../org/apache/juneau/rest/annotation/HasFormData.html" title="annotation in org.apache.juneau.rest.annotation"><code>@HasFormData</code></a>, using this annotation does not result in the servlet reading the contents of URL-encoded form posts. Therefore, this annotation can be used in conjunction with the <a href="../../../../../org/apache/juneau/rest/annotation/Body.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Body</code></a> annotation - or <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getBody-java.lang.Class-"><code>RestRequest.getBody(Class)</code></a> method for <code>application/x-www-form-urlencoded POST</code> calls. + or <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getBody--"><code>RestRequest.getBody()</code></a> method for <code>application/x-www-form-urlencoded POST</code> calls. <h5 class='section'>Example:</h5> <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/rest/annotation/Query.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Query.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Query.html index 5c657c9..f2cb074 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Query.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Query.html @@ -103,7 +103,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota Unlike <a href="../../../../../org/apache/juneau/rest/annotation/FormData.html" title="annotation in org.apache.juneau.rest.annotation"><code>@FormData</code></a>, using this annotation does not result in the servlet reading the contents of URL-encoded form posts. Therefore, this annotation can be used in conjunction with the <a href="../../../../../org/apache/juneau/rest/annotation/Body.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Body</code></a> annotation - or <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getBody-java.lang.Class-"><code>RestRequest.getBody(Class)</code></a> method for <code>application/x-www-form-urlencoded POST</code> calls. + or <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getBody--"><code>RestRequest.getBody()</code></a> method for <code>application/x-www-form-urlencoded POST</code> calls. <h5 class='section'>Example:</h5> <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/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 501ec6d..12abff3 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html @@ -247,36 +247,42 @@ 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/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"> <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 @@ -284,43 +290,43 @@ 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/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="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#staticFiles--">staticFiles</a></span></code> <div class="block">Defines paths and locations of statically served files.</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#stylesheet--">stylesheet</a></span></code> <div class="block">The stylesheet to use for HTML views.</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#tags--">tags</a></span></code> <div class="block">Optional tagging information for the exposed API.</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#termsOfService--">termsOfService</a></span></code> <div class="block">Optional servlet terms-of-service for this API.</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#title--">title</a></span></code> <div class="block">Optional servlet title.</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#version--">version</a></span></code> <div class="block">Provides the version of the application API (not to be confused with the specification version).</div> @@ -483,13 +489,57 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </li> </ul> <ul class="blockList"> +<li class="blockList"><a name="paramResolvers--"> +<!-- --> +</a> +<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.160">paramResolvers</a></pre> +<div class="block">Class-level Java method parameter resolvers. + <p> + By default, the Juneau framework will automatically Java method parameters of various types (e.g. + <code>RestRequest</code>, <code>Accept</code>, <code>Reader</code>). + This annotation allows you to provide your own resolvers for your own class types that you want resolved. + <p> + For example, if you want to pass in instances of <code>MySpecialObject</code> to your Java method, define + the following resolver: + <p class='bcode'> + <jk>public class</jk> MyRestParam <jk>extends</jk> RestParam { + + <jc>// Must have no-arg constructor!</jc> + <jk>public</jk> MyRestParam() { + <jc>// First two parameters help with Swagger doc generation.</jc> + <jk>super</jk>(<jsf>QUERY</jsf>, <js>"myparam"</js>, MySpecialObject.<jk>class</jk>); + } + + <jc>// The method that creates our object. + // In this case, we're taking in a query parameter and converting it to our object.</jc> + <jk>public</jk> Object resolve(RestRequest req, RestResponse res) <jk>throws</jk> Exception { + <jk>return new</jk> MySpecialObject(req.getQuery().get(<js>"myparam"</js>)); + } + } + </p> + <p> + <b>Note:</b><a href="../../../../../org/apache/juneau/rest/RestParam.html" title="class in org.apache.juneau.rest"><code>RestParam</code></a> classes must have no-arg constructors. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addParamResolvers-java.lang.Class...-"><code>RestConfig.addParamResolvers(Class...)</code></a> method.</div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> <li class="blockList"><a name="properties--"> <!-- --> </a> <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.161">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.193">properties</a></pre> <div class="block">Class-level properties. <p> Shortcut for specifying class-level properties on this servlet to the objects returned by the following methods: @@ -534,7 +584,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.170">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.202">serializers</a></pre> <div class="block">Specifies a list of <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializer</code></a> classes to add to the list of serializers available for this servlet. <p> This annotation can only be used on <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializer</code></a> classes that have no-arg constructors. @@ -555,7 +605,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.179">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.211">parsers</a></pre> <div class="block">Specifies a list of <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser"><code>Parser</code></a> classes to add to the list of parsers available for this servlet. <p> This annotation can only be used on <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser"><code>Parser</code></a> classes that have no-arg constructors. @@ -576,7 +626,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.190">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.222">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. @@ -599,7 +649,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.210">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.242">encoders</a></pre> <div class="block">Specifies a list of <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>Encoder</code></a> to associate with this servlet. <p> These can be used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses. @@ -631,7 +681,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.235">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.267">defaultRequestHeaders</a></pre> <div class="block">Specifies default values for request headers. <p> Strings are of the format <js>"Header-Name: header-value"</js>. @@ -668,7 +718,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.259">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.291">defaultResponseHeaders</a></pre> <div class="block">Specifies default values for response headers. <p> Strings are of the format <js>"Header-Name: header-value"</js>. @@ -704,7 +754,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.301">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.333">children</a></pre> <div class="block">Defines children of this resource. <p> A REST child resource is simply another servlet that is initialized as part of the parent @@ -758,7 +808,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.314">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.346">path</a></pre> <div class="block">Identifies the URL subpath relative to the parent resource. <p> Typically, this annotation is only applicable to resources defined as children through the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#children--"><code>children()</code></a> @@ -783,7 +833,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>title</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.331">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.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. @@ -812,7 +862,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/RestResource.html#line.348">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.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. @@ -841,7 +891,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>termsOfService</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.364">termsOfService</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.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. @@ -869,7 +919,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>contact</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.394">contact</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.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. @@ -911,7 +961,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>license</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.423">license</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.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. @@ -952,7 +1002,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>version</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.439">version</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.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. @@ -980,7 +1030,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>tags</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.474">tags</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.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. @@ -1027,7 +1077,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>externalDocs</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.503">externalDocs</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.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. @@ -1068,7 +1118,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>config</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.514">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.546">config</a></pre> <div class="block">Optional location of configuration file for this servlet. <p> The configuration file . @@ -1091,7 +1141,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.564">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.596">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. @@ -1153,7 +1203,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.596">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.628">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 @@ -1197,7 +1247,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.630">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.662">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. @@ -1243,7 +1293,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.642">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.674">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 @@ -1267,7 +1317,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.667">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.699">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: @@ -1304,7 +1354,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.677">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.709">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. @@ -1326,7 +1376,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.687">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.719">callHandler</a></pre> <div class="block">Specifies the REST call handler class. <p> This class handles the basic lifecycle of an HTTP REST call. @@ -1348,7 +1398,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.696">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.728">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. @@ -1369,7 +1419,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>pageTitle</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.731">pageTitle</a></pre> +<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 @@ -1416,7 +1466,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>pageText</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.767">pageText</a></pre> +<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.799">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. @@ -1464,7 +1514,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>pageLinks</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.797">pageLinks</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.829">pageLinks</a></pre> <div class="block">Specifies the page hyperlinks to use on the HTML view of all pages produced by this resource. <p> The page links is positioned immediately under the title and text. http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/rest/package-frame.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/package-frame.html b/content/site/apidocs/org/apache/juneau/rest/package-frame.html index 766f982..dc20b30 100644 --- a/content/site/apidocs/org/apache/juneau/rest/package-frame.html +++ b/content/site/apidocs/org/apache/juneau/rest/package-frame.html @@ -22,6 +22,11 @@ <li><a href="ReaderResource.html" title="class in org.apache.juneau.rest" target="classFrame">ReaderResource</a></li> <li><a href="ReaderResource.Builder.html" title="class in org.apache.juneau.rest" target="classFrame">ReaderResource.Builder</a></li> <li><a href="Redirect.html" title="class in org.apache.juneau.rest" target="classFrame">Redirect</a></li> +<li><a href="RequestBody.html" title="class in org.apache.juneau.rest" target="classFrame">RequestBody</a></li> +<li><a href="RequestFormData.html" title="class in org.apache.juneau.rest" target="classFrame">RequestFormData</a></li> +<li><a href="RequestHeaders.html" title="class in org.apache.juneau.rest" target="classFrame">RequestHeaders</a></li> +<li><a href="RequestPathParams.html" title="class in org.apache.juneau.rest" target="classFrame">RequestPathParams</a></li> +<li><a href="RequestQuery.html" title="class in org.apache.juneau.rest" target="classFrame">RequestQuery</a></li> <li><a href="RestCallHandler.html" title="class in org.apache.juneau.rest" target="classFrame">RestCallHandler</a></li> <li><a href="RestConfig.html" title="class in org.apache.juneau.rest" target="classFrame">RestConfig</a></li> <li><a href="RestContext.html" title="class in org.apache.juneau.rest" target="classFrame">RestContext</a></li> @@ -32,6 +37,7 @@ <li><a href="RestLogger.Normal.html" title="class in org.apache.juneau.rest" target="classFrame">RestLogger.Normal</a></li> <li><a href="RestMatcher.html" title="class in org.apache.juneau.rest" target="classFrame">RestMatcher</a></li> <li><a href="RestMatcherReflecting.html" title="class in org.apache.juneau.rest" target="classFrame">RestMatcherReflecting</a></li> +<li><a href="RestParam.html" title="class in org.apache.juneau.rest" target="classFrame">RestParam</a></li> <li><a href="RestRequest.html" title="class in org.apache.juneau.rest" target="classFrame">RestRequest</a></li> <li><a href="RestResourceResolver.html" title="class in org.apache.juneau.rest" target="classFrame">RestResourceResolver</a></li> <li><a href="RestResourceResolver.DEFAULT.html" title="class in org.apache.juneau.rest" target="classFrame">RestResourceResolver.DEFAULT</a></li> @@ -44,6 +50,10 @@ <li><a href="StreamResource.Builder.html" title="class in org.apache.juneau.rest" target="classFrame">StreamResource.Builder</a></li> <li><a href="UrlPathPattern.html" title="class in org.apache.juneau.rest" target="classFrame">UrlPathPattern</a></li> </ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="RestParamType.html" title="enum in org.apache.juneau.rest" target="classFrame">RestParamType</a></li> +</ul> <h2 title="Exceptions">Exceptions</h2> <ul title="Exceptions"> <li><a href="RestException.html" title="class in org.apache.juneau.rest" target="classFrame">RestException</a></li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/rest/package-summary.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/package-summary.html b/content/site/apidocs/org/apache/juneau/rest/package-summary.html index cda0577..52b93b7 100644 --- a/content/site/apidocs/org/apache/juneau/rest/package-summary.html +++ b/content/site/apidocs/org/apache/juneau/rest/package-summary.html @@ -134,65 +134,101 @@ </td> </tr> <tr class="altColor"> +<td class="colFirst"><a href="../../../../org/apache/juneau/rest/RequestBody.html" title="class in org.apache.juneau.rest">RequestBody</a></td> +<td class="colLast"> +<div class="block">Contains the body of the HTTP request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../org/apache/juneau/rest/RequestFormData.html" title="class in org.apache.juneau.rest">RequestFormData</a></td> +<td class="colLast"> +<div class="block">Represents the parsed form data parameters in an HTTP request.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../org/apache/juneau/rest/RequestHeaders.html" title="class in org.apache.juneau.rest">RequestHeaders</a></td> +<td class="colLast"> +<div class="block">Represents the headers in an HTTP request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../org/apache/juneau/rest/RequestPathParams.html" title="class in org.apache.juneau.rest">RequestPathParams</a></td> +<td class="colLast"> +<div class="block">Represents the path parameters on an HTTP request.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../org/apache/juneau/rest/RequestQuery.html" title="class in org.apache.juneau.rest">RequestQuery</a></td> +<td class="colLast"> +<div class="block">Represents the query parameters in an HTTP request.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/juneau/rest/RestCallHandler.html" title="class in org.apache.juneau.rest">RestCallHandler</a></td> <td class="colLast"> <div class="block">Class that handles the basic lifecycle of an HTTP REST call.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a></td> <td class="colLast"> <div class="block">Defines the initial configuration of a <code>RestServlet</code> or <code>@RestResource</code> annotated object.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest">RestContext</a></td> <td class="colLast"> <div class="block">Contains all the configuration on a REST resource and the entry points for handling REST calls.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest">RestGuard</a></td> <td class="colLast"> <div class="block">REST method guard.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/juneau/rest/RestInfoProvider.html" title="class in org.apache.juneau.rest">RestInfoProvider</a></td> <td class="colLast"> <div class="block">Class that provides documentation and other related information about a REST resource.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/juneau/rest/RestLogger.html" title="class in org.apache.juneau.rest">RestLogger</a></td> <td class="colLast"> <div class="block">Logging utility class.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/juneau/rest/RestLogger.NoOp.html" title="class in org.apache.juneau.rest">RestLogger.NoOp</a></td> <td class="colLast"> <div class="block">NO-OP logger.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/juneau/rest/RestLogger.Normal.html" title="class in org.apache.juneau.rest">RestLogger.Normal</a></td> <td class="colLast"> <div class="block">Default logger.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/juneau/rest/RestMatcher.html" title="class in org.apache.juneau.rest">RestMatcher</a></td> <td class="colLast"> <div class="block">Class used for defining method-level matchers using the <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#matchers--"><code>RestMethod.matchers()</code></a> annotation.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/juneau/rest/RestMatcherReflecting.html" title="class in org.apache.juneau.rest">RestMatcherReflecting</a></td> <td class="colLast"> <div class="block">Subclass of <a href="../../../../org/apache/juneau/rest/RestMatcher.html" title="class in org.apache.juneau.rest"><code>RestMatcher</code></a> that gives access to the servlet/resource and Java method it's applied to.</div> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../org/apache/juneau/rest/RestParam.html" title="class in org.apache.juneau.rest">RestParam</a></td> +<td class="colLast"> +<div class="block">REST java method parameter resolver.</div> +</td> +</tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a></td> <td class="colLast"> @@ -263,6 +299,23 @@ </table> </li> <li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> +<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Enum</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../org/apache/juneau/rest/RestParamType.html" title="enum in org.apache.juneau.rest">RestParamType</a></td> +<td class="colLast"> +<div class="block">Represents the possible parameter types as defined by the Swagger 2.0 specification.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> <tr> @@ -833,13 +886,78 @@ <ul class='spaced-list'> <li>Parameters of the following class types: <ul> - <li><a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> - The request object. - <li><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true"; title="class or interface in javax.servlet.http"><code>HttpServletRequest</code></a> - The superclass of <code>RestRequest</code>. - <li><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest"><code>RestResponse</code></a> - The response object. - <li><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true"; title="class or interface in javax.servlet.http"><code>HttpServletResponse</code></a> - The superclass of <code>RestResponse</code>. - <li><a href="../../../../org/apache/juneau/http/Accept.html" title="class in org.apache.juneau.http"><code>Accept</code></a> - The parsed <code>Accept</code> header. - <li><a href="../../../../org/apache/juneau/http/AcceptEncoding.html" title="class in org.apache.juneau.http"><code>AcceptEncoding</code></a> - The parsed <code>Accept-Encoding</code> header. - <li><a href="../../../../org/apache/juneau/http/ContentType.html" title="class in org.apache.juneau.http"><code>ContentType</code></a> - The parsed <code>Content-Type</code> header. + <li>Request/response objects: + <ul> + <li><a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> - The request object. + <li><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true"; title="class or interface in javax.servlet.http"><code>HttpServletRequest</code></a> - The superclass of <code>RestRequest</code>. + <li><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest"><code>RestResponse</code></a> - The response object. + <li><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true"; title="class or interface in javax.servlet.http"><code>HttpServletResponse</code></a> - The superclass of <code>RestResponse</code>. + </ul> + <li>Parsed request header values: + <ul> + <li><a href="../../../../org/apache/juneau/http/Accept.html" title="class in org.apache.juneau.http"><code>Accept</code></a> + <li><a href="../../../../org/apache/juneau/http/AcceptCharset.html" title="class in org.apache.juneau.http"><code>AcceptCharset</code></a> + <li><a href="../../../../org/apache/juneau/http/AcceptEncoding.html" title="class in org.apache.juneau.http"><code>AcceptEncoding</code></a> + <li><a href="../../../../org/apache/juneau/http/AcceptLanguage.html" title="class in org.apache.juneau.http"><code>AcceptLanguage</code></a> + <li><a href="../../../../org/apache/juneau/http/Authorization.html" title="class in org.apache.juneau.http"><code>Authorization</code></a> + <li><a href="../../../../org/apache/juneau/http/CacheControl.html" title="class in org.apache.juneau.http"><code>CacheControl</code></a> + <li><a href="../../../../org/apache/juneau/http/Connection.html" title="class in org.apache.juneau.http"><code>Connection</code></a> + <li><a href="../../../../org/apache/juneau/http/ContentLength.html" title="class in org.apache.juneau.http"><code>ContentLength</code></a> + <li><a href="../../../../org/apache/juneau/http/ContentType.html" title="class in org.apache.juneau.http"><code>ContentType</code></a> + <li><a href="../../../../org/apache/juneau/http/Date.html" title="class in org.apache.juneau.http"><code>Date</code></a> + <li><a href="../../../../org/apache/juneau/http/Expect.html" title="class in org.apache.juneau.http"><code>Expect</code></a> + <li><a href="../../../../org/apache/juneau/http/From.html" title="class in org.apache.juneau.http"><code>From</code></a> + <li><a href="../../../../org/apache/juneau/http/Host.html" title="class in org.apache.juneau.http"><code>Host</code></a> + <li><a href="../../../../org/apache/juneau/http/IfMatch.html" title="class in org.apache.juneau.http"><code>IfMatch</code></a> + <li><a href="../../../../org/apache/juneau/http/IfModifiedSince.html" title="class in org.apache.juneau.http"><code>IfModifiedSince</code></a> + <li><a href="../../../../org/apache/juneau/http/IfNoneMatch.html" title="class in org.apache.juneau.http"><code>IfNoneMatch</code></a> + <li><a href="../../../../org/apache/juneau/http/IfRange.html" title="class in org.apache.juneau.http"><code>IfRange</code></a> + <li><a href="../../../../org/apache/juneau/http/IfUnmodifiedSince.html" title="class in org.apache.juneau.http"><code>IfUnmodifiedSince</code></a> + <li><a href="../../../../org/apache/juneau/http/MaxForwards.html" title="class in org.apache.juneau.http"><code>MaxForwards</code></a> + <li><a href="../../../../org/apache/juneau/http/Pragma.html" title="class in org.apache.juneau.http"><code>Pragma</code></a> + <li><a href="../../../../org/apache/juneau/http/ProxyAuthorization.html" title="class in org.apache.juneau.http"><code>ProxyAuthorization</code></a> + <li><a href="../../../../org/apache/juneau/http/Range.html" title="class in org.apache.juneau.http"><code>Range</code></a> + <li><a href="../../../../org/apache/juneau/http/Referer.html" title="class in org.apache.juneau.http"><code>Referer</code></a> + <li><a href="../../../../org/apache/juneau/http/TE.html" title="class in org.apache.juneau.http"><code>TE</code></a> + <li><a href="../../../../org/apache/juneau/http/UserAgent.html" title="class in org.apache.juneau.http"><code>UserAgent</code></a> + <li><a href="../../../../org/apache/juneau/http/Upgrade.html" title="class in org.apache.juneau.http"><code>Upgrade</code></a> + <li><a href="../../../../org/apache/juneau/http/Via.html" title="class in org.apache.juneau.http"><code>Via</code></a> + <li><a href="../../../../org/apache/juneau/http/Warning.html" title="class in org.apache.juneau.http"><code>Warning</code></a> + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html?is-external=true"; title="class or interface in java.util"><code>TimeZone</code></a> + </ul> + <li>Direct streams on request/response: + <ul> + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io"><code>InputStream</code></a> + <li><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletInputStream.html?is-external=true"; title="class or interface in javax.servlet"><code>ServletInputStream</code></a> + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true"; title="class or interface in java.io"><code>Reader</code></a> + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io"><code>OutputStream</code></a> + <li><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletOutputStream.html?is-external=true"; title="class or interface in javax.servlet"><code>ServletOutputStream</code></a> + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io"><code>Writer</code></a> + </ul> + <li>Localization: + <ul> + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/util/ResourceBundle.html?is-external=true"; title="class or interface in java.util"><code>ResourceBundle</code></a> - Client-localized resource bundle. + <li><a href="../../../../org/apache/juneau/utils/MessageBundle.html" title="class in org.apache.juneau.utils"><code>MessageBundle</code></a> - A resource bundle with additional features. + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util"><code>Locale</code></a> - Client locale. + </ul> + <li>Request APIs: + <ul> + <li><a href="../../../../org/apache/juneau/rest/RequestHeaders.html" title="class in org.apache.juneau.rest"><code>RequestHeaders</code></a> - API for accessing request headers. + <li><a href="../../../../org/apache/juneau/rest/RequestQuery.html" title="class in org.apache.juneau.rest"><code>RequestQuery</code></a> - API for accessing request query parameters. + <li><a href="../../../../org/apache/juneau/rest/RequestFormData.html" title="class in org.apache.juneau.rest"><code>RequestFormData</code></a> - API for accessing request form data. + <li><a href="../../../../org/apache/juneau/rest/RequestPathParams.html" title="class in org.apache.juneau.rest"><code>RequestPathParams</code></a> - API for accessing path variables. + <li><a href="../../../../org/apache/juneau/rest/RequestBody.html" title="class in org.apache.juneau.rest"><code>RequestBody</code></a> - API for accessing request body. + </ul> + <li>Other: + <ul> + <li><a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http"><code>HttpMethod</code></a> - The method name matched (when using <code><ja>@RestMethod</ja>(name=<js>"*"</js>)</code>) + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Logger.html?is-external=true"; title="class or interface in java.util.logging"><code>Logger</code></a> - The logger to use for logging. + <li><a href="../../../../org/apache/juneau/internal/JuneauLogger.html" title="class in org.apache.juneau.internal"><code>JuneauLogger</code></a> - Logger with additional features. + <li><a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest"><code>RestContext</code></a> - The resource read-only context. + <li><a href="../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser"><code>Parser</code></a> - The parser matching the request content type. + <li><a href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger"><code>Swagger</code></a> - The auto-generated Swagger doc. + <li><a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini"><code>ConfigFile</code></a> - The external config file for the resource. + </ul> </ul> <li>Annotated parameters: <ul> @@ -895,21 +1013,8 @@ } </p> <p> - All annotations have programmatic equivalents on the <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> class: + All annotations have programmatic equivalents on the <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> class. </p> - <ul class='javahierarchy'> - <li class='m'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getPathParameter-java.lang.String-java.lang.Class-"><code>RestRequest.getPathParameter(String,Class)</code></a> - <li class='m'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getFormDataParameter-java.lang.String-java.lang.Class-"><code>RestRequest.getFormDataParameter(String,Class)</code></a> - <li class='m'><a href="../../../../org/apache/juneau/rest/RestRequest.html#hasFormDataParameter-java.lang.String-"><code>RestRequest.hasFormDataParameter(String)</code></a> - <li class='m'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getQueryParameter-java.lang.String-java.lang.Class-"><code>RestRequest.getQueryParameter(String,Class)</code></a> - <li class='m'><a href="../../../../org/apache/juneau/rest/RestRequest.html#hasQueryParameter-java.lang.String-"><code>RestRequest.hasQueryParameter(String)</code></a> - <li class='m'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getBody-java.lang.Class-"><code>RestRequest.getBody(Class)</code></a> - <li class='m'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getHeader-java.lang.String-java.lang.Class-"><code>RestRequest.getHeader(String,Class)</code></a> - <li class='m'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getMethod--"><code>RestRequest.getMethod()</code></a> - <li class='m'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getPathRemainder--"><code>RestRequest.getPathRemainder()</code></a> - <li class='m'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getMessage-java.lang.String-java.lang.Object...-"><code>RestRequest.getMessage(String,Object[])</code></a> - <li class='m'><a href="../../../../org/apache/juneau/rest/RestRequest.html#getProperties--"><code>RestRequest.getProperties()</code></a> - </ul> <!-- ======================================================================================================== --> <a id="RestResources.MethodSignature.Path"></a> @@ -1074,7 +1179,7 @@ </p> <p> The HTTP body of a request can be retrieved as a parsed POJO using either the - <a href="../../../../org/apache/juneau/rest/RestRequest.html#getBody-java.lang.Class-"><code>RestRequest.getBody(Class)</code></a> method, or a parameter + <a href="../../../../org/apache/juneau/rest/RestRequest.html#getBody--"><code>RestRequest.getBody()</code></a> method, or a parameter annotated with <a href="../../../../org/apache/juneau/rest/annotation/Body.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Body</code></a>. </p> <p class='bcode'> @@ -1087,7 +1192,7 @@ <jc>// Equivalent method 2</jc> <ja>@RestMethod</ja>(name=<js>"POST"</js>, path=<js>"/example2"</js>) <jk>public void</jk> doPost2(RestRequest req) { - Person p = req.getBody(Person.<jk>class</jk>); + Person p = req.getBody).asType(Person.<jk>class</jk>); <jc>// Do something with p.</jc> } </p> @@ -1150,7 +1255,7 @@ cause the underlying JEE servlet to parse the HTTP body as a form post. Your input bean will end up being null since there won't be any content left after the servlet has parsed the body of the request. - This applies to WHENEVER you use <l>@Body</l> or <a href="../../../../org/apache/juneau/rest/RestRequest.html#getBody-java.lang.Class-"><code>RestRequest.getBody(Class)</code></a>. + This applies to WHENEVER you use <l>@Body</l> or <a href="../../../../org/apache/juneau/rest/RestRequest.html#getBody--"><code>RestRequest.getBody()</code></a>. </p> </div> @@ -2290,14 +2395,14 @@ <ul> <li><ck>$R{attribute.X}</ck> - Value returned by <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequestWrapper.html?is-external=true#getAttribute-java.lang.String-"; title="class or interface in javax.servlet"><code>ServletRequestWrapper.getAttribute(String)</code></a> converted to a string. <li><ck>$R{contextPath}</ck> - Value returned by <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getContextPath--"; title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getContextPath()</code></a>. - <li><ck>$R{formData.X}</ck> - Value returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getFormDataParameter-java.lang.String-"><code>RestRequest.getFormDataParameter(String)</code></a>. + <li><ck>$R{formData.X}</ck> - Value returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getFormData-java.lang.String-"><code>RestRequest.getFormData(String)</code></a>. <li><ck>$R{header.X}</ck> - Value returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getHeader-java.lang.String-"><code>RestRequest.getHeader(String)</code></a>. <li><ck>$R{method}</ck> - Value returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getMethod--"><code>RestRequest.getMethod()</code></a>. <li><ck>$R{methodSummary}</ck> - Value returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getMethodSummary--"><code>RestRequest.getMethodSummary()</code></a>. <li><ck>$R{methodDescription}</ck> - Value returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getMethodDescription--"><code>RestRequest.getMethodDescription()</code></a>. <li><ck>$R{path.X}</ck> - Value returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getPathParameter-java.lang.String-"><code>RestRequest.getPathParameter(String)</code></a>. <li><ck>$R{pathInfo}</ck> - Value returned by <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getPathInfo--"; title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getPathInfo()</code></a>. - <li><ck>$R{query.X}</ck> - Value returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getQueryParameter-java.lang.String-"><code>RestRequest.getQueryParameter(String)</code></a>. + <li><ck>$R{query.X}</ck> - Value returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getQuery-java.lang.String-"><code>RestRequest.getQuery(String)</code></a>. <li><ck>$R{requestParentURI}</ck> - Value returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getRequestParentURI--"><code>RestRequest.getRequestParentURI()</code></a>. <li><ck>$R{requestURI}</ck> - Value returned by <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getRequestURI--"; title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getRequestURI()</code></a>. <li><ck>$R{servletDescription}</ck> - Value returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getServletDescription--"><code>RestRequest.getServletDescription()</code></a>. @@ -3368,7 +3473,7 @@ <div class='topic'> <p> Certain methods in the REST server API allow you to specify class types that can be convertable - from <l>Strings</l> (e.g. <a href="../../../../org/apache/juneau/rest/RestRequest.html#getPathParameter-java.lang.String-java.lang.Class-"><code>RestRequest.getPathParameter(String,Class)</code></a>). + from <l>Strings</l> (e.g. <a href="../../../../org/apache/juneau/rest/RestRequest.html#getPathParameter-java.lang.String-"><code>RestRequest.getPathParameter(String)</code></a>). </p> <p> POJOs convertable from <l>Strings</l> have one of the following: http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/rest/package-tree.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/package-tree.html b/content/site/apidocs/org/apache/juneau/rest/package-tree.html index 53941e8..d15eee9 100644 --- a/content/site/apidocs/org/apache/juneau/rest/package-tree.html +++ b/content/site/apidocs/org/apache/juneau/rest/package-tree.html @@ -80,6 +80,26 @@ <ul> <li type="circle">java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang"><span class="typeNameLink">Object</span></a> <ul> +<li type="circle">java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.html?is-external=true"; title="class or interface in java.util"><span class="typeNameLink">AbstractMap</span></a><K,V> (implements java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><K,V>) +<ul> +<li type="circle">java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/HashMap.html?is-external=true"; title="class or interface in java.util"><span class="typeNameLink">HashMap</span></a><K,V> (implements java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Cloneable.html?is-external=true"; title="class or interface in java.lang">Cloneable</a>, java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><K,V>, java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>) +<ul> +<li type="circle">java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMap.html?is-external=true"; title="class or interface in java.util"><span class="typeNameLink">LinkedHashMap</span></a><K,V> (implements java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><K,V>) +<ul> +<li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RequestFormData.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">RequestFormData</span></a></li> +<li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RequestQuery.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">RequestQuery</span></a></li> +</ul> +</li> +</ul> +</li> +<li type="circle">java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true"; title="class or interface in java.util"><span class="typeNameLink">TreeMap</span></a><K,V> (implements java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Cloneable.html?is-external=true"; title="class or interface in java.lang">Cloneable</a>, java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/NavigableMap.html?is-external=true"; title="class or interface in java.util">NavigableMap</a><K,V>, java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>) +<ul> +<li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RequestHeaders.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">RequestHeaders</span></a></li> +<li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RequestPathParams.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">RequestPathParams</span></a></li> +</ul> +</li> +</ul> +</li> <li type="circle">org.apache.juneau.<a href="../../../../org/apache/juneau/Context.html" title="class in org.apache.juneau"><span class="typeNameLink">Context</span></a> <ul> <li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">RestContext</span></a></li> @@ -105,6 +125,7 @@ <li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">ReaderResource</span></a> (implements org.apache.juneau.<a href="../../../../org/apache/juneau/Writable.html" title="interface in org.apache.juneau">Writable</a>)</li> <li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">ReaderResource.Builder</span></a></li> <li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/Redirect.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Redirect</span></a></li> +<li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RequestBody.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">RequestBody</span></a></li> <li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RestCallHandler.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">RestCallHandler</span></a></li> <li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">RestConfig</span></a> (implements javax.servlet.<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletConfig.html?is-external=true"; title="class or interface in javax.servlet">ServletConfig</a>)</li> <li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">RestGuard</span></a></li> @@ -121,6 +142,7 @@ <li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RestMatcherReflecting.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">RestMatcherReflecting</span></a></li> </ul> </li> +<li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RestParam.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">RestParam</span></a></li> <li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RestResourceResolver.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">RestResourceResolver</span></a> <ul> <li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RestResourceResolver.DEFAULT.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">RestResourceResolver.DEFAULT</span></a></li> @@ -174,6 +196,18 @@ <li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/ResponseHandler.html" title="interface in org.apache.juneau.rest"><span class="typeNameLink">ResponseHandler</span></a></li> <li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest"><span class="typeNameLink">RestConverter</span></a></li> </ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang"><span class="typeNameLink">Object</span></a> +<ul> +<li type="circle">java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang"><span class="typeNameLink">Enum</span></a><E> (implements java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><T>, java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>) +<ul> +<li type="circle">org.apache.juneau.rest.<a href="../../../../org/apache/juneau/rest/RestParamType.html" title="enum in org.apache.juneau.rest"><span class="typeNameLink">RestParamType</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> </div> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom">
