http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1809c234/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 303ad4a..3fdc1cc 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html @@ -96,9 +96,11 @@ <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.42">RestResource</a></pre> -<div class="block">Optionally used to associate metadata on an instance of <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>RestServlet</code></a>. +public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.45">RestResource</a></pre> +<div class="block">Used to denote that a class is a REST resource and to associate metadata on it. <p> + Usually used on a subclass of <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>RestServlet</code></a>, but can be used to annotate any class that you want to expose as a REST resource. + Refer to <a class='doclink' href='../package-summary.html#TOC'>org.apache.juneau.rest</a> doc for information on using this class.</div> </li> </ul> @@ -125,77 +127,89 @@ 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/RestCallHandler.html" title="class in org.apache.juneau.rest">RestCallHandler</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#callHandler--">callHandler</a></span></code> +<div class="block">Specifies the REST call handler class.</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><?>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#children--">children</a></span></code> <div class="block">Defines children of this resource.</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#clientVersionHeader--">clientVersionHeader</a></span></code> <div class="block">Specifies the HTTP header name used to identify the client version.</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#config--">config</a></span></code> <div class="block">Optional location of configuration file 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#contact--">contact</a></span></code> <div class="block">Optional contact 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/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest">RestConverter</a>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#converters--">converters</a></span></code> <div class="block">Class-level converters.</div> </td> </tr> -<tr class="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#defaultRequestHeaders--">defaultRequestHeaders</a></span></code> <div class="block">Specifies default values for request headers.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#defaultResponseHeaders--">defaultResponseHeaders</a></span></code> <div class="block">Specifies default values for response headers.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#description--">description</a></span></code> <div class="block">Optional servlet description.</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/encoders/Encoder.html" title="class in org.apache.juneau.encoders">Encoder</a>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#encoders--">encoders</a></span></code> <div class="block">Specifies a list of <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>Encoder</code></a> to associate with this servlet.</div> </td> </tr> -<tr class="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#externalDocs--">externalDocs</a></span></code> <div class="block">Optional external documentation 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#favicon--">favicon</a></span></code> <div class="block">The favicon 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/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>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#guards--">guards</a></span></code> <div class="block">Class-level guards.</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/RestInfoProvider.html" title="class in org.apache.juneau.rest">RestInfoProvider</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#infoProvider--">infoProvider</a></span></code> +<div class="block">Specifies the class used to retrieve title/description/swagger information about a resource.</div> +</td> +</tr> <tr class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#license--">license</a></span></code> @@ -203,6 +217,18 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </td> </tr> <tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#links--">links</a></span></code> +<div class="block">TODO</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestLogger.html" title="class in org.apache.juneau.rest">RestLogger</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#logger--">logger</a></span></code> +<div class="block">Specifies the logger class to use for logging.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#messages--">messages</a></span></code> <div class="block">Identifies the location of the resource bundle for this class.</div> @@ -233,6 +259,12 @@ 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/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"> <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 @@ -240,43 +272,43 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota HTTP responses.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#serializers--">serializers</a></span></code> <div class="block">Specifies a list of <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializer</code></a> classes to add to the list of serializers available for this servlet.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#staticFiles--">staticFiles</a></span></code> <div class="block">Defines paths and locations of statically served files.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#stylesheet--">stylesheet</a></span></code> <div class="block">The stylesheet to use for HTML views.</div> </td> </tr> -<tr class="rowColor"> +<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#tags--">tags</a></span></code> <div class="block">Optional tagging information for the exposed 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#termsOfService--">termsOfService</a></span></code> <div class="block">Optional servlet terms-of-service for this 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#title--">title</a></span></code> <div class="block">Optional servlet title.</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#version--">version</a></span></code> <div class="block">Provides the version of the application API (not to be confused with the specification version).</div> @@ -303,14 +335,13 @@ 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.61">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.63">messages</a></pre> <div class="block">Identifies the location of the resource bundle for this class. <p> This annotation is used to provide localized messages for the following methods: <ul> - <li><a href="../../../../../org/apache/juneau/rest/RestServlet.html#getMessage-java.util.Locale-java.lang.String-java.lang.Object...-"><code>RestServlet.getMessage(java.util.Locale, String, Object...)</code></a> - <li><a href="../../../../../org/apache/juneau/rest/RestServlet.html#getTitle-org.apache.juneau.rest.RestRequest-"><code>RestServlet.getTitle(RestRequest)</code></a> - <li><a href="../../../../../org/apache/juneau/rest/RestServlet.html#getDescription-org.apache.juneau.rest.RestRequest-"><code>RestServlet.getDescription(RestRequest)</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestRequest.html#getMessage-java.lang.String-java.lang.Object...-"><code>RestRequest.getMessage(String, Object...)</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestContext.html#getMessages--"><code>RestContext.getMessages()</code></a> </ul> <p> Refer to the <a href="../../../../../org/apache/juneau/utils/MessageBundle.html" title="class in org.apache.juneau.utils"><code>MessageBundle</code></a> class for a description of the message key formats @@ -334,7 +365,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.73">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.77">guards</a></pre> <div class="block">Class-level guards. <p> Associates one or more <a href="../../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest"><code>RestGuards</code></a> with all REST methods defined @@ -342,7 +373,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota These guards get called immediately before execution of any REST method in this class. <p> Typically, guards will be used for permissions checking on the user making the request, - but it can also be used for other purposes like pre-call validation of a request.</div> + but it can also be used for other purposes like pre-call validation of a request. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addGuards-java.lang.Class...-"><code>RestConfig.addGuards(Class...)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#addGuards-org.apache.juneau.rest.RestGuard...-"><code>RestConfig.addGuards(RestGuard...)</code></a> methods.</div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -358,7 +391,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.86">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.92">converters</a></pre> <div class="block">Class-level converters. <p> Associates one or more <a href="../../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest"><code>converters</code></a> with a resource class. @@ -367,7 +400,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> Can be used for performing post-processing on the response object before serialization. <p> - Default converter implementations are provided in the <a class='doclink' href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package.</div> + Default converter implementations are provided in the <a class='doclink' href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addConverters-java.lang.Class...-"><code>RestConfig.addConverters(Class...)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#addConverters-org.apache.juneau.rest.RestConverter...-"><code>RestConfig.addConverters(RestConverter...)</code></a> methods.</div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -383,19 +418,21 @@ 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.102">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.110">beanFilters</a></pre> <div class="block">Class-level bean filters. <p> Shortcut to add bean filters to the bean contexts of the objects returned by the following methods: <ul> - <li><a href="../../../../../org/apache/juneau/rest/RestServlet.html#getBeanContext--"><code>RestServlet.getBeanContext()</code></a> - <li><a href="../../../../../org/apache/juneau/rest/RestServlet.html#getSerializers--"><code>RestServlet.getSerializers()</code></a> - <li><a href="../../../../../org/apache/juneau/rest/RestServlet.html#getParsers--"><code>RestServlet.getParsers()</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestContext.html#getBeanContext--"><code>RestContext.getBeanContext()</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestContext.html#getSerializers--"><code>RestContext.getSerializers()</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestContext.html#getParsers--"><code>RestContext.getParsers()</code></a> </ul> <p> If the specified class is an instance of <a href="../../../../../org/apache/juneau/transform/BeanFilterBuilder.html" title="class in org.apache.juneau.transform"><code>BeanFilterBuilder</code></a>, then a filter built from that builder is added. Any other classes are wrapped in a <a href="../../../../../org/apache/juneau/transform/InterfaceBeanFilterBuilder.html" title="class in org.apache.juneau.transform"><code>InterfaceBeanFilterBuilder</code></a> to indicate that subclasses should - be treated as the specified class type.</div> + be treated as the specified class type. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addBeanFilters-java.lang.Class...-"><code>RestConfig.addBeanFilters(Class...)</code></a> method.</div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -411,18 +448,20 @@ 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.117">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.127">pojoSwaps</a></pre> <div class="block">Class-level POJO swaps. <p> Shortcut to add POJO swaps to the bean contexts of the objects returned by the following methods: <ul> - <li><a href="../../../../../org/apache/juneau/rest/RestServlet.html#getBeanContext--"><code>RestServlet.getBeanContext()</code></a> - <li><a href="../../../../../org/apache/juneau/rest/RestServlet.html#getSerializers--"><code>RestServlet.getSerializers()</code></a> - <li><a href="../../../../../org/apache/juneau/rest/RestServlet.html#getParsers--"><code>RestServlet.getParsers()</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestContext.html#getBeanContext--"><code>RestContext.getBeanContext()</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestContext.html#getSerializers--"><code>RestContext.getSerializers()</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestContext.html#getParsers--"><code>RestContext.getParsers()</code></a> </ul> <p> If the specified class is an instance of <a href="../../../../../org/apache/juneau/transform/PojoSwap.html" title="class in org.apache.juneau.transform"><code>PojoSwap</code></a>, then that swap is added. - Any other classes are wrapped in a <a href="../../../../../org/apache/juneau/transform/SurrogateSwap.html" title="class in org.apache.juneau.transform"><code>SurrogateSwap</code></a>.</div> + Any other classes are wrapped in a <a href="../../../../../org/apache/juneau/transform/SurrogateSwap.html" title="class in org.apache.juneau.transform"><code>SurrogateSwap</code></a>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addPojoSwaps-java.lang.Class...-"><code>RestConfig.addPojoSwaps(Class...)</code></a> method.</div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -438,19 +477,19 @@ 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.148">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.160">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: <ul> - <li><a href="../../../../../org/apache/juneau/rest/RestServlet.html#getBeanContext--"><code>RestServlet.getBeanContext()</code></a> - <li><a href="../../../../../org/apache/juneau/rest/RestServlet.html#getSerializers--"><code>RestServlet.getSerializers()</code></a> - <li><a href="../../../../../org/apache/juneau/rest/RestServlet.html#getParsers--"><code>RestServlet.getParsers()</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestContext.html#getBeanContext--"><code>RestContext.getBeanContext()</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestContext.html#getSerializers--"><code>RestContext.getSerializers()</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestContext.html#getParsers--"><code>RestContext.getParsers()</code></a> </ul> <p> Any of the following property names can be specified: <ul> - <li><a href="../../../../../org/apache/juneau/rest/RestServletContext.html" title="class in org.apache.juneau.rest"><code>RestServletContext</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest"><code>RestContext</code></a> <li><a href="../../../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau"><code>BeanContext</code></a> <li><a href="../../../../../org/apache/juneau/serializer/SerializerContext.html" title="class in org.apache.juneau.serializer"><code>SerializerContext</code></a> <li><a href="../../../../../org/apache/juneau/parser/ParserContext.html" title="class in org.apache.juneau.parser"><code>ParserContext</code></a> @@ -465,7 +504,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota Property values will be converted to the appropriate type. <p> In some cases, properties can be overridden at runtime through the <a href="../../../../../org/apache/juneau/rest/RestResponse.html#setProperty-java.lang.String-java.lang.Object-"><code>RestResponse.setProperty(String, Object)</code></a> method - or through a <a href="../../../../../org/apache/juneau/rest/annotation/Properties.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Properties</code></a> annotated method parameter.</div> + or through a <a href="../../../../../org/apache/juneau/rest/annotation/Properties.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Properties</code></a> annotated method parameter. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setProperty-java.lang.String-java.lang.Object-"><code>RestConfig.setProperty(String, Object)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#setProperties-java.util.Map-"><code>RestConfig.setProperties(java.util.Map)</code></a> methods.</div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -481,10 +522,12 @@ 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.155">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.169">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.</div> + 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. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addSerializers-java.lang.Class...-"><code>RestConfig.addSerializers(Class...)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#addSerializers-org.apache.juneau.serializer.Serializer...-"><code>RestConfig.addSerializers(Serializer...)</code></a> methods.</div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -500,10 +543,12 @@ 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.162">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.178">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.</div> + 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. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addParsers-java.lang.Class...-"><code>RestConfig.addParsers(Class...)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#addParsers-org.apache.juneau.parser.Parser...-"><code>RestConfig.addParsers(Parser...)</code></a> methods.</div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -519,12 +564,14 @@ 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.171">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.189">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. <p> - See <a href="../../../../../org/apache/juneau/rest/ResponseHandler.html" title="interface in org.apache.juneau.rest"><code>ResponseHandler</code></a> for details.</div> + See <a href="../../../../../org/apache/juneau/rest/ResponseHandler.html" title="interface in org.apache.juneau.rest"><code>ResponseHandler</code></a> for details. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addResponseHandlers-java.lang.Class...-"><code>RestConfig.addResponseHandlers(Class...)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#addResponseHandlers-org.apache.juneau.rest.ResponseHandler...-"><code>RestConfig.addResponseHandlers(ResponseHandler...)</code></a> methods.</div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -540,7 +587,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.189">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.209">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. @@ -554,7 +601,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <jk>public</jk> MyRestServlet <jk>extends</jk> RestServlet { ... } - </p></div> + </p> + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addEncoders-java.lang.Class...-"><code>RestConfig.addEncoders(Class...)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#addEncoders-org.apache.juneau.encoders.Encoder...-"><code>RestConfig.addEncoders(Encoder...)</code></a> methods.</div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -570,7 +619,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.212">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.234">defaultRequestHeaders</a></pre> <div class="block">Specifies default values for request headers. <p> Strings are of the format <js>"Header-Name: header-value"</js>. @@ -589,7 +638,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <jk>public</jk> MyRestServlet <jk>extends</jk> RestServlet { ... } - </p></div> + </p> + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addDefaultRequestHeader-java.lang.String-java.lang.Object-"><code>RestConfig.addDefaultRequestHeader(String, Object)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#addDefaultRequestHeaders-java.lang.String...-"><code>RestConfig.addDefaultRequestHeaders(String...)</code></a> methods.</div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -605,7 +656,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.234">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.258">defaultResponseHeaders</a></pre> <div class="block">Specifies default values for response headers. <p> Strings are of the format <js>"Header-Name: header-value"</js>. @@ -623,7 +674,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <jk>public</jk> MyRestServlet <jk>extends</jk> RestServlet { ... } - </p></div> + </p> + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addDefaultResponseHeader-java.lang.String-java.lang.Object-"><code>RestConfig.addDefaultResponseHeader(String, Object)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#addDefaultResponseHeaders-java.lang.String...-"><code>RestConfig.addDefaultResponseHeaders(String...)</code></a> methods.</div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -639,7 +692,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.274">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.300">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 @@ -675,7 +728,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota the <code>web.xml</code> file of the web application. </p> </dd> - </dl></div> + </dl> + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addChildResource-java.lang.String-java.lang.Object-"><code>RestConfig.addChildResource(String, Object)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#addChildResources-java.lang.Class...-"><code>RestConfig.addChildResources(Class...)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#addChildResources-java.lang.Object...-"><code>RestConfig.addChildResources(Object...)</code></a> methods.</div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -691,14 +746,16 @@ 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.285">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.313">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> annotation. However, it may be used in other ways (e.g. defining paths for top-level resources in microservices). <p> This annotation is ignored on top-level servlets (i.e. servlets defined in <code>web.xml</code> files). - Therefore, implementers can optionally specify a path value for documentation purposes.</div> + Therefore, implementers can optionally specify a path value for documentation purposes. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setPath-java.lang.String-"><code>RestConfig.setPath(String)</code></a> method.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -714,18 +771,20 @@ 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.300">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.330">title</a></pre> <div class="block">Optional servlet title. <p> It is used to populate the Swagger title field and to display on HTML pages. - This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestServlet.html#getTitle-org.apache.juneau.rest.RestRequest-"><code>RestServlet.getTitle(RestRequest)</code></a> method. + This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getServletTitle--"><code>RestRequest.getServletTitle()</code></a> method. <p> The default value pulls the label from the <code>label</code> entry in the servlet resource bundle. (e.g. <js>"title = foo"</js> or <js>"MyServlet.title = foo"</js>). <p> This field can contain variables (e.g. "$L{my.localized.variable}"). <p> - Corresponds to the swagger field <code>/info/title</code>.</div> + Corresponds to the swagger field <code>/info/title</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getTitle-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getTitle(RestRequest)</code></a> method.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -741,18 +800,20 @@ 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.315">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.347">description</a></pre> <div class="block">Optional servlet description. <p> It is used to populate the Swagger description field and to display on HTML pages. - This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestServlet.html#getDescription-org.apache.juneau.rest.RestRequest-"><code>RestServlet.getDescription(RestRequest)</code></a> method. + This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getServletDescription--"><code>RestRequest.getServletDescription()</code></a> method. <p> The default value pulls the description from the <code>description</code> entry in the servlet resource bundle. (e.g. <js>"description = foo"</js> or <js>"MyServlet.description = foo"</js>). <p> This field can contain variables (e.g. "$L{my.localized.variable}"). <p> - Corresponds to the swagger field <code>/info/description</code>.</div> + Corresponds to the swagger field <code>/info/description</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getDescription-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getDescription(RestRequest)</code></a> method.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -768,18 +829,19 @@ 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.330">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.363">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. - This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestServlet.html#getTermsOfService-org.apache.juneau.rest.RestRequest-"><code>RestServlet.getTermsOfService(RestRequest)</code></a> method. <p> The default value pulls the description from the <code>termsOfService</code> entry in the servlet resource bundle. (e.g. <js>"termsOfService = foo"</js> or <js>"MyServlet.termsOfService = foo"</js>). <p> This field can contain variables (e.g. "$L{my.localized.variable}"). <p> - Corresponds to the swagger field <code>/info/termsOfService</code>.</div> + Corresponds to the swagger field <code>/info/termsOfService</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getTermsOfService-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getTermsOfService(RestRequest)</code></a> method.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -795,11 +857,10 @@ 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.359">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.393">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. - This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestServlet.html#getContact-org.apache.juneau.rest.RestRequest-"><code>RestServlet.getContact(RestRequest)</code></a> method. <p> A simplified JSON string with the following fields: <p class='bcode'> @@ -820,7 +881,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> This field can contain variables (e.g. "$L{my.localized.variable}"). <p> - Corresponds to the swagger field <code>/info/contact</code>.</div> + Corresponds to the swagger field <code>/info/contact</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getContact-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getContact(RestRequest)</code></a> method.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -836,11 +899,10 @@ 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.387">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.422">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. - This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestServlet.html#getLicense-org.apache.juneau.rest.RestRequest-"><code>RestServlet.getLicense(RestRequest)</code></a> method. <p> A simplified JSON string with the following fields: <p class='bcode'> @@ -860,7 +922,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> This field can contain variables (e.g. "$L{my.localized.variable}"). <p> - Corresponds to the swagger field <code>/info/license</code>.</div> + Corresponds to the swagger field <code>/info/license</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getLicense-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getLicense(RestRequest)</code></a> method.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -876,18 +940,19 @@ 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.402">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.438">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. - This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestServlet.html#getVersion-org.apache.juneau.rest.RestRequest-"><code>RestServlet.getVersion(RestRequest)</code></a> method. <p> The default value pulls the description from the <code>version</code> entry in the servlet resource bundle. (e.g. <js>"version = 2.0"</js> or <js>"MyServlet.version = 2.0"</js>). <p> This field can contain variables (e.g. "$L{my.localized.variable}"). <p> - Corresponds to the swagger field <code>/info/version</code>.</div> + Corresponds to the swagger field <code>/info/version</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getVersion-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getVersion(RestRequest)</code></a> method.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -903,11 +968,10 @@ 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.436">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.473">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. - This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestServlet.html#getTags-org.apache.juneau.rest.RestRequest-"><code>RestServlet.getTags(RestRequest)</code></a> method. <p> A simplified JSON string with the following fields: <p class='bcode'> @@ -933,7 +997,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> This field can contain variables (e.g. "$L{my.localized.variable}"). <p> - Corresponds to the swagger field <code>/tags</code>.</div> + Corresponds to the swagger field <code>/tags</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getTags-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getTags(RestRequest)</code></a> method.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -949,11 +1015,10 @@ 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.464">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.502">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. - This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestServlet.html#getExternalDocs-org.apache.juneau.rest.RestRequest-"><code>RestServlet.getExternalDocs(RestRequest)</code></a> method. <p> A simplified JSON string with the following fields: <p class='bcode'> @@ -973,7 +1038,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> This field can contain variables (e.g. "$L{my.localized.variable}"). <p> - Corresponds to the swagger field <code>/tags</code>.</div> + Corresponds to the swagger field <code>/tags</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getExternalDocs-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getExternalDocs(RestRequest)</code></a> method.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -989,12 +1056,14 @@ 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.473">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.513">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}").</div> + This field can contain variables (e.g. "$L{my.localized.variable}"). + <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> <dl> <dt>Default:</dt> <dd>""</dd> @@ -1010,7 +1079,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.521">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.563">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. @@ -1054,7 +1123,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> Multiple stylesheets can be specified as a comma-delimited list. When multiple stylesheets are specified, their contents will be concatenated and return in the order specified - in the list.</div> + in the list. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addStyleSheet-java.lang.Object...-"><code>RestConfig.addStyleSheet(Object...)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#addStyleSheet-java.lang.Class-java.lang.String-"><code>RestConfig.addStyleSheet(Class, String)</code></a> methods.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -1070,7 +1141,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.551">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.595">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 @@ -1096,7 +1167,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <li><code>com.foo.mypackage.mydocs</code> package. <li><code>org.apache.juneau.rest.mydocs</code> package (since <code>RestServletDefault</code> is in <code>org.apache.juneau.rest</code>). <li><code>[working-dir]/mydocs</code> directory. - </ol></div> + </ol> + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setFavIcon-java.lang.Object-"><code>RestConfig.setFavIcon(Object)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#setFavIcon-java.lang.Class-java.lang.String-"><code>RestConfig.setFavIcon(Class, String)</code></a> methods.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -1112,7 +1185,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.585">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.629">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. @@ -1120,8 +1193,6 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota Mappings are cumulative from parent to child. Child resources can override mappings made on parent resources. <p> If the file cannot be located, the request will return <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_NOT_FOUND"; title="class or interface in javax.servlet.http"><code>HttpServletResponse.SC_NOT_FOUND</code></a>. - <p> - The media type on the response is determined by the <a href="../../../../../org/apache/juneau/rest/RestServlet.html#getMimetypesFileTypeMap--"><code>RestServlet.getMimetypesFileTypeMap()</code></a> method. <h5 class='section'>Example:</h5> <p class='bcode'> @@ -1142,7 +1213,9 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <li><code>com.foo.mypackage.docs</code> package. <li><code>org.apache.juneau.rest.docs</code> package (since <code>RestServletDefault</code> is in <code>org.apache.juneau.rest</code>). <li><code>[working-dir]/docs</code> directory. - </ol></div> + </ol> + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addStaticFiles-java.lang.Class-java.lang.String-"><code>RestConfig.addStaticFiles(Class, String)</code></a> method.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -1155,16 +1228,137 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <li class="blockList"><a name="clientVersionHeader--"> <!-- --> </a> -<ul class="blockListLast"> +<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.595">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.641">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 changes. Used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#clientVersion--"><code>RestMethod.clientVersion()</code></a> annotation. <p> - If not specified, uses <js>"X-Client-Version"</js>.</div> + If not specified, uses <js>"X-Client-Version"</js>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setClientVersionHeader-java.lang.String-"><code>RestConfig.setClientVersionHeader(String)</code></a> method.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="resourceResolver--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resourceResolver</h4> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestResourceResolver.html" title="class in org.apache.juneau.rest">RestResourceResolver</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.666">resourceResolver</a></pre> +<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: + <ul> + <li><code><jk>public</jk> T(RestConfig)</code> + <li><code><jk>public</jk> T()</code> + </ul> + The former constructor can be used to get access to the <a href="../../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest"><code>RestConfig</code></a> object to get access to the + config file and initialization information or make programmatic modifications to the resource before + full initialization. + <p> + Non-<code>RestServlet</code> classes can also add the following two methods to get access to the + <a href="../../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest"><code>RestConfig</code></a> and <a href="../../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest"><code>RestContext</code></a> objects: + <ul> + <li><jk>public void</jk> init(RestConfig);</code> + <li><jk>public void</jk> init(RestContext);</code> + </ul> + <p> + Subclasses can be used to provide customized resolution of REST resource class instances. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setResourceResolver-java.lang.Class-"><code>RestConfig.setResourceResolver(Class)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#setResourceResolver-org.apache.juneau.rest.RestResourceResolver-"><code>RestConfig.setResourceResolver(RestResourceResolver)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>org.apache.juneau.rest.RestResourceResolver.class</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="logger--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>logger</h4> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestLogger.html" title="class in org.apache.juneau.rest">RestLogger</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.676">logger</a></pre> +<div class="block">Specifies the logger class to use for logging. + <p> + The default logger performs basic error logging to the Java logger. + Subclasses can be used to customize logging behavior on the resource. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setLogger-java.lang.Class-"><code>RestConfig.setLogger(Class)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#setLogger-org.apache.juneau.rest.RestLogger-"><code>RestConfig.setLogger(RestLogger)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>org.apache.juneau.rest.RestLogger.Normal.class</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="callHandler--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>callHandler</h4> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestCallHandler.html" title="class in org.apache.juneau.rest">RestCallHandler</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.686">callHandler</a></pre> +<div class="block">Specifies the REST call handler class. + <p> + This class handles the basic lifecycle of an HTTP REST call. + Subclasses can be used to customize how these HTTP calls are handled. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setCallHandler-java.lang.Class-"><code>RestConfig.setCallHandler(Class)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#setCallHandler-org.apache.juneau.rest.RestCallHandler-"><code>RestConfig.setCallHandler(RestCallHandler)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>org.apache.juneau.rest.RestCallHandler.class</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="infoProvider--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>infoProvider</h4> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html" title="class in org.apache.juneau.rest">RestInfoProvider</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.695">infoProvider</a></pre> +<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. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setInfoProvider-java.lang.Class-"><code>RestConfig.setInfoProvider(Class)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestConfig.html#setInfoProvider-org.apache.juneau.rest.RestInfoProvider-"><code>RestConfig.setInfoProvider(RestInfoProvider)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>org.apache.juneau.rest.RestInfoProvider.class</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="links--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>links</h4> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.700">links</a></pre> +<div class="block">TODO</div> <dl> <dt>Default:</dt> <dd>""</dd>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1809c234/content/site/apidocs/org/apache/juneau/rest/annotation/package-summary.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/package-summary.html b/content/site/apidocs/org/apache/juneau/rest/annotation/package-summary.html index 863106b..1dd62f3 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/package-summary.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/package-summary.html @@ -208,7 +208,7 @@ <tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html" title="annotation in org.apache.juneau.rest.annotation">RestResource</a></td> <td class="colLast"> -<div class="block">Optionally used to associate metadata on an instance of <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>RestServlet</code></a>.</div> +<div class="block">Used to denote that a class is a REST resource and to associate metadata on it.</div> </td> </tr> </tbody> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1809c234/content/site/apidocs/org/apache/juneau/rest/client/ResponsePattern.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/client/ResponsePattern.html b/content/site/apidocs/org/apache/juneau/rest/client/ResponsePattern.html index 8421b0b..b26ebca 100644 --- a/content/site/apidocs/org/apache/juneau/rest/client/ResponsePattern.html +++ b/content/site/apidocs/org/apache/juneau/rest/client/ResponsePattern.html @@ -112,7 +112,7 @@ var activeTableTab = "activeTableTab"; extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> <div class="block">Used to find regular expression matches in REST responses made through <a href="../../../../../org/apache/juneau/rest/client/RestCall.html" title="class in org.apache.juneau.rest.client"><code>RestCall</code></a>. <p> - Response patterns are applied to REST calls through the <a href="../../../../../org/apache/juneau/rest/client/RestCall.html#addResponsePattern-org.apache.juneau.rest.client.ResponsePattern-"><code>RestCall.addResponsePattern(ResponsePattern)</code></a> method. + Response patterns are applied to REST calls through the <a href="../../../../../org/apache/juneau/rest/client/RestCall.html#responsePattern-org.apache.juneau.rest.client.ResponsePattern-"><code>RestCall.responsePattern(ResponsePattern)</code></a> method. <h5 class='section'>Example:</h5> This example shows how to use a response pattern finder to find and capture patterns for <js>"x=number"</js> and <js>"y=string"</js>
