http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/RestServletContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestServletContext.html b/content/site/apidocs/org/apache/juneau/rest/RestServletContext.html index 6a42ca9..04f3c28 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestServletContext.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestServletContext.html @@ -394,7 +394,7 @@ extends <a href="../../../../org/apache/juneau/Context.html" title="class in org Use "*" to represent all methods. For backwards compatibility, "true" also means "*". <p> - Note that per the <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html";>HTTP specification</a>, special care should + Note that per the <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html";>HTTP specification</a>, special care should be taken when allowing non-safe (POST, PUT, DELETE) methods to be invoked through GET requests. <p> Applicable to servlet class only.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/RestServletException.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestServletException.html b/content/site/apidocs/org/apache/juneau/rest/RestServletException.html index 219c3f1..0f01b81 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestServletException.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestServletException.html @@ -226,7 +226,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletExcept <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>message</code> - The detailed message.</dd> -<dd><code>args</code> - Optional message arguments.</dd> +<dd><code>args</code> - Optional <a href="http://docs.oracle.com/javase/7/docs/api/java/text/MessageFormat.html?is-external=true"; title="class or interface in java.text"><code>MessageFormat</code></a>-style arguments.</dd> </dl> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/annotation/Body.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Body.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Body.html index a93eaf1..4da92e9 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Body.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Body.html @@ -100,7 +100,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <div class="block">Annotation that can be applied to a parameter of a <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation"><code>RestMethod</code></a> annotated method to identify it as the HTTP request body converted to a POJO. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(name=<js>"POST"</js>) <jk>public void</jk> doPostPerson(RestRequest req, RestResponse res, <ja>@Body</ja> Person person) { http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/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 52a9cac..79929da 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/FormData.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/FormData.html @@ -100,7 +100,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <div class="block">Annotation that can be applied to a parameter of a <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation"><code>RestMethod</code></a> annotated method to identify it as a form post entry converted to a POJO. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(name=<js>"POST"</js>) <jk>public void</jk> doPost(RestRequest req, RestResponse res, http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/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 a3a96df..a337bc0 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/HasFormData.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/HasFormData.html @@ -102,7 +102,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> Note that this can be used to detect the existence of a parameter when it's not set to a particular value. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(name=<js>"POST"</js>) <jk>public void</jk> doPost(<ja>@HasFormData</ja>(<js>"p1"</js>) <jk>boolean</jk> p1) { http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/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 23402c9..35f517f 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/HasQuery.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/HasQuery.html @@ -105,7 +105,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota 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. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(name=<js>"GET"</js>) <jk>public void</jk> doPost(<ja>@HasQuery</ja>(<js>"p1"</js>) <jk>boolean</jk> p1, <ja>@Body</ja> Bean myBean) { http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/annotation/Header.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Header.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Header.html index 047bb3c..558a827 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Header.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Header.html @@ -100,7 +100,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <div class="block">Annotation that can be applied to a parameter of a <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation"><code>RestMethod</code></a> annotated method to identify it as a HTTP request header converted to a POJO. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(name=<js>"GET"</js>) <jk>public void</jk> doGet(RestRequest req, RestResponse res, <ja>@Header</ja>(<js>"ETag"</js>) UUID etag) { http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/annotation/Messages.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Messages.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Messages.html index 4678bf6..d082e8a 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Messages.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Messages.html @@ -102,7 +102,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> Parameter type must be either <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> or <a href="../../../../../org/apache/juneau/utils/MessageBundle.html" title="class in org.apache.juneau.utils"><code>MessageBundle</code></a>. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(name=<js>"GET"</js>) <jk>public</jk> String doGet(<ja>@Messages</ja> ResourceBundle messages) { http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/annotation/Method.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Method.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Method.html index 5a8b1fd..fdb19b7 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Method.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Method.html @@ -102,7 +102,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> Typically used for HTTP method handlers of type <js>"*"</js> (i.e. handle all requests). - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(name=<js>"*"</js>) <jk>public void</jk> doAnything(RestRequest req, RestResponse res, <ja>@Method</ja> String method) { http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/annotation/Parameter.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Parameter.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Parameter.html index 0874ddc..6fb030c 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Parameter.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Parameter.html @@ -100,7 +100,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <div class="block">Annotation used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#parameters--"><code>RestMethod.parameters()</code></a> to identify content and header descriptions on specific method requests. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>( name=<js>"*"</js>, @@ -243,12 +243,13 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>name</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Parameter.html#line.65">name</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Parameter.html#line.66">name</a></pre> <div class="block">The name of the parameter (e.g. <js>"Content-Range"</js>). <p> Parameter names are case sensitive. - If <code>in</code> is <js>"path"</js>, the name field MUST correspond to the associated path segment from the <code>path</code> field in the <a href='http://swagger.io/specification/#pathsObject'>Paths Object</a>. - See <a href='http://swagger.io/specification/#pathTemplating'>Path Templating</a> for further information. + If <code>in</code> is <js>"path"</js>, the name field MUST correspond to the associated path segment from the <code>path</code> field in + the <a class="doclink" href="http://swagger.io/specification/#pathsObject";>Paths Object</a>. + See <a class="doclink" href="http://swagger.io/specification/#pathTemplating";>Path Templating</a> for further information. For all other cases, the name corresponds to the parameter name used based on the <code>in</code> property.</div> <dl> <dt>Default:</dt> @@ -265,12 +266,12 @@ 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/Parameter.html#line.77">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/Parameter.html#line.78">description</a></pre> <div class="block">Parameter description (e.g. <js>"Indicates the range returned when Range header is present in the request"</js>). <p> A brief description of the parameter. This could contain examples of use. - <a href='https://help.github.com/articles/github-flavored-markdown'>GFM syntax</a> can be used for rich text representation. + <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown";>GFM syntax</a> can be used for rich text representation. <p> The default value pulls the description from the <code>description</code> entry in the servlet resource bundle. (e.g. <js>"myMethod.res.[code].[category].[name] = foo"</js> or <js>"MyServlet.myMethod.res.[code].[category].[name] = foo"</js>).</div> @@ -289,7 +290,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>required</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Parameter.html#line.85">required</a></pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Parameter.html#line.86">required</a></pre> <div class="block">Determines whether this parameter is mandatory. <p> If the parameter is <code>in</code> <js>"path"</js>, this property is required and its value MUST be <jk>true</jk>. @@ -309,14 +310,14 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>schema</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/Parameter.html#line.107">schema</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/Parameter.html#line.108">schema</a></pre> <div class="block">The schema defining the type used for the body parameter. <p> Only applicable for <code>in</code> of type <js>"body"</js>. <p> - The schema is a JSON object specified <a href='http://swagger.io/specification/#schemaObject'>here</a>. + The schema is a JSON object specified <a class="doclink" href="http://swagger.io/specification/#schemaObject";>here</a>. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>( parameters={ @@ -343,7 +344,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>type</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/Parameter.html#line.115">type</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/Parameter.html#line.116">type</a></pre> <div class="block">The type of the parameter. <p> The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, <js>"array"</js> or <js>"file"</js>. @@ -363,10 +364,10 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>format</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/Parameter.html#line.122">format</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/Parameter.html#line.123">format</a></pre> <div class="block">The extending format for the previously mentioned <code>type</code>. <p> - See <a href='http://swagger.io/specification/#dataTypeFormat'>Data Type Formats</a> for further details.</div> + See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat";>Data Type Formats</a> for further details.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -382,7 +383,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>allowEmptyValue</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Parameter.html#line.130">allowEmptyValue</a></pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Parameter.html#line.131">allowEmptyValue</a></pre> <div class="block">Sets the ability to pass empty-valued parameters. <p> This is valid only for either <code>query</code> or <code>formData</code> parameters and allows you to send a parameter with a name only or an empty value. @@ -402,12 +403,12 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>items</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/Parameter.html#line.153">items</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/Parameter.html#line.154">items</a></pre> <div class="block">Required if <code>type</code> is <js>"array"</js>. <p> Describes the type of items in the array. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>( parameters={ @@ -421,7 +422,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <jk>public void</jk> doAnything() { </p> <p> - See <a href='http://swagger.io/specification/#itemsObject'>Items Object</a> for further details.</div> + See <a class="doclink" href="http://swagger.io/specification/#itemsObject";>Items Object</a> for further details.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -437,7 +438,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>collectionFormat</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/Parameter.html#line.169">collectionFormat</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/Parameter.html#line.170">collectionFormat</a></pre> <div class="block">Determines the format of the array if type array is used. <p> Possible values are: @@ -465,12 +466,12 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>_default</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/Parameter.html#line.179">_default</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/Parameter.html#line.180">_default</a></pre> <div class="block">Declares the value of the parameter that the server will use if none is provided. <p> For example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: "default" has no meaning for required parameters.) - See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor101'>http://json-schema.org/latest/json-schema-validation.html#anchor101</a>. + See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101";>http://json-schema.org/latest/json-schema-validation.html#anchor101</a>. Unlike JSON Schema this value MUST conform to the defined <code>type</code> for this parameter.</div> <dl> <dt>Default:</dt> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/annotation/Path.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Path.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Path.html index f110de2..1f44cf1 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Path.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Path.html @@ -100,7 +100,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <div class="block">Annotation that can be applied to a parameter of a <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation"><code>RestMethod</code></a> annotated method to identify it as a variable in a URL path pattern converted to a POJO. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/myurl/{foo}/{bar}/{baz}/*"</js>) <jk>public void</jk> doGet(RestRequest req, RestResponse res, http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/annotation/PathRemainder.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/PathRemainder.html b/content/site/apidocs/org/apache/juneau/rest/annotation/PathRemainder.html index c92e33e..c5562e4 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/PathRemainder.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/PathRemainder.html @@ -100,7 +100,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <div class="block">Annotation that can be applied to a parameter of a <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation"><code>RestMethod</code></a> annotated method to identify it as the URL parameter remainder after a path pattern match. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/foo/*"</js>) <jk>public void</jk> doGet(RestRequest req, RestResponse res, <ja>@PathRemainder</ja> String remainder) { http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/annotation/Properties.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Properties.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Properties.html index 7c02c65..79240c1 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Properties.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Properties.html @@ -100,7 +100,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <div class="block">Annotation that can be applied to a parameter of a <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation"><code>RestMethod</code></a> annotated method to identify the request-duration properties object for the current request. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(name=<js>"GET"</js>) <jk>public Person</jk> doGetPerson(<ja>@Properties</ja> ObjectMap properties) { http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/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 c97e91d..b672616 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Query.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Query.html @@ -105,7 +105,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota 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. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(name=<js>"GET"</js>) <jk>public void</jk> doGet(RestRequest req, RestResponse res, http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html index c3064bc..e4f757a 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html @@ -99,7 +99,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Response.html#line.42">Response</a></pre> <div class="block">Annotation used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#responses--"><code>RestMethod.responses()</code></a> to identify possible responses by the method. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>( name=<js>"*"</js>, @@ -234,10 +234,10 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. - As an extension to the <a href='http://swagger.io/specification/#schemaObject'>Schema Object</a>, its root type value may also be <js>"file"</js>. + As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject";>Schema Object</a>, its root type value may also be <js>"file"</js>. This SHOULD be accompanied by a relevant produces mime-type. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>( name=<js>"*"</js>, http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html b/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html index d5b6b84..e498366 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html @@ -684,7 +684,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> Header values specified at the method level override header values specified at the servlet level. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <jc>// Assume "text/json" Accept value when Accept not specified</jc> <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/*"</js>, defaultRequestHeaders={<js>"Accept: text/json"</js>}) @@ -785,7 +785,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota The default value pulls the description from the <code>(className.?)[javaMethodName].externalDocs</code> entry in the servlet resource bundle. (e.g. <js>"MyClass.myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js> or <js>"myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js>). - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(externalDocs=<js>"{url:'http://juneau.apache.org'}"</js>) </p> @@ -819,7 +819,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota The default value pulls the description from the <code>(className.?)[javaMethodName].tags</code> entry in the servlet resource bundle. (e.g. <js>"MyClass.myMethod.tags = foo,bar"</js> or <js>"myMethod.tags = foo,bar"</js>). - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(tags=<js>"foo,bar"</js>) </p> @@ -850,7 +850,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota The default value pulls the description from the <code>(className.?)[javaMethodName].deprecated</code> entry in the servlet resource bundle. (e.g. <js>"MyClass.myMethod.deprecated = true"</js> or <js>"myMethod.deprecated = foo,bar"</js>). - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>(deprecated=<jk>true</jk>) </p> @@ -879,7 +879,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota This annotation is provided for documentation purposes and is used to populate the method <js>"parameters"</js> column on the Swagger page. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>( name=<js>"POST"</js>, path=<js>"/{a}"</js>, @@ -928,7 +928,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota This annotation is provided for documentation purposes and is used to populate the method <js>"responses"</js> column on the Swagger page. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>( name=<js>"GET"</js>, path=<js>"/"</js>, http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/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 f0bdcc5..bfd7634 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html @@ -547,7 +547,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> This annotation can only be used on <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>Encoder</code></a> classes that have no-arg constructors. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <jc>// Servlet with automated support for GZIP compression</jc> <ja>@RestResource</ja>(encoders={GzipEncoder.<jk>class</jk>}) @@ -582,7 +582,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> Only one header value can be specified per entry (i.e. it's not a delimited list of header entries). - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <jc>// Assume "text/json" Accept value when Accept not specified</jc> <ja>@RestResource</ja>(defaultRequestHeaders={<js>"Accept: text/json"</js>}) @@ -616,7 +616,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> Only one header value can be specified per entry (i.e. it's not a delimited list of header entries). - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <jc>// Add a version header attribute to all responses</jc> <ja>@RestResource</ja>(defaultResponseHeaders={<js>"X-Version: 1.0"</js>}) @@ -813,7 +813,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota The default value pulls the description from the <code>contact</code> entry in the servlet resource bundle. (e.g. <js>"contact = {name:'John Smith',email:'[email protected]'}"</js> or <js>"MyServlet.contact = {name:'John Smith',email:'[email protected]'}"</js>). - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestResource</ja>(contact=<js>"{name:'John Smith',email:'[email protected]'}"</js>) </p> @@ -853,7 +853,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota The default value pulls the description from the <code>license</code> entry in the servlet resource bundle. (e.g. <js>"license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js> or <js>"MyServlet.license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>). - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestResource</ja>(license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>) </p> @@ -926,7 +926,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota The default value pulls the description from the <code>tags</code> entry in the servlet resource bundle. (e.g. <js>"tags = [{name:'Foo',description:'Foobar'}]"</js> or <js>"MyServlet.tags = [{name:'Foo',description:'Foobar'}]"</js>). - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestResource</ja>(tags=<js>"[{name:'Foo',description:'Foobar'}]"</js>) </p> @@ -966,7 +966,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota The default value pulls the description from the <code>externalDocs</code> entry in the servlet resource bundle. (e.g. <js>"externalDocs = {url:'http://juneau.apache.org'}"</js> or <js>"MyServlet.externalDocs = {url:'http://juneau.apache.org'}"</js>). - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestResource</ja>(externalDocs=<js>"{url:'http://juneau.apache.org'}"</js>) </p> @@ -1033,7 +1033,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> If the file cannot be located, the request to <js>"[servletpath]/style.css"</js> 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>. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <jk>package</jk> com.foo.mypackage; @@ -1075,7 +1075,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> If the file cannot be located, the request to <js>"[servletpath]/favicon.ico"</js> 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>. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <jk>package</jk> com.foo.mypackage; @@ -1119,7 +1119,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <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. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> <jk>package</jk> com.foo.mypackage; http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/client/AllowAllRedirects.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/client/AllowAllRedirects.html b/content/site/apidocs/org/apache/juneau/rest/client/AllowAllRedirects.html index 23fbe30..008a8e4 100644 --- a/content/site/apidocs/org/apache/juneau/rest/client/AllowAllRedirects.html +++ b/content/site/apidocs/org/apache/juneau/rest/client/AllowAllRedirects.html @@ -117,12 +117,15 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/client/AllowAllRedirects.html#line.23">AllowAllRedirects</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/client/AllowAllRedirects.html#line.26">AllowAllRedirects</a> extends org.apache.http.impl.client.DefaultRedirectStrategy</pre> <div class="block">Redirect strategy that allows for redirects on any request type, not just <code>GET</code> or <code>HEAD</code>. <p> - Note: This class is similar to <code>org.apache.http.impl.client.LaxRedirectStrategy</code> - in Apache HttpClient 4.2, but also allows for redirects on <code>PUTs</code> and <code>DELETEs</code>.</div> + <h5 class='section'>Notes:</h5> + <ul> + <li>This class is similar to <code>org.apache.http.impl.client.LaxRedirectStrategy</code> + in Apache HttpClient 4.2, but also allows for redirects on <code>PUTs</code> and <code>DELETEs</code>. + </ul></div> </li> </ul> </div> @@ -212,7 +215,7 @@ extends org.apache.http.impl.client.DefaultRedirectStrategy</pre> <ul class="blockListLast"> <li class="blockList"> <h4>AllowAllRedirects</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/client/AllowAllRedirects.html#line.23">AllowAllRedirects</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/client/AllowAllRedirects.html#line.26">AllowAllRedirects</a>()</pre> </li> </ul> </li> @@ -229,7 +232,7 @@ extends org.apache.http.impl.client.DefaultRedirectStrategy</pre> <ul class="blockListLast"> <li class="blockList"> <h4>isRedirectable</h4> -<pre>protected boolean <a href="../../../../../src-html/org/apache/juneau/rest/client/AllowAllRedirects.html#line.26">isRedirectable</a>(<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> method)</pre> +<pre>protected boolean <a href="../../../../../src-html/org/apache/juneau/rest/client/AllowAllRedirects.html#line.29">isRedirectable</a>(<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> method)</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>isRedirectable</code> in class <code>org.apache.http.impl.client.DefaultRedirectStrategy</code></dd> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/content/site/apidocs/org/apache/juneau/rest/client/NameValuePairs.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/client/NameValuePairs.html b/content/site/apidocs/org/apache/juneau/rest/client/NameValuePairs.html index 3d00f76..9064e57 100644 --- a/content/site/apidocs/org/apache/juneau/rest/client/NameValuePairs.html +++ b/content/site/apidocs/org/apache/juneau/rest/client/NameValuePairs.html @@ -137,7 +137,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedList.h <div class="block">Convenience class for constructing instances of <code>List<NameValuePair></code> for the <code>UrlEncodedFormEntity</code> class. - <h6 class='topic'>Example:</h6> + <h5 class='section'>Example:</h5> <p class='bcode'> NameValuePairs params = <jk>new</jk> NameValuePairs() .append(<jk>new</jk> BasicNameValuePair(<js>"j_username"</js>, user)) http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/afa6a1d0/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 9621d09..79a9532 100644 --- a/content/site/apidocs/org/apache/juneau/rest/client/ResponsePattern.html +++ b/content/site/apidocs/org/apache/juneau/rest/client/ResponsePattern.html @@ -114,7 +114,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <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. - <h6 class='topic'>Example:</h6> + <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> from a response body. <p>
