You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2018/10/18 18:53:18 UTC
[juneau] branch master updated: Javadocs
This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/juneau.git
The following commit(s) were added to refs/heads/master by this push:
new 02443e2 Javadocs
02443e2 is described below
commit 02443e2fef5a1fcc8f87083d8efdeb97d7d599d0
Author: JamesBognar <ja...@apache.org>
AuthorDate: Thu Oct 18 14:53:05 2018 -0400
Javadocs
---
.../juneau/plaintext/PlainTextSerializer.java | 2 +-
.../org/apache/juneau/remoteable/RemoteMethod.java | 3 +-
juneau-doc/docs.txt | 2 +-
juneau-doc/src/main/javadoc/overview.html | 505 +++++++++++----------
.../src/main/resources/ReleaseNotes/5.2.0.0.html | 2 +-
.../src/main/resources/ReleaseNotes/7.2.0.html | 20 +-
.../06.RestMethod/11.ReaderResource.html | 11 +-
.../06.RestMethod/12.StreamResource.html | 10 +-
.../06.RestMethod/16.PredefinedHelperBeans.html | 4 -
.../10.HttpPartAnnotations.html | 2 +-
.../org/apache/juneau/rest/client/RestCall.java | 2 +-
.../juneau/rest/client/RestClientBuilder.java | 2 +-
.../apache/juneau/rest/BasicRestCallHandler.java | 2 +-
.../org/apache/juneau/rest/RequestFormData.java | 4 +-
.../java/org/apache/juneau/rest/RestRequest.java | 2 +-
.../apache/juneau/rest/annotation/Parameter.java | 40 +-
.../apache/juneau/rest/widget/PoweredByApache.java | 12 +-
.../widget/doc-files/PoweredByApacheWidget.png | Bin 0 -> 4368 bytes
18 files changed, 326 insertions(+), 299 deletions(-)
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java
index a811cd5..a080036 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java
@@ -121,7 +121,7 @@ public class PlainTextSerializer extends WriterSerializer {
}
/**
- * @deprecated Use {@link #ParserSessionArgs(ObjectMap, Method, Locale, TimeZone, MediaType, HttpPartSchema, Boolean, Object)}
+ * @deprecated Use {@link SerializerSessionArgs#SerializerSessionArgs(ObjectMap, Method, Locale, TimeZone, MediaType, HttpPartSchema, Boolean, UriContext, Boolean)}
*/
@Deprecated
@SuppressWarnings("javadoc")
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java
index 446cf07..b6ade44 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java
@@ -19,9 +19,8 @@ import java.io.*;
import java.lang.annotation.*;
/**
- * @deprecated Use {@link org.apache.juneau.client.remote.RemoteMethod}
+ * @deprecated Use <code>org.apache.juneau.client.remote.RemoteMethod</code>
*/
-@SuppressWarnings("javadoc")
@Deprecated
@Documented
@Target(METHOD)
diff --git a/juneau-doc/docs.txt b/juneau-doc/docs.txt
index e08b14e..db309de 100644
--- a/juneau-doc/docs.txt
+++ b/juneau-doc/docs.txt
@@ -102,7 +102,7 @@ juneau-examples-rest.PetStoreResource = #juneau-examples-rest.PetStoreResource,
juneau-examples-rest.PhotosResource = #juneau-examples-rest.PhotosResource, Overview > juneau-examples-rest > PhotosResource
juneau-examples-rest.RequestEchoResource = #juneau-examples-rest.RequestEchoResource, Overview > juneau-examples-rest > RequestEchoResource
juneau-examples-rest.RootResources = #juneau-examples-rest.RootResources, Overview > juneau-examples-rest > RootResources
-juneau-examples-rest.SampleRemoteableServlet = #juneau-examples-rest.SampleRemoteableServlet, Overview > juneau-examples-rest > SampleRemoteInterfaceServlet
+juneau-examples-rest.SampleRemoteableServlet = #juneau-examples-rest.SampleRemoteableServlet, Overview > juneau-examples-rest > SampleRrpcServlet
juneau-examples-rest.SqlQueryResource = #juneau-examples-rest.SqlQueryResource, Overview > juneau-examples-rest > SqlQueryResource
juneau-examples-rest.SystemPropertiesResource = #juneau-examples-rest.SystemPropertiesResource, Overview > juneau-examples-rest > SystemPropertiesResource
juneau-examples-rest.TempDirResource = #juneau-examples-rest.TempDirResource, Overview > juneau-examples-rest > TempDirResource
diff --git a/juneau-doc/src/main/javadoc/overview.html b/juneau-doc/src/main/javadoc/overview.html
index 7b9d1b3..ded7e4e 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -43,11 +43,11 @@
</script>
</head>
<body>
-<h1 class='title'>Apache Juneau 7.2.0 Documentation</h1>
-<!-- h1 class='preview-title'>Apache Juneau 7.2.0 Documentation Preview</h1-->
-<!-- h2 class='preview-section todo'>Documentation in progress</h2-->
-<h2 class='preview-section new'>New documentation in 7.2.0</h2>
-<h2 class='preview-section updated'>Updated documentation in 7.2.0</h2>
+<h1 class='title'>Apache Juneau 7.2.1 Documentation</h1>
+<h1 class='preview-title'>Apache Juneau 7.2.1 Documentation Preview</h1>
+<h2 class='preview-section todo'>Documentation in progress</h2>
+<h2 class='preview-section new'>New documentation in 7.2.1</h2>
+<h2 class='preview-section updated'>Updated documentation in 7.2.1</h2>
<script type='text/javascript'>
function toggle(x) {
@@ -92,13 +92,13 @@
<ol>
<li><p class=''><a class='doclink' href='#juneau-marshall.Serializers'>Serializers</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.Parsers'>Parsers</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.Marshalls'>Marshalls</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.HttpPartSerializers'>HTTP Part Serializers</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.HttpPartParsers'>HTTP Part Parsers</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.Marshalls'>Marshalls</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.HttpPartSerializers'>HTTP Part Serializers</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.HttpPartParsers'>HTTP Part Parsers</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.ConfigurableProperties'>Configurable Properties</a></p>
<ol>
<li><p class=''><a class='doclink' href='#juneau-marshall.ConfigurableProperties.Common'>Common Serializer Properties</a></p>
- <li><p class='updated'><a class='doclink' href='#juneau-marshall.ConfigurableProperties.CommonSerializer'>Common Serializer Properties</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.ConfigurableProperties.CommonSerializer'>Common Serializer Properties</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.ConfigurableProperties.CommonParser'>Common Parser Properties</a></p>
</ol>
<li><p class=''><a class='doclink' href='#juneau-marshall.ObjectMap'>ObjectMap and ObjectList</a></p>
@@ -107,9 +107,9 @@
<li><p class=''><a class='doclink' href='#juneau-marshall.Transforms'>Transforms</a></p>
<ol>
<li><p class=''><a class='doclink' href='#juneau-marshall.Transforms.PojoSwaps'>PojoSwaps</a></p>
- <li><p class='updated'><a class='doclink' href='#juneau-marshall.Transforms.PerMediaTypePojoSwaps'>Per-media-type PojoSwaps</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.Transforms.PerMediaTypePojoSwaps'>Per-media-type PojoSwaps</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.Transforms.OneWayPojoSwaps'>One-way PojoSwaps</a></p>
- <li><p class=''><a class='doclink' href='#juneau-marshall.Transforms.SwapAnnotation'>@Swap Annotation</a></p>
+ <li><p class='updated'><a class='doclink' href='#juneau-marshall.Transforms.SwapAnnotation'>@Swap Annotation</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.Transforms.TemplatedSwaps'>Templated Swaps</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.Transforms.SwapMethods'>Swap Methods</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.Transforms.SurrogateClasses'>Surrogate Classes</a></p>
@@ -133,9 +133,9 @@
<li><p class=''><a class='doclink' href='#juneau-marshall.Recursion'>Non-Tree Models and Recursion Detection</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.ParsingIntoGenericModels'>Parsing into Generic Models</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.ReadingContinuousStreams'>Reading Continuous Streams</a></p>
- <li><p class='updated'><a class='doclink' href='#juneau-marshall.URIs'>URIs</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.URIs'>URIs</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.JacksonComparison'>Comparison with Jackson</a></p>
- <li><p class='updated'><a class='doclink' href='#juneau-marshall.PojoCategories'>POJO Categories</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.PojoCategories'>POJO Categories</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.JsonDetails'>JSON Details</a></p>
<ol>
<li><p class=''><a class='doclink' href='#juneau-marshall.JsonDetails.Methodology'>JSON Methodology</a></p>
@@ -158,15 +158,15 @@
</ol>
<li><p class=''><a class='doclink' href='#juneau-marshall.HtmlDetails'>HTML Details</a></p>
<ol>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.HtmlDetails.Methodology'>HTML Methodology</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.HtmlDetails.Serializers'>HTML Serializers</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.HtmlDetails.Parsers'>HTML Parsers</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.HtmlDetails.HtmlAnnotation'>@Html Annotation</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.HtmlDetails.HtmlRenderAnnotation'>@Html(render) Annotation</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.HtmlDetails.HtmlDocSerializer'>HtmlDocSerializer</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.HtmlDetails.BasicHtmlDocTemplate'>BasicHtmlDocTemplate</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.HtmlDetails.CustomTemplates'>Custom Templates</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.HtmlDetails.HtmlSchema'>HTML-Schema Support</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.HtmlDetails.Methodology'>HTML Methodology</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.HtmlDetails.Serializers'>HTML Serializers</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.HtmlDetails.Parsers'>HTML Parsers</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.HtmlDetails.HtmlAnnotation'>@Html Annotation</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.HtmlDetails.HtmlRenderAnnotation'>@Html(render) Annotation</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.HtmlDetails.HtmlDocSerializer'>HtmlDocSerializer</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.HtmlDetails.BasicHtmlDocTemplate'>BasicHtmlDocTemplate</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.HtmlDetails.CustomTemplates'>Custom Templates</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.HtmlDetails.HtmlSchema'>HTML-Schema Support</a></p>
</ol>
<li><p class=''><a class='doclink' href='#juneau-marshall.UonDetails'>UON Details</a></p>
<ol>
@@ -179,18 +179,18 @@
<li><p class=''><a class='doclink' href='#juneau-marshall.UrlEncodingDetails.Methodology'>URL-Encoding Methodology</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.UrlEncodingDetails.Serializers'>URL-Encoding Serializers</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.UrlEncodingDetails.Parsers'>URL-Encoding Parsers</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.UrlEncodingDetails.UrlEncodingAnnotation'>@UrlEncoding Annotation</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.UrlEncodingDetails.UrlEncodingAnnotation'>@UrlEncoding Annotation</a></p>
</ol>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.MsgPackDetails'>MessagePack Details</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.MsgPackDetails'>MessagePack Details</a></p>
<ol>
<li><p class=''><a class='doclink' href='#juneau-marshall.MsgPackDetails.Serializers'>MessagePack Serializers</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall.MsgPackDetails.Parsers'>MessagePack Parsers</a></p>
</ol>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.OpenApiDetails'>OpenAPI Details</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.OpenApiDetails'>OpenAPI Details</a></p>
<ol>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.OpenApiDetails.Methodology'>OpenAPI Methodology</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.OpenApiDetails.Serializers'>OpenAPI Serializers</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall.OpenApiDetails.Parsers'>OpenAPI Parsers</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.OpenApiDetails.Methodology'>OpenAPI Methodology</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.OpenApiDetails.Serializers'>OpenAPI Serializers</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall.OpenApiDetails.Parsers'>OpenAPI Parsers</a></p>
</ol>
<li><p class=''><a class='doclink' href='#juneau-marshall.BestPractices'>Best Practices</a></p>
</ol>
@@ -200,7 +200,7 @@
<ol>
<li><p class=''><a class='doclink' href='#juneau-marshall-rdf.RdfDetails.Serializers'>RDF Serializers</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall-rdf.RdfDetails.Parsers'>RDF Parsers</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-marshall-rdf.RdfDetails.RdfAnnotation'>@Rdf Annotation</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-marshall-rdf.RdfDetails.RdfAnnotation'>@Rdf Annotation</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall-rdf.RdfDetails.Namespaces'>Namespaces</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall-rdf.RdfDetails.UriProperties'>URI Properties</a></p>
<li><p class=''><a class='doclink' href='#juneau-marshall-rdf.RdfDetails.RootProperty'>Root Property</a></p>
@@ -212,7 +212,7 @@
<li><p class=''><a class='doclink' href='#juneau-dto.HTML5'>HTML5</a></p>
<li><p class=''><a class='doclink' href='#juneau-dto.Atom'>Atom</a></p>
<li><p class=''><a class='doclink' href='#juneau-dto.Swagger'>Swagger</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-dto.SwaggerUI'>Swagger UI</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-dto.SwaggerUI'>Swagger UI</a></p>
</ol>
<li><p class='toc2 '><a class='doclink' href='#juneau-svl'>juneau-svl</a></p>
<ol>
@@ -279,7 +279,7 @@
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestResource.AnnotationInheritance'>Annotation Inheritance</a></p>
</ol>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestContext'>RestContext</a></p>
- <li><p class='updated'><a class='doclink' href='#juneau-rest-server.RestMethod'>@RestMethod</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod'>@RestMethod</a></p>
<ol>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.MethodParameters'>Java Method Parameters</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.RestRequest'>RestRequest</a></p>
@@ -291,29 +291,29 @@
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.RestMethodPath'>@RestMethod(path)</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.RequestPathMatch'>RequestPathMatch</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.MethodReturnTypes'>Method Return Types</a></p>
- <li><p class='updated'><a class='doclink' href='#juneau-rest-server.RestMethod.ReaderResource'>ReaderResource</a></p>
- <li><p class='updated'><a class='doclink' href='#juneau-rest-server.RestMethod.StreamResource'>StreamResource</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.ReaderResource'>ReaderResource</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.StreamResource'>StreamResource</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.RestMethodMatchers'>@RestMethod(matchers)</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.RestMethod.PredefinedResponses'>Predefined Responses</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.RestMethod.PredefinedExceptions'>Predefined Exceptions</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.RestMethod.PredefinedHelperBeans'>Predefined Helper Beans</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.PredefinedResponses'>Predefined Responses</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.PredefinedExceptions'>Predefined Exceptions</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.PredefinedHelperBeans'>Predefined Helper Beans</a></p>
</ol>
<li><p class='updated'><a class='doclink' href='#juneau-rest-server.restRPC'>restRPC</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.OpenApiSchemaPartParsing'>OpenAPI Schema Part Parsing</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.OpenApiSchemaPartSerializing'>OpenAPI Schema Part Serializing</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations'>HTTP-Part Annotations</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.OpenApiSchemaPartParsing'>OpenAPI Schema Part Parsing</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.OpenApiSchemaPartSerializing'>OpenAPI Schema Part Serializing</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations'>HTTP-Part Annotations</a></p>
<ol>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.Body'>@Body</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.FormData'>@FormData</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.HasFormData'>@HasFormData</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.Query'>@Query</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.HasQuery'>@HasQuery</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.Header'>@Header</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.Path'>@Path</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.Request'>@Request</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.Response'>@Response</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.ResponseHeader'>@ResponseHeader</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.ResponseStatus'>@ResponseStatus</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.Body'>@Body</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.FormData'>@FormData</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.HasFormData'>@HasFormData</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.Query'>@Query</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.HasQuery'>@HasQuery</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.Header'>@Header</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.Path'>@Path</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.Request'>@Request</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.Response'>@Response</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.ResponseHeader'>@ResponseHeader</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HttpPartAnnotations.ResponseStatus'>@ResponseStatus</a></p>
</ol>
<li><p class=''><a class='doclink' href='#juneau-rest-server.HandlingFormPosts'>Handling Form Posts</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.HandlingMultiPartFormPosts'>Handling Multi-Part Form Posts</a></p>
@@ -321,7 +321,7 @@
<li><p class=''><a class='doclink' href='#juneau-rest-server.Parsers'>Parsers</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.Properties'>Properties</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.Transforms'>Transforms</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.URIs'>URIs</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.URIs'>URIs</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.Guards'>Guards</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.Converters'>Converters</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.Messages'>Messages</a></p>
@@ -330,29 +330,29 @@
<li><p class=''><a class='doclink' href='#juneau-rest-server.ConfigurationFiles'>Configuration Files</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.StaticFiles'>Static files</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.ClientVersioning'>Client Versioning</a></p>
- <li><p class='updated'><a class='doclink' href='#juneau-rest-server.RestInfoProvider'>RestInfoProvider</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.RestInfoProvider'>RestInfoProvider</a></p>
<ol>
- <li><p class='updated'><a class='doclink' href='#juneau-rest-server.RestInfoProvider.BasicRestInfoProvider'>BasicRestInfoProvider</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.RestInfoProvider.BasicRestInfoProvider'>BasicRestInfoProvider</a></p>
</ol>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.Swagger'>Swagger</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.Swagger'>Swagger</a></p>
<ol>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.Swagger.BasicRestServlet'>BasicRestServlet</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.Swagger.BasicSwaggerInfo'>Basic Swagger Info</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.Swagger.Tags'>Tags</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.Swagger.Operations'>Operations</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.Swagger.Parameters'>Parameters</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.Swagger.ParameterExamples'>Parameter Examples</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.Swagger.Responses'>Responses</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.Swagger.ResponseExamples'>Response Examples</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.Swagger.Models'>Models</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.Swagger.Stylesheet'>SwaggerUI.css</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.Swagger.BasicRestServlet'>BasicRestServlet</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.Swagger.BasicSwaggerInfo'>Basic Swagger Info</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.Swagger.Tags'>Tags</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.Swagger.Operations'>Operations</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.Swagger.Parameters'>Parameters</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.Swagger.ParameterExamples'>Parameter Examples</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.Swagger.Responses'>Responses</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.Swagger.ResponseExamples'>Response Examples</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.Swagger.Models'>Models</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.Swagger.Stylesheet'>SwaggerUI.css</a></p>
</ol>
<li><p class=''><a class='doclink' href='#juneau-rest-server.HtmlDocAnnotation'>@HtmlDoc</a></p>
<ol>
<li><p class=''><a class='doclink' href='#juneau-rest-server.HtmlDocAnnotation.UIvsDI'>User Interfaces (UI) vs. Developer Interfaces (DI)</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.HtmlDocAnnotation.Widgets'>Widgets</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.HtmlDocAnnotation.PredefinedWidgets'>Predefined Widgets</a></p>
- <li><p class='updated'><a class='doclink' href='#juneau-rest-server.HtmlDocAnnotation.UiCustomization'>UI Customization</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HtmlDocAnnotation.PredefinedWidgets'>Predefined Widgets</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.HtmlDocAnnotation.UiCustomization'>UI Customization</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.HtmlDocAnnotation.Stylesheets'>Stylesheets</a></p>
</ol>
<li><p class=''><a class='doclink' href='#juneau-rest-server.DefaultHeaders'>Default Headers</a></p>
@@ -362,7 +362,7 @@
<li><p class=''><a class='doclink' href='#juneau-rest-server.BuiltInParameters'>Built-in Parameters</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.CustomSerializersAndParsers'>Custom Serializers and Parsers</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.UsingWithOsgi'>Using with OSGi</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-server.UnitTesting'>Serverless Unit Testing</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-server.UnitTesting'>Serverless Unit Testing</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.Injection'>Using with Spring and Injection frameworks</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.HTTP2'>Using HTTP/2 features</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.OtherNotes'>Other Notes</a></p>
@@ -371,22 +371,22 @@
<ol>
<li><p class=''><a class='doclink' href='#juneau-rest-server-jaxrs.BaseProvider'>Juneau JAX-RS Provider</a></p>
</ol>
- <li><p class='toc2 updated'><a class='doclink' href='#juneau-rest-client'>juneau-rest-client</a></p>
+ <li><p class='toc2 '><a class='doclink' href='#juneau-rest-client'>juneau-rest-client</a></p>
<ol>
- <li><p class='new'><a class='doclink' href='#juneau-rest-client.RestProxies'>REST Proxies</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-client.RestProxies'>REST Proxies</a></p>
<ol>
- <li><p class='new'><a class='doclink' href='#juneau-rest-client.RestProxies.RemoteResource'>@RemoteResource</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-client.RestProxies.RemoteMethod'>@RemoteMethod</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-client.RestProxies.Body'>@Body</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-client.RestProxies.FormData'>@FormData</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-client.RestProxies.Query'>@Query</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-client.RestProxies.Header'>@Header</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-client.RestProxies.Path'>@Path</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-client.RestProxies.Request'>@Request</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-client.RestProxies.Response'>@Response</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-client.RestProxies.RemoteResource'>@RemoteResource</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-client.RestProxies.RemoteMethod'>@RemoteMethod</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-client.RestProxies.Body'>@Body</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-client.RestProxies.FormData'>@FormData</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-client.RestProxies.Query'>@Query</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-client.RestProxies.Header'>@Header</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-client.RestProxies.Path'>@Path</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-client.RestProxies.Request'>@Request</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-client.RestProxies.Response'>@Response</a></p>
</ol>
<li><p class=''><a class='doclink' href='#juneau-rest-client.SSL'>SSL Support</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-client.Authentication'>Authentication</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-client.Authentication'>Authentication</a></p>
<ol>
<li><p class=''><a class='doclink' href='#juneau-rest-client.Authentication.BASIC'>BASIC Authentication</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-client.Authentication.FORM'>FORM-based Authentication</a></p>
@@ -397,7 +397,7 @@
<li><p class=''><a class='doclink' href='#juneau-rest-client.Debugging'>Debugging</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-client.Logging'>Logging</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-client.Interceptors'>Interceptors</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-rest-client.UnitTesting'>Serverless Unit Testing</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-rest-client.UnitTesting'>Serverless Unit Testing</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-client.Other'>Other Useful Methods</a></p>
</ol>
<li><p class='toc2 '><a class='doclink' href='#juneau-microservice-server'>juneau-microservice-server</a></p>
@@ -423,7 +423,7 @@
<ol>
<li><p class=''><a class='doclink' href='#juneau-microservice-server.RestMicroservice.Extending'>Extending RestMicroservice</a></p>
</ol>
- <li><p class='new'><a class='doclink' href='#juneau-microservice-server.UiCustomization'>UI Customization</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-microservice-server.UiCustomization'>UI Customization</a></p>
</ol>
<li><p class='toc2 '><a class='doclink' href='#juneau-examples-core'>juneau-examples-core</a></p>
<li><p class='toc2 '><a class='doclink' href='#juneau-examples-rest'>juneau-examples-rest</a></p>
@@ -434,9 +434,9 @@
<li><p class=''><a class='doclink' href='#juneau-examples-rest.MethodExampleResource'>MethodExampleResource</a></p>
<li><p class=''><a class='doclink' href='#juneau-examples-rest.UrlEncodedFormResource'>UrlEncodedFormResource</a></p>
<li><p class=''><a class='doclink' href='#juneau-examples-rest.RequestEchoResource'>RequestEchoResource</a></p>
- <li><p class='new'><a class='doclink' href='#juneau-examples-rest.PetStoreResource'>PetStoreResource</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-examples-rest.PetStoreResource'>PetStoreResource</a></p>
<li><p class=''><a class='doclink' href='#juneau-examples-rest.AddressBookResource'>AddressBookResource</a></p>
- <li><p class=''><a class='doclink' href='#juneau-examples-rest.SampleRemoteableServlet'>SampleRemoteInterfaceServlet</a></p>
+ <li><p class=''><a class='doclink' href='#juneau-examples-rest.SampleRemoteableServlet'>SampleRrpcServlet</a></p>
<li><p class=''><a class='doclink' href='#juneau-examples-rest.TempDirResource'>TempDirResource</a></p>
<li><p class=''><a class='doclink' href='#juneau-examples-rest.AtomFeedResource'>AtomFeedResource</a></p>
<li><p class=''><a class='doclink' href='#juneau-examples-rest.DockerRegistryResource'>DockerRegistryResource</a></p>
@@ -1029,7 +1029,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.Marshalls' id='juneau-marshall.Marshalls'>2.3 - Marshalls</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.Marshalls' id='juneau-marshall.Marshalls'>2.3 - Marshalls</a></h3>
<div class='topic'><!-- START: 2.3 - juneau-marshall.Marshalls -->
<p>
{@link org.apache.juneau.marshall.Marshall Marshalls} are simple pairings of a {@link org.apache.juneau.serializer.Serializer}
@@ -1094,7 +1094,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.HttpPartSerializers' id='juneau-marshall.HttpPartSerializers'>2.4 - HTTP Part Serializers</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.HttpPartSerializers' id='juneau-marshall.HttpPartSerializers'>2.4 - HTTP Part Serializers</a></h3>
<div class='topic'><!-- START: 2.4 - juneau-marshall.HttpPartSerializers -->
<p>
There is a separate set of serializers for serializing HTTP parts (query, form-data, headers, path variables, and plain-text request bodies).
@@ -1139,7 +1139,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.HttpPartParsers' id='juneau-marshall.HttpPartParsers'>2.5 - HTTP Part Parsers</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.HttpPartParsers' id='juneau-marshall.HttpPartParsers'>2.5 - HTTP Part Parsers</a></h3>
<div class='topic'><!-- START: 2.5 - juneau-marshall.HttpPartParsers -->
<p>
There is a separate set of parsers for parsing HTTP parts (query, form-data, headers, path variables, and plain-text request bodies).
@@ -1307,7 +1307,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic updated' onclick='toggle(this)'><a href='#juneau-marshall.ConfigurableProperties.CommonSerializer' id='juneau-marshall.ConfigurableProperties.CommonSerializer'>2.6.2 - Common Serializer Properties</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.ConfigurableProperties.CommonSerializer' id='juneau-marshall.ConfigurableProperties.CommonSerializer'>2.6.2 - Common Serializer Properties</a></h4>
<div class='topic'><!-- START: 2.6.2 - juneau-marshall.ConfigurableProperties.CommonSerializer -->
<p>
In addition to the common properties above, the following properties are common to all serializers:
@@ -1903,7 +1903,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic updated' onclick='toggle(this)'><a href='#juneau-marshall.Transforms.PerMediaTypePojoSwaps' id='juneau-marshall.Transforms.PerMediaTypePojoSwaps'>2.10.2 - Per-media-type PojoSwaps</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.Transforms.PerMediaTypePojoSwaps' id='juneau-marshall.Transforms.PerMediaTypePojoSwaps'>2.10.2 - Per-media-type PojoSwaps</a></h4>
<div class='topic'><!-- START: 2.10.2 - juneau-marshall.Transforms.PerMediaTypePojoSwaps -->
<p>
Swaps can also be defined per-media-type.
@@ -2055,7 +2055,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.Transforms.SwapAnnotation' id='juneau-marshall.Transforms.SwapAnnotation'>2.10.4 - @Swap Annotation</a></h4>
+<h4 class='topic updated' onclick='toggle(this)'><a href='#juneau-marshall.Transforms.SwapAnnotation' id='juneau-marshall.Transforms.SwapAnnotation'>2.10.4 - @Swap Annotation</a></h4>
<div class='topic'><!-- START: 2.10.4 - juneau-marshall.Transforms.SwapAnnotation -->
<p>
{@link org.apache.juneau.annotation.Swap @Swap} can be used to associate a swap class using an
@@ -2109,11 +2109,40 @@
</p>
<p>
The <ja>@Swap</ja> annotation can also be used on getters and setters as well to apply a swap
- to individual property values
+ to individual property values:
</p>
<p class='bpcode w800'>
- <ja>@BeanProperty</ja>(swap=MyPojoSwap.<jk>class</jk>)
- <jk>public</jk> MyPojo getMyPojo();
+ <jk>public class</jk> MyBean {
+ <jk>private</jk> MyPojo <jf>myPojo</jf>;
+
+ <jc>// Swap applied to bean property.
+ <ja>@BeanProperty</ja>(swap=MyPojoSwap.<jk>class</jk>)
+ <jk>public</jk> MyPojo getMyPojo() {
+ <jk>return</jk> <jf>myPojo</jf>;
+ }
+ }
+</p>
+<p>
+ When applied to bean properties, the swap annotation need only be applied to either the getter, setter, or field.
+</p>
+<p>
+ The swap annotation can also be applied to the private field of a bean property, like so:
+</p>
+<p class='bpcode w800'>
+ <jk>public class</jk> MyBean {
+
+ <ja>@BeanProperty</ja>(swap=MyPojoSwap.<jk>class</jk>)
+ <jk>private</jk> MyPojo <jf>myPojo</jf>;
+
+ <jk>public</jk> MyPojo getMyPojo() {
+ <jk>return</jk> <jf>myPojo</jf>;
+ }
+
+ <jk>public</jk> MyBean setMyPojo(MyPojo myPojo) {
+ <jk>this</jk>.<jf>myPojo</jf> = myPojo;
+ <jk>return this</jk>;
+ }
+ }
</p>
</div><!-- END: 2.10.4 - juneau-marshall.Transforms.SwapAnnotation -->
@@ -3755,7 +3784,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic updated' onclick='toggle(this)'><a href='#juneau-marshall.URIs' id='juneau-marshall.URIs'>2.16 - URIs</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.URIs' id='juneau-marshall.URIs'>2.16 - URIs</a></h3>
<div class='topic'><!-- START: 2.16 - juneau-marshall.URIs -->
<p>
Juneau serializers have sophisticated support for transforming relative URIs to absolute form.
@@ -4011,7 +4040,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic updated' onclick='toggle(this)'><a href='#juneau-marshall.PojoCategories' id='juneau-marshall.PojoCategories'>2.18 - POJO Categories</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.PojoCategories' id='juneau-marshall.PojoCategories'>2.18 - POJO Categories</a></h3>
<div class='topic'><!-- START: 2.18 - juneau-marshall.PojoCategories -->
<p>
The following chart shows POJOs categorized into groups and whether they can be serialized or parsed:
@@ -7092,7 +7121,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.Methodology' id='juneau-marshall.HtmlDetails.Methodology'>2.21.1 - HTML Methodology</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.Methodology' id='juneau-marshall.HtmlDetails.Methodology'>2.21.1 - HTML Methodology</a></h4>
<div class='topic'><!-- START: 2.21.1 - juneau-marshall.HtmlDetails.Methodology -->
<p>
The following examples show how different data types are represented in HTML.
@@ -7605,7 +7634,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.Serializers' id='juneau-marshall.HtmlDetails.Serializers'>2.21.2 - HTML Serializers</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.Serializers' id='juneau-marshall.HtmlDetails.Serializers'>2.21.2 - HTML Serializers</a></h4>
<div class='topic'><!-- START: 2.21.2 - juneau-marshall.HtmlDetails.Serializers -->
<p>
The {@link org.apache.juneau.html.HtmlSerializer} class is used to serialize POJOs into HTML.
@@ -7664,7 +7693,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.Parsers' id='juneau-marshall.HtmlDetails.Parsers'>2.21.3 - HTML Parsers</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.Parsers' id='juneau-marshall.HtmlDetails.Parsers'>2.21.3 - HTML Parsers</a></h4>
<div class='topic'><!-- START: 2.21.3 - juneau-marshall.HtmlDetails.Parsers -->
<p>
The {@link org.apache.juneau.html.HtmlParser} class is used to parse HTML into POJOs.
@@ -7690,7 +7719,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.HtmlAnnotation' id='juneau-marshall.HtmlDetails.HtmlAnnotation'>2.21.4 - @Html Annotation</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.HtmlAnnotation' id='juneau-marshall.HtmlDetails.HtmlAnnotation'>2.21.4 - @Html Annotation</a></h4>
<div class='topic'><!-- START: 2.21.4 - juneau-marshall.HtmlDetails.HtmlAnnotation -->
<p>
The {@link org.apache.juneau.html.annotation.Html @Html} annotation can be used to customize how POJOs are serialized to HTML on a per-class/field/method basis.
@@ -7751,7 +7780,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.HtmlRenderAnnotation' id='juneau-marshall.HtmlDetails.HtmlRenderAnnotation'>2.21.5 - @Html(render) Annotation</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.HtmlRenderAnnotation' id='juneau-marshall.HtmlDetails.HtmlRenderAnnotation'>2.21.5 - @Html(render) Annotation</a></h4>
<div class='topic'><!-- START: 2.21.5 - juneau-marshall.HtmlDetails.HtmlRenderAnnotation -->
<p>
The {@link org.apache.juneau.html.annotation.Html#render @Html(render)} annotation allows for custom rendering of bean property values when serialized as HTML.
@@ -7858,7 +7887,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.HtmlDocSerializer' id='juneau-marshall.HtmlDetails.HtmlDocSerializer'>2.21.6 - HtmlDocSerializer</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.HtmlDocSerializer' id='juneau-marshall.HtmlDetails.HtmlDocSerializer'>2.21.6 - HtmlDocSerializer</a></h4>
<div class='topic'><!-- START: 2.21.6 - juneau-marshall.HtmlDetails.HtmlDocSerializer -->
<p>
{@link org.apache.juneau.html.HtmlDocSerializer} is an extension of {@link org.apache.juneau.html.HtmlSerializer}
@@ -7915,7 +7944,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.BasicHtmlDocTemplate' id='juneau-marshall.HtmlDetails.BasicHtmlDocTemplate'>2.21.7 - BasicHtmlDocTemplate</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.BasicHtmlDocTemplate' id='juneau-marshall.HtmlDetails.BasicHtmlDocTemplate'>2.21.7 - BasicHtmlDocTemplate</a></h4>
<div class='topic'><!-- START: 2.21.7 - juneau-marshall.HtmlDetails.BasicHtmlDocTemplate -->
<p>
The {@link org.apache.juneau.html.BasicHtmlDocTemplate} class defines a default template for HTML documents
@@ -7954,7 +7983,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.CustomTemplates' id='juneau-marshall.HtmlDetails.CustomTemplates'>2.21.8 - Custom Templates</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.CustomTemplates' id='juneau-marshall.HtmlDetails.CustomTemplates'>2.21.8 - Custom Templates</a></h4>
<div class='topic'><!-- START: 2.21.8 - juneau-marshall.HtmlDetails.CustomTemplates -->
<p>
Custom page templates can be created by implementing the {@link org.apache.juneau.html.HtmlDocTemplate}
@@ -7974,7 +8003,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.HtmlSchema' id='juneau-marshall.HtmlDetails.HtmlSchema'>2.21.9 - HTML-Schema Support</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.HtmlDetails.HtmlSchema' id='juneau-marshall.HtmlDetails.HtmlSchema'>2.21.9 - HTML-Schema Support</a></h4>
<div class='topic'><!-- START: 2.21.9 - juneau-marshall.HtmlDetails.HtmlSchema -->
<p>
The {@link org.apache.juneau.html.HtmlSchemaSerializer} class is the HTML-equivalent to the
@@ -8556,7 +8585,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.UrlEncodingDetails.UrlEncodingAnnotation' id='juneau-marshall.UrlEncodingDetails.UrlEncodingAnnotation'>2.23.4 - @UrlEncoding Annotation</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.UrlEncodingDetails.UrlEncodingAnnotation' id='juneau-marshall.UrlEncodingDetails.UrlEncodingAnnotation'>2.23.4 - @UrlEncoding Annotation</a></h4>
<div class='topic'><!-- START: 2.23.4 - juneau-marshall.UrlEncodingDetails.UrlEncodingAnnotation -->
<p>
The {@link org.apache.juneau.urlencoding.annotation.UrlEncoding @UrlEncoding} annotation
@@ -8579,7 +8608,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.MsgPackDetails' id='juneau-marshall.MsgPackDetails'>2.24 - MessagePack Details</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.MsgPackDetails' id='juneau-marshall.MsgPackDetails'>2.24 - MessagePack Details</a></h3>
<div class='topic'><!-- START: 2.24 - juneau-marshall.MsgPackDetails -->
<p>
Juneau supports converting arbitrary POJOs to and from MessagePack using ultra-efficient serializers
@@ -8648,7 +8677,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.OpenApiDetails' id='juneau-marshall.OpenApiDetails'>2.25 - OpenAPI Details</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.OpenApiDetails' id='juneau-marshall.OpenApiDetails'>2.25 - OpenAPI Details</a></h3>
<div class='topic'><!-- START: 2.25 - juneau-marshall.OpenApiDetails -->
<p>
Juneau supports converting arbitrary POJOs to and from strings using OpenAPI-based schema rules.
@@ -8683,7 +8712,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.OpenApiDetails.Methodology' id='juneau-marshall.OpenApiDetails.Methodology'>2.25.1 - OpenAPI Methodology</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.OpenApiDetails.Methodology' id='juneau-marshall.OpenApiDetails.Methodology'>2.25.1 - OpenAPI Methodology</a></h4>
<div class='topic'><!-- START: 2.25.1 - juneau-marshall.OpenApiDetails.Methodology -->
<p>
Unlike the other Juneau serializers and parsers that convert input and output directly to-and-from POJOs,
@@ -8829,7 +8858,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.OpenApiDetails.Serializers' id='juneau-marshall.OpenApiDetails.Serializers'>2.25.2 - OpenAPI Serializers</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.OpenApiDetails.Serializers' id='juneau-marshall.OpenApiDetails.Serializers'>2.25.2 - OpenAPI Serializers</a></h4>
<div class='topic'><!-- START: 2.25.2 - juneau-marshall.OpenApiDetails.Serializers -->
<p>
The {@link org.apache.juneau.oapi.OpenApiSerializer} class is used to convert POJOs to HTTP parts.
@@ -9268,7 +9297,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall.OpenApiDetails.Parsers' id='juneau-marshall.OpenApiDetails.Parsers'>2.25.3 - OpenAPI Parsers</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall.OpenApiDetails.Parsers' id='juneau-marshall.OpenApiDetails.Parsers'>2.25.3 - OpenAPI Parsers</a></h4>
<div class='topic'><!-- START: 2.25.3 - juneau-marshall.OpenApiDetails.Parsers -->
<p>
The {@link org.apache.juneau.oapi.OpenApiParser} class is used to convert HTTP parts back into POJOs.
@@ -9910,7 +9939,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-marshall-rdf.RdfDetails.RdfAnnotation' id='juneau-marshall-rdf.RdfDetails.RdfAnnotation'>3.1.3 - @Rdf Annotation</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-marshall-rdf.RdfDetails.RdfAnnotation' id='juneau-marshall-rdf.RdfDetails.RdfAnnotation'>3.1.3 - @Rdf Annotation</a></h4>
<div class='topic'><!-- START: 3.1.3 - juneau-marshall-rdf.RdfDetails.RdfAnnotation -->
<p>
The {@link org.apache.juneau.jena.annotation.Rdf @Rdf} annotation
@@ -10689,7 +10718,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-dto.SwaggerUI' id='juneau-dto.SwaggerUI'>4.4 - Swagger UI</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-dto.SwaggerUI' id='juneau-dto.SwaggerUI'>4.4 - Swagger UI</a></h3>
<div class='topic'><!-- START: 4.4 - juneau-dto.SwaggerUI -->
<p>
The {@link org.apache.juneau.dto.swagger.ui.SwaggerUI} class is a DTO class for generating Swagger user interfaces
@@ -13237,7 +13266,7 @@
RequestEchoResource.<jk>class</jk>,
TempDirResource.<jk>class</jk>,
AddressBookResource.<jk>class</jk>,
- SampleRemoteInterfaceServlet.<jk>class</jk>,
+ SampleRrpcServlet.<jk>class</jk>,
PhotosResource.<jk>class</jk>,
AtomFeedResource.<jk>class</jk>,
JsonSchemaResource.<jk>class</jk>,
@@ -13592,7 +13621,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic updated' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod' id='juneau-rest-server.RestMethod'>7.6 - @RestMethod</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod' id='juneau-rest-server.RestMethod'>7.6 - @RestMethod</a></h3>
<div class='topic'><!-- START: 7.6 - juneau-rest-server.RestMethod -->
<p>
REST Java methods are identified on REST servlets using the
@@ -14307,23 +14336,14 @@
<!-- ==================================================================================================== -->
-<h4 class='topic updated' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.ReaderResource' id='juneau-rest-server.RestMethod.ReaderResource'>7.6.11 - ReaderResource</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.ReaderResource' id='juneau-rest-server.RestMethod.ReaderResource'>7.6.11 - ReaderResource</a></h4>
<div class='topic'><!-- START: 7.6.11 - juneau-rest-server.RestMethod.ReaderResource -->
<p>
- The {@link org.apache.juneau.rest.helper.ReaderResource} class is a convenience object for defining thread-safe
+ The {@link org.apache.juneau.http.ReaderResource} class is a convenience object for defining thread-safe
reusable character-based responses.
<br>In essence, it's a container for character data with optional response headers and support for
resolving SVL variables.
</p>
-<ul class='doctree'>
- <li class='jc'>{@link org.apache.juneau.rest.helper.ReaderResourceBuilder}
- <ul>
- <li class='jm'>{@link org.apache.juneau.rest.helper.ReaderResourceBuilder#contents(Object...) contents(Object...)}
- <li class='jm'>{@link org.apache.juneau.rest.helper.ReaderResourceBuilder#header(String,Object) header(String,Object)}
- <li class='jm'>{@link org.apache.juneau.rest.helper.ReaderResourceBuilder#mediaType(MediaType) mediaType(MediaType)}
- <li class='jm'>{@link org.apache.juneau.rest.helper.ReaderResourceBuilder#varResolver(VarResolverSession) varResolver(VarResolverSession)}
- </ul>
-</ul>
<p>
The class is annotated with {@link org.apache.juneau.http.annotation.Response @Response}
@@ -14347,20 +14367,12 @@
<!-- ==================================================================================================== -->
-<h4 class='topic updated' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.StreamResource' id='juneau-rest-server.RestMethod.StreamResource'>7.6.12 - StreamResource</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.StreamResource' id='juneau-rest-server.RestMethod.StreamResource'>7.6.12 - StreamResource</a></h4>
<div class='topic'><!-- START: 7.6.12 - juneau-rest-server.RestMethod.StreamResource -->
<p>
- The {@link org.apache.juneau.rest.helper.StreamResource} class is the binary equivalent to the {@link org.apache.juneau.rest.helper.ReaderResource} object.
+ The {@link org.apache.juneau.http.StreamResource} class is the binary equivalent to the {@link org.apache.juneau.http.ReaderResource} object.
<br>In essence, it's a container for binary data with optional response headers.
</p>
-<ul class='doctree'>
- <li class='jc'>{@link org.apache.juneau.rest.helper.StreamResourceBuilder}
- <ul>
- <li class='jm'>{@link org.apache.juneau.rest.helper.StreamResourceBuilder#contents(Object...) contents(Object...)}
- <li class='jm'>{@link org.apache.juneau.rest.helper.StreamResourceBuilder#header(String,Object) header(String,Object)}
- <li class='jm'>{@link org.apache.juneau.rest.helper.StreamResourceBuilder#mediaType(MediaType) mediaType(MediaType)}
- </ul>
-</ul>
<p>
The class is annotated with {@link org.apache.juneau.http.annotation.Response @Response}
which allows it to be returned as responses by REST methods.
@@ -14443,7 +14455,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.PredefinedResponses' id='juneau-rest-server.RestMethod.PredefinedResponses'>7.6.14 - Predefined Responses</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.PredefinedResponses' id='juneau-rest-server.RestMethod.PredefinedResponses'>7.6.14 - Predefined Responses</a></h4>
<div class='topic'><!-- START: 7.6.14 - juneau-rest-server.RestMethod.PredefinedResponses -->
<p>
Predefined response beans are provided for all standard HTTP responses.
@@ -14558,7 +14570,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.PredefinedExceptions' id='juneau-rest-server.RestMethod.PredefinedExceptions'>7.6.15 - Predefined Exceptions</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.PredefinedExceptions' id='juneau-rest-server.RestMethod.PredefinedExceptions'>7.6.15 - Predefined Exceptions</a></h4>
<div class='topic'><!-- START: 7.6.15 - juneau-rest-server.RestMethod.PredefinedExceptions -->
<p>
Exceptions are defined for all standardized HTTP responses.
@@ -14630,7 +14642,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.PredefinedHelperBeans' id='juneau-rest-server.RestMethod.PredefinedHelperBeans'>7.6.16 - Predefined Helper Beans</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.PredefinedHelperBeans' id='juneau-rest-server.RestMethod.PredefinedHelperBeans'>7.6.16 - Predefined Helper Beans</a></h4>
<div class='topic'><!-- START: 7.6.16 - juneau-rest-server.RestMethod.PredefinedHelperBeans -->
<p>
The {@link org.apache.juneau.rest.helper} package contains several predefined beans to help when constructing
@@ -14641,13 +14653,9 @@
<ul>
<li class='jc'>{@link org.apache.juneau.rest.helper.BeanDescription}
<li class='jc'>{@link org.apache.juneau.rest.helper.ChildResourceDescriptions}
- <li class='jc'>{@link org.apache.juneau.rest.helper.ReaderResource}
- <li class='jc'>{@link org.apache.juneau.rest.helper.ReaderResourceBuilder}
<li class='jc'>{@link org.apache.juneau.rest.helper.ResourceDescription}
<li class='jc'>{@link org.apache.juneau.rest.helper.ResourceDescriptions}
<li class='jc'>{@link org.apache.juneau.rest.helper.SeeOtherRoot}
- <li class='jc'>{@link org.apache.juneau.rest.helper.StreamResource}
- <li class='jc'>{@link org.apache.juneau.rest.helper.StreamResourceBuilder}
</ul>
</ul>
@@ -14808,7 +14816,7 @@
MethodExampleResource.<jk>class</jk>,
RequestEchoResource.<jk>class</jk>,
AddressBookResource.<jk>class</jk>,
- SampleRemoteInterfaceServlet.<jk>class</jk>,
+ SampleRrpcServlet.<jk>class</jk>,
DtoExamples.<jk>class</jk>,
PhotosResource.<jk>class</jk>,
SqlQueryResource.<jk>class</jk>,
@@ -14917,9 +14925,9 @@
<ul class='doctree'>
<li class='jc'>{@link org.apache.juneau.rest.client.RestClient}
<ul>
- <li class='jm'>{@link org.apache.juneau.rest.client.RestClient#getRemoteInterface(Class) getRemoteInterface(Class)}
- <li class='jm'>{@link org.apache.juneau.rest.client.RestClient#getRemoteInterface(Class,Object) getRemoteInterface(Class,Object)}
- <li class='jm'>{@link org.apache.juneau.rest.client.RestClient#getRemoteInterface(Class,Object,Serializer,Parser) getRemoteInterface(Class,Object,Serializer,Parser)}
+ <li class='jm'>{@link org.apache.juneau.rest.client.RestClient#getRrpcInterface(Class) getRrpcInterface(Class)}
+ <li class='jm'>{@link org.apache.juneau.rest.client.RestClient#getRrpcInterface(Class,Object) getRrpcInterface(Class,Object)}
+ <li class='jm'>{@link org.apache.juneau.rest.client.RestClient#getRrpcInterface(Class,Object,Serializer,Parser) getRrpcInterface(Class,Object,Serializer,Parser)}
</ul>
</ul>
<p>
@@ -14939,7 +14947,7 @@
.build();
<jc>// Create a proxy interface.</jc>
- IAddressBook ab = client.getRemoteInterface(IAddressBook.<jk>class</jk>);
+ IAddressBook ab = client.getRrpcInterface(IAddressBook.<jk>class</jk>);
<jc>// Invoke a method on the server side and get the returned result.</jc>
Person p = ab.createPerson(
@@ -14986,9 +14994,9 @@
</p>
<ol class='spaced-list'>
<li>
- Extending from {@link org.apache.juneau.rest.remote.RemoteInterfaceServlet}.
+ Extending from {@link org.apache.juneau.rest.remote.RrpcServlet}.
<li>
- Using a <code><ja>@RestMethod</ja>(name=<jsf>PROXY</jsf>)</code> annotation on a Java method.
+ Using a <code><ja>@RestMethod</ja>(name=<jsf>RRPC</jsf>)</code> annotation on a Java method.
</ol>
<p>
In either case, the proxy communications layer is pure REST.
@@ -14998,21 +15006,21 @@
a browser with no coding involved.
</p>
-<h5 class='topic'>RemoteInterfaceServlet</h5>
+<h5 class='topic'>RrpcServlet</h5>
<p>
- The {@link org.apache.juneau.rest.remote.RemoteInterfaceServlet} class is a simple specialized servlet with an abstract
+ The {@link org.apache.juneau.rest.remote.RrpcServlet} class is a simple specialized servlet with an abstract
<code>getServiceMap()</code> method to define the server-side POJOs:
</p>
<p class='bpcode w800'>
<ja>@RestResource</ja>(
path=<js>"/remote"</js>
)
- <jk>public class</jk> SampleRemoteInterfaceServlet <jk>extends</jk> RemoteInterfaceServlet {
+ <jk>public class</jk> SampleRrpcServlet <jk>extends</jk> RrpcServlet {
<jc>// Our server-side POJO.</jc>
<jk>private</jk> AddressBook <jf>addressBook</jf> = <jk>new</jk> AddressBook();
- <ja>@Override</ja> <jc>/* RemoteInterfaceServlet */</jc>
+ <ja>@Override</ja> <jc>/* RrpcServlet */</jc>
<jk>protected</jk> Map<Class<?>,Object> getServiceMap() <jk>throws</jk> Exception {
Map<Class<?>,Object> m = <jk>new</jk> LinkedHashMap<Class<?>,Object>();
@@ -15026,22 +15034,22 @@
}
</p>
-<h5 class='topic'>@RestMethod(name=PROXY)</h5>
+<h5 class='topic'>@RestMethod(name=RRPC)</h5>
<p>
- The <code><ja>@RestMethod</ja>(name=<jsf>PROXY</jsf>)</code> approach is easier if you only have a single
+ The <code><ja>@RestMethod</ja>(name=<jsf>RRPC</jsf>)</code> approach is easier if you only have a single
interface you want to expose.
<br>You simply define a Java method whose return type is an interface, and return the implementation of that
interface:
</p>
<p class='bpcode w800'>
<jc>// Our exposed interface.</jc>
- <ja>@RestMethod</ja>(name=<jsf>PROXY</jsf>, path=<js>"/addressbookproxy/*"</js>)
+ <ja>@RestMethod</ja>(name=<jsf>RRPC</jsf>, path=<js>"/addressbookproxy/*"</js>)
<jk>public</jk> IAddressBook getProxy() {
<jk>return</jk> addressBook;
}
</p>
-<h5 class='topic'>RemoteInterfaceServlet in a browser</h5>
+<h5 class='topic'>RrpcServlet in a browser</h5>
<p>
If you point your browser to the servlet above, you get a list of available interfaces:
</p>
@@ -15145,7 +15153,7 @@
<jc>// Allow us to use method=POST from a browser.</jc>
allowedMethodParams=<js>"*"</js>
)
- <jk>public class</jk> SampleRemoteInterfaceServlet <jk>extends</jk> RemoteInterfaceServlet {
+ <jk>public class</jk> SampleRrpcServlet <jk>extends</jk> RrpcServlet {
</p>
<p>
For example, to invoke the <code>getPeople()</code> method on our bean:
@@ -15183,7 +15191,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.OpenApiSchemaPartParsing' id='juneau-rest-server.OpenApiSchemaPartParsing'>7.8 - OpenAPI Schema Part Parsing</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.OpenApiSchemaPartParsing' id='juneau-rest-server.OpenApiSchemaPartParsing'>7.8 - OpenAPI Schema Part Parsing</a></h3>
<div class='topic'><!-- START: 7.8 - juneau-rest-server.OpenApiSchemaPartParsing -->
<p>
Parameters annotated with any of the following are parsed using the registered {@link org.apache.juneau.oapi.OpenApiParser} and
@@ -15298,7 +15306,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.OpenApiSchemaPartSerializing' id='juneau-rest-server.OpenApiSchemaPartSerializing'>7.9 - OpenAPI Schema Part Serializing</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.OpenApiSchemaPartSerializing' id='juneau-rest-server.OpenApiSchemaPartSerializing'>7.9 - OpenAPI Schema Part Serializing</a></h3>
<div class='topic'><!-- START: 7.9 - juneau-rest-server.OpenApiSchemaPartSerializing -->
<p>
Parameters annotated with any of the following are serialized using the registered {@link org.apache.juneau.oapi.OpenApiSerializer} and
@@ -15370,7 +15378,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations' id='juneau-rest-server.HttpPartAnnotations'>7.10 - HTTP-Part Annotations</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations' id='juneau-rest-server.HttpPartAnnotations'>7.10 - HTTP-Part Annotations</a></h3>
<div class='topic'><!-- START: 7.10 - juneau-rest-server.HttpPartAnnotations -->
<p>
The annotations used for defining the schema for request HTTP parts are:
@@ -15398,8 +15406,8 @@
The sub-annotations used in the annotation above are:
</p>
<ul class='doctree'>
- <li class='ja'>{@link org.apache.juneau.http.annotation.Schema Schema}
- <li class='ja'>{@link org.apache.juneau.http.annotation.Items Items}
+ <li class='ja'>{@link org.apache.juneau.jsonschema.annotation.Schema Schema}
+ <li class='ja'>{@link org.apache.juneau.jsonschema.annotation.Items Items}
</ul>
<h5 class='section'>Other Notes:</h5>
@@ -15414,7 +15422,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.Body' id='juneau-rest-server.HttpPartAnnotations.Body'>7.10.1 - @Body</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.Body' id='juneau-rest-server.HttpPartAnnotations.Body'>7.10.1 - @Body</a></h4>
<div class='topic'><!-- START: 7.10.1 - juneau-rest-server.HttpPartAnnotations.Body -->
<p>
The {@link org.apache.juneau.http.annotation.Body @Body} annotation is used to identify POJOs to be used as the body of an HTTP request.
@@ -15598,7 +15606,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.FormData' id='juneau-rest-server.HttpPartAnnotations.FormData'>7.10.2 - @FormData</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.FormData' id='juneau-rest-server.HttpPartAnnotations.FormData'>7.10.2 - @FormData</a></h4>
<div class='topic'><!-- START: 7.10.2 - juneau-rest-server.HttpPartAnnotations.FormData -->
<p>
The {@link org.apache.juneau.http.annotation.FormData @FormData} annotation is used to retrieve request form post entries.
@@ -15772,7 +15780,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.HasFormData' id='juneau-rest-server.HttpPartAnnotations.HasFormData'>7.10.3 - @HasFormData</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.HasFormData' id='juneau-rest-server.HttpPartAnnotations.HasFormData'>7.10.3 - @HasFormData</a></h4>
<div class='topic'><!-- START: 7.10.3 - juneau-rest-server.HttpPartAnnotations.HasFormData -->
<p>
This annotation can be used to detect the existence of a parameter when it's not set to a particular value.
@@ -15844,7 +15852,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.Query' id='juneau-rest-server.HttpPartAnnotations.Query'>7.10.4 - @Query</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.Query' id='juneau-rest-server.HttpPartAnnotations.Query'>7.10.4 - @Query</a></h4>
<div class='topic'><!-- START: 7.10.4 - juneau-rest-server.HttpPartAnnotations.Query -->
<p>
The {@link org.apache.juneau.http.annotation.Query @Query} annotation is used to retrieve request URL query parameters.
@@ -16018,7 +16026,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.HasQuery' id='juneau-rest-server.HttpPartAnnotations.HasQuery'>7.10.5 - @HasQuery</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.HasQuery' id='juneau-rest-server.HttpPartAnnotations.HasQuery'>7.10.5 - @HasQuery</a></h4>
<div class='topic'><!-- START: 7.10.5 - juneau-rest-server.HttpPartAnnotations.HasQuery -->
<p>
Identical to {@link org.apache.juneau.http.annotation.HasFormData @HasFormData}, but only checks the existing of the parameter in the URL string, not
@@ -16085,7 +16093,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.Header' id='juneau-rest-server.HttpPartAnnotations.Header'>7.10.6 - @Header</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.Header' id='juneau-rest-server.HttpPartAnnotations.Header'>7.10.6 - @Header</a></h4>
<div class='topic'><!-- START: 7.10.6 - juneau-rest-server.HttpPartAnnotations.Header -->
<p>
The {@link org.apache.juneau.http.annotation.Header @Header} annotation is used to retrieve request headers.
@@ -16244,7 +16252,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.Path' id='juneau-rest-server.HttpPartAnnotations.Path'>7.10.7 - @Path</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.Path' id='juneau-rest-server.HttpPartAnnotations.Path'>7.10.7 - @Path</a></h4>
<div class='topic'><!-- START: 7.10.7 - juneau-rest-server.HttpPartAnnotations.Path -->
<p>
The {@link org.apache.juneau.http.annotation.Path @Path} annotation is used to retrieve request path parameters.
@@ -16410,7 +16418,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.Request' id='juneau-rest-server.HttpPartAnnotations.Request'>7.10.8 - @Request</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.Request' id='juneau-rest-server.HttpPartAnnotations.Request'>7.10.8 - @Request</a></h4>
<div class='topic'><!-- START: 7.10.8 - juneau-rest-server.HttpPartAnnotations.Request -->
<p>
The {@link org.apache.juneau.http.annotation.Request @Request} annotation can be applied to a parameter interface type of a <ja>@RestMethod</ja>-annotated method
@@ -16499,7 +16507,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.Response' id='juneau-rest-server.HttpPartAnnotations.Response'>7.10.9 - @Response</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.Response' id='juneau-rest-server.HttpPartAnnotations.Response'>7.10.9 - @Response</a></h4>
<div class='topic'><!-- START: 7.10.9 - juneau-rest-server.HttpPartAnnotations.Response -->
<p>
The {@link org.apache.juneau.http.annotation.Response @Response} annotation is used to identify schema information about an HTTP response.
@@ -16894,7 +16902,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.ResponseHeader' id='juneau-rest-server.HttpPartAnnotations.ResponseHeader'>7.10.10 - @ResponseHeader</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.ResponseHeader' id='juneau-rest-server.HttpPartAnnotations.ResponseHeader'>7.10.10 - @ResponseHeader</a></h4>
<div class='topic'><!-- START: 7.10.10 - juneau-rest-server.HttpPartAnnotations.ResponseHeader -->
<p>
The {@link org.apache.juneau.http.annotation.ResponseHeader @ResponseHeader} annotation can be applied to <ja>@RestMethod</ja>-annotated parameters to denote them as an HTTP response headers.
@@ -17010,7 +17018,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.ResponseStatus' id='juneau-rest-server.HttpPartAnnotations.ResponseStatus'>7.10.11 - @ResponseStatus</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HttpPartAnnotations.ResponseStatus' id='juneau-rest-server.HttpPartAnnotations.ResponseStatus'>7.10.11 - @ResponseStatus</a></h4>
<div class='topic'><!-- START: 7.10.11 - juneau-rest-server.HttpPartAnnotations.ResponseStatus -->
<p>
The {@link org.apache.juneau.http.annotation.ResponseStatus @ResponseStatus} annotation annotation can be applied to <ja>@RestMethod</ja>-annotated parameters to denote them as an HTTP response status codes.
@@ -17455,7 +17463,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.URIs' id='juneau-rest-server.URIs'>7.17 - URIs</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.URIs' id='juneau-rest-server.URIs'>7.17 - URIs</a></h3>
<div class='topic'><!-- START: 7.17 - juneau-rest-server.URIs -->
<p>
As mention earlier {@doc juneau-marshall.URIs here}, Juneau serializers have sophisticated support for transforming relative URIs to absolute form.
@@ -18356,7 +18364,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic updated' onclick='toggle(this)'><a href='#juneau-rest-server.RestInfoProvider' id='juneau-rest-server.RestInfoProvider'>7.26 - RestInfoProvider</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.RestInfoProvider' id='juneau-rest-server.RestInfoProvider'>7.26 - RestInfoProvider</a></h3>
<div class='topic'><!-- START: 7.26 - juneau-rest-server.RestInfoProvider -->
<p>
The {@link org.apache.juneau.rest.RestInfoProvider} class is used to find the title
@@ -18404,7 +18412,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic updated' onclick='toggle(this)'><a href='#juneau-rest-server.RestInfoProvider.BasicRestInfoProvider' id='juneau-rest-server.RestInfoProvider.BasicRestInfoProvider'>7.26.1 - BasicRestInfoProvider</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.RestInfoProvider.BasicRestInfoProvider' id='juneau-rest-server.RestInfoProvider.BasicRestInfoProvider'>7.26.1 - BasicRestInfoProvider</a></h4>
<div class='topic'><!-- START: 7.26.1 - juneau-rest-server.RestInfoProvider.BasicRestInfoProvider -->
<p>
The {@link org.apache.juneau.rest.BasicRestInfoProvider} class is the default implementation of the
@@ -18428,7 +18436,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger' id='juneau-rest-server.Swagger'>7.27 - Swagger</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger' id='juneau-rest-server.Swagger'>7.27 - Swagger</a></h3>
<div class='topic'><!-- START: 7.27 - juneau-rest-server.Swagger -->
<p>
One of the most useful features of Juneau is the ability to generate Swagger-based OPTIONS pages for self-documenting designs
@@ -18445,7 +18453,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.BasicRestServlet' id='juneau-rest-server.Swagger.BasicRestServlet'>7.27.1 - BasicRestServlet</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.BasicRestServlet' id='juneau-rest-server.Swagger.BasicRestServlet'>7.27.1 - BasicRestServlet</a></h4>
<div class='topic'><!-- START: 7.27.1 - juneau-rest-server.Swagger.BasicRestServlet -->
<p>
Any subclass of {@link org.apache.juneau.rest.BasicRestServlet} gets an auto-generated Swagger UI when performing an <code>OPTIONS</code>
@@ -18530,7 +18538,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.BasicSwaggerInfo' id='juneau-rest-server.Swagger.BasicSwaggerInfo'>7.27.2 - Basic Swagger Info</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.BasicSwaggerInfo' id='juneau-rest-server.Swagger.BasicSwaggerInfo'>7.27.2 - Basic Swagger Info</a></h4>
<div class='topic'><!-- START: 7.27.2 - juneau-rest-server.Swagger.BasicSwaggerInfo -->
<p>
Let's look at the various parts of the <code>Petstore</code> application Swagger UI to see how they are defined.
@@ -18696,7 +18704,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.Tags' id='juneau-rest-server.Swagger.Tags'>7.27.3 - Tags</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.Tags' id='juneau-rest-server.Swagger.Tags'>7.27.3 - Tags</a></h4>
<div class='topic'><!-- START: 7.27.3 - juneau-rest-server.Swagger.Tags -->
<p>
Tags allow you to group operations into general categories.
@@ -18797,7 +18805,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.Operations' id='juneau-rest-server.Swagger.Operations'>7.27.4 - Operations</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.Operations' id='juneau-rest-server.Swagger.Operations'>7.27.4 - Operations</a></h4>
<div class='topic'><!-- START: 7.27.4 - juneau-rest-server.Swagger.Operations -->
<p>
<ja>@RestMethod</ja>-annotated methods automatically get rendered as Swagger operations:
@@ -18842,7 +18850,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.Parameters' id='juneau-rest-server.Swagger.Parameters'>7.27.5 - Parameters</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.Parameters' id='juneau-rest-server.Swagger.Parameters'>7.27.5 - Parameters</a></h4>
<div class='topic'><!-- START: 7.27.5 - juneau-rest-server.Swagger.Parameters -->
<p>
Expanding operations shows you a list of parameters:
@@ -18982,7 +18990,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.ParameterExamples' id='juneau-rest-server.Swagger.ParameterExamples'>7.27.6 - Parameter Examples</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.ParameterExamples' id='juneau-rest-server.Swagger.ParameterExamples'>7.27.6 - Parameter Examples</a></h4>
<div class='topic'><!-- START: 7.27.6 - juneau-rest-server.Swagger.ParameterExamples -->
<p>
The <code>model</code> select box in the parameters can be expanded to show examples:
@@ -19213,7 +19221,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.Responses' id='juneau-rest-server.Swagger.Responses'>7.27.7 - Responses</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.Responses' id='juneau-rest-server.Swagger.Responses'>7.27.7 - Responses</a></h4>
<div class='topic'><!-- START: 7.27.7 - juneau-rest-server.Swagger.Responses -->
<p>
Under the input parameters are listed the possible responses for the resource:
@@ -19258,7 +19266,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.ResponseExamples' id='juneau-rest-server.Swagger.ResponseExamples'>7.27.8 - Response Examples</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.ResponseExamples' id='juneau-rest-server.Swagger.ResponseExamples'>7.27.8 - Response Examples</a></h4>
<div class='topic'><!-- START: 7.27.8 - juneau-rest-server.Swagger.ResponseExamples -->
<p>
The <code>model</code> select box in the responses can be expanded to show examples:
@@ -19484,7 +19492,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.Models' id='juneau-rest-server.Swagger.Models'>7.27.9 - Models</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.Models' id='juneau-rest-server.Swagger.Models'>7.27.9 - Models</a></h4>
<div class='topic'><!-- START: 7.27.9 - juneau-rest-server.Swagger.Models -->
<p>
The {@link org.apache.juneau.jsonschema.JsonSchemaGenerator#JSONSCHEMA_useBeanDefs} setting can be used to reduce the size of your
@@ -19582,7 +19590,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.Stylesheet' id='juneau-rest-server.Swagger.Stylesheet'>7.27.10 - SwaggerUI.css</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.Swagger.Stylesheet' id='juneau-rest-server.Swagger.Stylesheet'>7.27.10 - SwaggerUI.css</a></h4>
<div class='topic'><!-- START: 7.27.10 - juneau-rest-server.Swagger.Stylesheet -->
<p>
The look-and-feel of the Swagger UI is controlled via a single CSS file: <code>SwaggerUI.css</code>.
@@ -19886,7 +19894,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.HtmlDocAnnotation.PredefinedWidgets' id='juneau-rest-server.HtmlDocAnnotation.PredefinedWidgets'>7.28.3 - Predefined Widgets</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HtmlDocAnnotation.PredefinedWidgets' id='juneau-rest-server.HtmlDocAnnotation.PredefinedWidgets'>7.28.3 - Predefined Widgets</a></h4>
<div class='topic'><!-- START: 7.28.3 - juneau-rest-server.HtmlDocAnnotation.PredefinedWidgets -->
<p>
The {@link org.apache.juneau.rest.widget} package contains predefined reusable widgets.
@@ -20129,7 +20137,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic updated' onclick='toggle(this)'><a href='#juneau-rest-server.HtmlDocAnnotation.UiCustomization' id='juneau-rest-server.HtmlDocAnnotation.UiCustomization'>7.28.4 - UI Customization</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.HtmlDocAnnotation.UiCustomization' id='juneau-rest-server.HtmlDocAnnotation.UiCustomization'>7.28.4 - UI Customization</a></h4>
<div class='topic'><!-- START: 7.28.4 - juneau-rest-server.HtmlDocAnnotation.UiCustomization -->
<p>
The HTML views of POJOs can somewhat be considered a rudimentary User Interface.
@@ -20861,7 +20869,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.UnitTesting' id='juneau-rest-server.UnitTesting'>7.36 - Serverless Unit Testing</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-server.UnitTesting' id='juneau-rest-server.UnitTesting'>7.36 - Serverless Unit Testing</a></h3>
<div class='topic'><!-- START: 7.36 - juneau-rest-server.UnitTesting -->
<p>
The {@link org.apache.juneau.rest.mock.MockRest} class is a simple yet powerful interface for creating serverless
@@ -21282,7 +21290,7 @@
<!-- ==================================================================================================== -->
-<h2 class='topic updated' onclick='toggle(this)'><a href='#juneau-rest-client' id='juneau-rest-client'>9 - juneau-rest-client</a></h2>
+<h2 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-client' id='juneau-rest-client'>9 - juneau-rest-client</a></h2>
<div class='topic'><!-- START: 9 - juneau-rest-client -->
<h5 class='figure'>Maven Dependency</h5>
<p class='bpcode w500'>
@@ -21471,7 +21479,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies' id='juneau-rest-client.RestProxies'>9.1 - REST Proxies</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies' id='juneau-rest-client.RestProxies'>9.1 - REST Proxies</a></h3>
<div class='topic'><!-- START: 9.1 - juneau-rest-client.RestProxies -->
<p>
The <code>juneau-rest-client</code> library can also be used to define interface proxies against 3rd-party REST interfaces.
@@ -21549,7 +21557,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.RemoteResource' id='juneau-rest-client.RestProxies.RemoteResource'>9.1.1 - @RemoteResource</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.RemoteResource' id='juneau-rest-client.RestProxies.RemoteResource'>9.1.1 - @RemoteResource</a></h4>
<div class='topic'><!-- START: 9.1.1 - juneau-rest-client.RestProxies.RemoteResource -->
<p>
The {@link org.apache.juneau.rest.client.remote.RemoteResource @RemoteResource} annotation is used on your interface class
@@ -21609,7 +21617,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.RemoteMethod' id='juneau-rest-client.RestProxies.RemoteMethod'>9.1.2 - @RemoteMethod</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.RemoteMethod' id='juneau-rest-client.RestProxies.RemoteMethod'>9.1.2 - @RemoteMethod</a></h4>
<div class='topic'><!-- START: 9.1.2 - juneau-rest-client.RestProxies.RemoteMethod -->
<p>
The {@link org.apache.juneau.rest.client.remote.RemoteMethod @RemoteMethod} annotation is applied to methods
@@ -21764,7 +21772,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.Body' id='juneau-rest-client.RestProxies.Body'>9.1.3 - @Body</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.Body' id='juneau-rest-client.RestProxies.Body'>9.1.3 - @Body</a></h4>
<div class='topic'><!-- START: 9.1.3 - juneau-rest-client.RestProxies.Body -->
<p>
The {@link org.apache.juneau.http.annotation.Body @Body} annotation can be applied to arguments of <ja>@RemoteMethod</ja>-annotated methods
@@ -21859,7 +21867,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.FormData' id='juneau-rest-client.RestProxies.FormData'>9.1.4 - @FormData</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.FormData' id='juneau-rest-client.RestProxies.FormData'>9.1.4 - @FormData</a></h4>
<div class='topic'><!-- START: 9.1.4 - juneau-rest-client.RestProxies.FormData -->
<p>
The {@link org.apache.juneau.http.annotation.FormData @FormData} annotation can be applied to arguments of <ja>@RemoteMethod</ja>-annotated methods
@@ -21967,7 +21975,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.Query' id='juneau-rest-client.RestProxies.Query'>9.1.5 - @Query</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.Query' id='juneau-rest-client.RestProxies.Query'>9.1.5 - @Query</a></h4>
<div class='topic'><!-- START: 9.1.5 - juneau-rest-client.RestProxies.Query -->
<p>
The {@link org.apache.juneau.http.annotation.Query @Query} annotation can be applied to arguments of <ja>@RemoteMethod</ja>-annotated methods
@@ -22078,7 +22086,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.Header' id='juneau-rest-client.RestProxies.Header'>9.1.6 - @Header</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.Header' id='juneau-rest-client.RestProxies.Header'>9.1.6 - @Header</a></h4>
<div class='topic'><!-- START: 9.1.6 - juneau-rest-client.RestProxies.Header -->
<p>
The {@link org.apache.juneau.http.annotation.Header @Header} annotation can be applied to arguments of <ja>@RemoteMethod</ja>-annotated methods
@@ -22175,7 +22183,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.Path' id='juneau-rest-client.RestProxies.Path'>9.1.7 - @Path</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.Path' id='juneau-rest-client.RestProxies.Path'>9.1.7 - @Path</a></h4>
<div class='topic'><!-- START: 9.1.7 - juneau-rest-client.RestProxies.Path -->
<p>
The {@link org.apache.juneau.http.annotation.Path @Path} annotation can be applied to arguments of <ja>@RemoteMethod</ja>-annotated methods
@@ -22265,7 +22273,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.Request' id='juneau-rest-client.RestProxies.Request'>9.1.8 - @Request</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.Request' id='juneau-rest-client.RestProxies.Request'>9.1.8 - @Request</a></h4>
<div class='topic'><!-- START: 9.1.8 - juneau-rest-client.RestProxies.Request -->
<p>
The {@link org.apache.juneau.http.annotation.Request @Request} annotation can be applied to a type of a <ja>@RemoteMethod</ja>-annotated method
@@ -22384,7 +22392,7 @@
<!-- ==================================================================================================== -->
-<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.Response' id='juneau-rest-client.RestProxies.Response'>9.1.9 - @Response</a></h4>
+<h4 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-client.RestProxies.Response' id='juneau-rest-client.RestProxies.Response'>9.1.9 - @Response</a></h4>
<div class='topic'><!-- START: 9.1.9 - juneau-rest-client.RestProxies.Response -->
<p>
The {@link org.apache.juneau.http.annotation.Response @Response} annotation can be applied to types returned by <ja>@RemoteMethod</ja>-annotated methods.
@@ -22487,7 +22495,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-client.Authentication' id='juneau-rest-client.Authentication'>9.3 - Authentication</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-client.Authentication' id='juneau-rest-client.Authentication'>9.3 - Authentication</a></h3>
<div class='topic'><!-- START: 9.3 - juneau-rest-client.Authentication -->
<p>
The Juneau REST client itself does not implement any support for authentication.
@@ -23051,7 +23059,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-client.UnitTesting' id='juneau-rest-client.UnitTesting'>9.9 - Serverless Unit Testing</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-rest-client.UnitTesting' id='juneau-rest-client.UnitTesting'>9.9 - Serverless Unit Testing</a></h3>
<div class='topic'><!-- START: 9.9 - juneau-rest-client.UnitTesting -->
<p>
The {@link org.apache.juneau.rest.mock.MockRest} class is used for performing serverless unit testing of REST interfaces.
@@ -23920,7 +23928,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-microservice-server.UiCustomization' id='juneau-microservice-server.UiCustomization'>10.8 - UI Customization</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-microservice-server.UiCustomization' id='juneau-microservice-server.UiCustomization'>10.8 - UI Customization</a></h3>
<div class='topic'><!-- START: 10.8 - juneau-microservice-server.UiCustomization -->
<p>
The Microservice project contains a <code>files/htdocs</code> working directly folder with predefined stylesheets and
@@ -24212,7 +24220,7 @@
RequestEchoResource.<jk>class</jk>,
TempDirResource.<jk>class</jk>,
AddressBookResource.<jk>class</jk>,
- SampleRemoteInterfaceServlet.<jk>class</jk>,
+ SampleRrpcServlet.<jk>class</jk>,
PhotosResource.<jk>class</jk>,
AtomFeedResource.<jk>class</jk>,
JsonSchemaResource.<jk>class</jk>,
@@ -25204,7 +25212,7 @@
<!-- ==================================================================================================== -->
-<h3 class='topic new' onclick='toggle(this)'><a href='#juneau-examples-rest.PetStoreResource' id='juneau-examples-rest.PetStoreResource'>12.7 - PetStoreResource</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-examples-rest.PetStoreResource' id='juneau-examples-rest.PetStoreResource'>12.7 - PetStoreResource</a></h3>
<div class='topic'><!-- START: 12.7 - juneau-examples-rest.PetStoreResource -->
<p>
The <code>PetStoreResource</code> class provides examples for creating a Swagger-based interface.
@@ -26040,7 +26048,7 @@
<p class='bpcode w800'>
<jd>/**
* Interface used to help illustrate proxy interfaces.
- * See {<ja>@link</ja> SampleRemoteInterfaceServlet}.
+ * See {<ja>@link</ja> SampleRrpcServlet}.
*/</jd>
<jk>public interface</jk> IAddressBook {
@@ -26594,10 +26602,10 @@
}
<jd>/**
- * [PROXY /*]
+ * [RRPC /*]
* Return a proxy interface to IAddressBook.
*/</jd>
- <ja>@RestMethod</ja>(name=<jsf>PROXY</jsf>, path=<js>"/proxy/*"</js>)
+ <ja>@RestMethod</ja>(name=<jsf>RRPC</jsf>, path=<js>"/proxy/*"</js>)
<jk>public</jk> IAddressBook getProxy() {
<jk>return</jk> <jf>addressBook</jf>;
}
@@ -27030,14 +27038,14 @@
<!-- ==================================================================================================== -->
-<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-examples-rest.SampleRemoteableServlet' id='juneau-examples-rest.SampleRemoteableServlet'>12.9 - SampleRemoteInterfaceServlet</a></h3>
+<h3 class='topic ' onclick='toggle(this)'><a href='#juneau-examples-rest.SampleRemoteableServlet' id='juneau-examples-rest.SampleRemoteableServlet'>12.9 - SampleRrpcServlet</a></h3>
<div class='topic'><!-- START: 12.9 - juneau-examples-rest.SampleRemoteableServlet -->
<p>
- The <l>SampleRemoteInterfaceServlet</l> class shows examples of the following:
+ The <l>SampleRrpcServlet</l> class shows examples of the following:
</p>
<ul class='spaced-list'>
<li>
- Extending the {@link org.apache.juneau.rest.remote.RemoteInterfaceServlet} class to create a proxy
+ Extending the {@link org.apache.juneau.rest.remote.RrpcServlet} class to create a proxy
service.
<li>
Using the {@link org.apache.juneau.rest.client.RestClient} class to create remote interfaces.
@@ -28334,6 +28342,7 @@
<li><p><a class='doclink' href='#7.0.1'>7.0.1 (Dec 24, 2017)</a></p>
<li><p><a class='doclink' href='#7.1.0'>7.1.0 (Mar 08, 2018)</a></p>
<li><p><a class='doclink' href='#7.2.0'>7.2.0 (Sept 25, 2018)</a></p>
+<li><p><a class='doclink' href='#7.2.1'>7.2.1 (TBD)</a></p>
</ul>
@@ -30818,7 +30827,7 @@
</ul>
<li>New methods in {@link org.apache.juneau.internal.IOUtils}:
<ul>
- <li>{@link org.apache.juneau.internal.IOUtils#pipe(Reader,Writer)}
+ <li><code><del>IOUtils.pipe(Reader,Writer)</del></code>
<li>{@link org.apache.juneau.internal.IOUtils#read(File)}
<li>{@link org.apache.juneau.internal.IOUtils#readFile(String)}
<li>{@link org.apache.juneau.internal.IOUtils#write(File,Reader)}
@@ -33692,18 +33701,18 @@
and auto-generated Swagger documentation:
<ul class='doctree'>
<li class='ja'>{@link org.apache.juneau.http.annotation.Contact}
- <li class='ja'>{@link org.apache.juneau.http.annotation.ExternalDocs}
- <li class='ja'>{@link org.apache.juneau.http.annotation.Items}
+ <li class='ja'><code><del>ExternalDocs</del></code>
+ <li class='ja'><code><del>Items</del></code>
<li class='ja'>{@link org.apache.juneau.http.annotation.License}
- <li class='ja'>{@link org.apache.juneau.http.annotation.Schema}
- <li class='ja'>{@link org.apache.juneau.http.annotation.SubItems}
+ <li class='ja'><code><del>Schema</del></code>
+ <li class='ja'><code><del>SubItems</del></code>
<li class='ja'>{@link org.apache.juneau.http.annotation.Tag}
</ul>
<br>Additionally, the <ja>@Remoteable</ja> annotation has been split into the following two annotations:
<ul class='doctree'>
<li class='ja'>{@link org.apache.juneau.remote.RemoteInterface}
- Used for remote proxy interfaces served up through
- {@link org.apache.juneau.rest.remote.RemoteInterfaceServlet} or REST <js>"PROXY"</js> methods.
+ <code><del>RemoteInterfaceServlet</del></code> or REST <js>"PROXY"</js> methods.
<br>Defaults to <js>"POST"</js> with method signatures as paths.
<li class='ja'>{@link org.apache.juneau.rest.client.remote.RemoteResource}
- Used for 3rd-party REST interfaces.
@@ -33791,7 +33800,7 @@
<li>
Significant improvements to JSON-Schema serialization support.
<ul>
- <li>New {@link org.apache.juneau.jsonschema.annotation.JsonSchema @JsonSchema} annotation.
+ <li>New <code><del>@JsonSchema</del></code> annotation.
</ul>
<li>
Fixed <code>NullPointerException</code> when serializing beans with a dyna-property (i.e. <code><ja>@Bean</ja>(<js>"*"</js>)</code>)
@@ -33908,9 +33917,9 @@
<li>
Fixed bug where incorrect media type was being set on responses (e.g. <code>text/html+schema</code> instead of <code>text/html</code> for schema documents).
<li>
- The <code>RemoteableServlet</code> class has been moved and renamed to {@link org.apache.juneau.rest.remote.RemoteInterfaceServlet}.
+ The <code>RemoteableServlet</code> class has been moved and renamed to <code><del>RemoteInterfaceServlet</del></code>.
<li>
- {@link org.apache.juneau.rest.remote.RemoteInterfaceServlet} now provides a form page for invoking remote interface methods in a browser.
+ <code><del>RemoteInterfaceServlet</del></code> now provides a form page for invoking remote interface methods in a browser.
<li>
Newlines were being stripped from <code><ja>@HtmlDoc</ja>(script)</code> when serialized which could cause script lines to become commented out.
<li>
@@ -33935,12 +33944,12 @@
<ul>
<li class='jc'>{@link org.apache.juneau.rest.helper.BeanDescription}
<li class='jc'>{@link org.apache.juneau.rest.helper.ChildResourceDescriptions}
- <li class='jc'>{@link org.apache.juneau.rest.helper.ReaderResource}
- <li class='jc'>{@link org.apache.juneau.rest.helper.ReaderResourceBuilder}
+ <li class='jc'><code><del>ReaderResource</del></code>
+ <li class='jc'><code><del>ReaderResourceBuilder</del></code>
<li class='jc'>{@link org.apache.juneau.rest.helper.SeeOtherRoot}
<li class='jc'>{@link org.apache.juneau.rest.helper.ResourceDescription}
- <li class='jc'>{@link org.apache.juneau.rest.helper.StreamResource}
- <li class='jc'>{@link org.apache.juneau.rest.helper.StreamResourceBuilder}
+ <li class='jc'><code><del>StreamResource</del></code>
+ <li class='jc'><code><del>StreamResourceBuilder</del></code>
</ul>
</ul>
<li>
@@ -34188,9 +34197,9 @@
<ul class='doctree'>
<li class='jc'>{@link org.apache.juneau.rest.client.RestClient}
<ul>
- <li class='jm'>{@link org.apache.juneau.rest.client.RestClient#getRemoteInterface(Class)}
- <li class='jm'>{@link org.apache.juneau.rest.client.RestClient#getRemoteInterface(Class,Object)}
- <li class='jm'>{@link org.apache.juneau.rest.client.RestClient#getRemoteInterface(Class,Object,Serializer,Parser)}
+ <li class='jm'><code><del>RestClient.getRemoteInterface(Class)</del></code>
+ <li class='jm'><code><del>RestClient.getRemoteInterface(Class,Object)</del></code>
+ <li class='jm'><code><del>RestClient.getRemoteInterface(Class,Object,Serializer,Parser)</del></code>
<li class='jm'>{@link org.apache.juneau.rest.client.RestClient#getRemoteResource(Class)}
<li class='jm'>{@link org.apache.juneau.rest.client.RestClient#getRemoteResource(Class,Object)}
<li class='jm'>{@link org.apache.juneau.rest.client.RestClient#getRemoteResource(Class,Object,Serializer,Parser)}
@@ -34279,5 +34288,45 @@
</ul>
</div><!-- END: 7.2.0 -->
+<!-- ==================================================================================================== -->
+
+<h3 class='topic' onclick='toggle(this)'><a href='#7.2.1' id='7.2.1'>7.2.1 (TBD)</a></h3>
+<div class='topic'><!-- START: 7.2.1 -->
+<p>
+ This release contains mostly bug fixes.
+</p>
+
+<h5 class='topic w800'>juneau-marshall</h5>
+<ul class='spaced-list'>
+ <li>
+ The <code><del>@JsonSchema</del></code> annotation has been merged with the {@link org.apache.juneau.jsonschema.annotation.Schema @Schema} annotation.
+ <li>
+ Annotations typically used on bean properties (getters/setters/public fields) can now be used on private fields.
+ This is inline with behavior on JPA-annotated beans.
+ These include: <ja>@Swap</ja>, <ja>@Html</ja>, <ja>@Xml</ja>, <ja>@BeanProperty</ja>.
+</ul>
+
+<h5 class='topic w800'>juneau-rest-server</h5>
+<ul class='spaced-list'>
+ <li>
+ The <code>ReaderResource</code> and <code>StreamResource</code> classes have been moved to the <code>org.apache.juneau.http</code>
+ package in <code>juneau-marshall</code>. This allows them to be used as return types in remote REST interfaces.
+ <br>A new {@link org.apache.juneau.rest.helper.ResolvingReaderResource} class has been added that includes the variable-resolving support since
+ this relies on the <code>juneau-svl</code> package.
+ <li>
+ The <code>RemoteInterfaceServlet</code> class has been renamed to {@link org.apache.juneau.rest.remote.RrpcServlet}.
+ <li>
+ <code><ja>@RestMethod</ja>(name=<js>"PROXY"</js>)</code> has been changed to <code><ja>@RestMethod</ja>(name=<js>"RRPC"</js>)</code>.
+</ul>
+
+<h5 class='topic w800'>juneau-rest-client</h5>
+<ul class='spaced-list'>
+ <li>
+ The <code>RestClient.getRemoteInterface()</code> method has been renamed to {@link org.apache.juneau.rest.client.RestClient#getRrpcInterface(Class)}.
+ <li>
+ Fixed a bug where <code><ja>@RemoteMethod</ja>(path)</code> values containing '/' characters were erroneously being encoded.
+</ul>
+</div><!-- END: 7.2.1 -->
+
</div>
</body>
diff --git a/juneau-doc/src/main/resources/ReleaseNotes/5.2.0.0.html b/juneau-doc/src/main/resources/ReleaseNotes/5.2.0.0.html
index 006fc7b..7c51bd7 100644
--- a/juneau-doc/src/main/resources/ReleaseNotes/5.2.0.0.html
+++ b/juneau-doc/src/main/resources/ReleaseNotes/5.2.0.0.html
@@ -117,7 +117,7 @@
</ul>
<li>New methods in {@link oaj.internal.IOUtils}:
<ul>
- <li>{@link oaj.internal.IOUtils#pipe(Reader,Writer)}
+ <li><code><del>IOUtils.pipe(Reader,Writer)</del></code>
<li>{@link oaj.internal.IOUtils#read(File)}
<li>{@link oaj.internal.IOUtils#readFile(String)}
<li>{@link oaj.internal.IOUtils#write(File,Reader)}
diff --git a/juneau-doc/src/main/resources/ReleaseNotes/7.2.0.html b/juneau-doc/src/main/resources/ReleaseNotes/7.2.0.html
index 970472b..c5d4dc6 100644
--- a/juneau-doc/src/main/resources/ReleaseNotes/7.2.0.html
+++ b/juneau-doc/src/main/resources/ReleaseNotes/7.2.0.html
@@ -49,11 +49,11 @@
and auto-generated Swagger documentation:
<ul class='doctree'>
<li class='ja'>{@link oaj.http.annotation.Contact}
- <li class='ja'>{@link oaj.http.annotation.ExternalDocs}
- <li class='ja'>{@link oaj.http.annotation.Items}
+ <li class='ja'><code><del>ExternalDocs</del></code>
+ <li class='ja'><code><del>Items</del></code>
<li class='ja'>{@link oaj.http.annotation.License}
<li class='ja'><code><del>Schema</del></code>
- <li class='ja'>{@link oaj.http.annotation.SubItems}
+ <li class='ja'><code><del>SubItems</del></code>
<li class='ja'>{@link oaj.http.annotation.Tag}
</ul>
<br>Additionally, the <ja>@Remoteable</ja> annotation has been split into the following two annotations:
@@ -292,12 +292,12 @@
<ul>
<li class='jc'>{@link oajr.helper.BeanDescription}
<li class='jc'>{@link oajr.helper.ChildResourceDescriptions}
- <li class='jc'>{@link oajr.helper.ReaderResource}
- <li class='jc'>{@link oajr.helper.ReaderResourceBuilder}
+ <li class='jc'><code><del>ReaderResource</del></code>
+ <li class='jc'><code><del>ReaderResourceBuilder</del></code>
<li class='jc'>{@link oajr.helper.SeeOtherRoot}
<li class='jc'>{@link oajr.helper.ResourceDescription}
- <li class='jc'>{@link oajr.helper.StreamResource}
- <li class='jc'>{@link oajr.helper.StreamResourceBuilder}
+ <li class='jc'><code><del>StreamResource</del></code>
+ <li class='jc'><code><del>StreamResourceBuilder</del></code>
</ul>
</ul>
<li>
@@ -545,9 +545,9 @@
<ul class='doctree'>
<li class='jc'>{@link oajrc.RestClient}
<ul>
- <li class='jm'>{@link oajrc.RestClient#getRemoteInterface(Class)}
- <li class='jm'>{@link oajrc.RestClient#getRemoteInterface(Class,Object)}
- <li class='jm'>{@link oajrc.RestClient#getRemoteInterface(Class,Object,Serializer,Parser)}
+ <li class='jm'><code><del>RestClient.getRemoteInterface(Class)</del></code>
+ <li class='jm'><code><del>RestClient.getRemoteInterface(Class,Object)</del></code>
+ <li class='jm'><code><del>RestClient.getRemoteInterface(Class,Object,Serializer,Parser)</del></code>
<li class='jm'>{@link oajrc.RestClient#getRemoteResource(Class)}
<li class='jm'>{@link oajrc.RestClient#getRemoteResource(Class,Object)}
<li class='jm'>{@link oajrc.RestClient#getRemoteResource(Class,Object,Serializer,Parser)}
diff --git a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/11.ReaderResource.html b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/11.ReaderResource.html
index d957a5f..93187a4 100644
--- a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/11.ReaderResource.html
+++ b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/11.ReaderResource.html
@@ -16,20 +16,11 @@
ReaderResource
<p>
- The {@link oajr.helper.ReaderResource} class is a convenience object for defining thread-safe
+ The {@link oaj.http.ReaderResource} class is a convenience object for defining thread-safe
reusable character-based responses.
<br>In essence, it's a container for character data with optional response headers and support for
resolving SVL variables.
</p>
-<ul class='doctree'>
- <li class='jc'>{@link oajr.helper.ReaderResourceBuilder}
- <ul>
- <li class='jm'>{@link oajr.helper.ReaderResourceBuilder#contents(Object...) contents(Object...)}
- <li class='jm'>{@link oajr.helper.ReaderResourceBuilder#header(String,Object) header(String,Object)}
- <li class='jm'>{@link oajr.helper.ReaderResourceBuilder#mediaType(MediaType) mediaType(MediaType)}
- <li class='jm'>{@link oajr.helper.ReaderResourceBuilder#varResolver(VarResolverSession) varResolver(VarResolverSession)}
- </ul>
-</ul>
<p>
The class is annotated with {@link oaj.http.annotation.Response @Response}
diff --git a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/12.StreamResource.html b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/12.StreamResource.html
index 2f5dfa2..e67e1aa 100644
--- a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/12.StreamResource.html
+++ b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/12.StreamResource.html
@@ -16,17 +16,9 @@
StreamResource
<p>
- The {@link oajr.helper.StreamResource} class is the binary equivalent to the {@link oajr.helper.ReaderResource} object.
+ The {@link oaj.http.StreamResource} class is the binary equivalent to the {@link oaj.http.ReaderResource} object.
<br>In essence, it's a container for binary data with optional response headers.
</p>
-<ul class='doctree'>
- <li class='jc'>{@link oajr.helper.StreamResourceBuilder}
- <ul>
- <li class='jm'>{@link oajr.helper.StreamResourceBuilder#contents(Object...) contents(Object...)}
- <li class='jm'>{@link oajr.helper.StreamResourceBuilder#header(String,Object) header(String,Object)}
- <li class='jm'>{@link oajr.helper.StreamResourceBuilder#mediaType(MediaType) mediaType(MediaType)}
- </ul>
-</ul>
<p>
The class is annotated with {@link oaj.http.annotation.Response @Response}
which allows it to be returned as responses by REST methods.
diff --git a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/16.PredefinedHelperBeans.html b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/16.PredefinedHelperBeans.html
index f48c6f4..8c0e063 100644
--- a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/16.PredefinedHelperBeans.html
+++ b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/16.PredefinedHelperBeans.html
@@ -24,13 +24,9 @@ Predefined Helper Beans
<ul>
<li class='jc'>{@link oajr.helper.BeanDescription}
<li class='jc'>{@link oajr.helper.ChildResourceDescriptions}
- <li class='jc'>{@link oajr.helper.ReaderResource}
- <li class='jc'>{@link oajr.helper.ReaderResourceBuilder}
<li class='jc'>{@link oajr.helper.ResourceDescription}
<li class='jc'>{@link oajr.helper.ResourceDescriptions}
<li class='jc'>{@link oajr.helper.SeeOtherRoot}
- <li class='jc'>{@link oajr.helper.StreamResource}
- <li class='jc'>{@link oajr.helper.StreamResourceBuilder}
</ul>
</ul>
diff --git a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/10.HttpPartAnnotations.html b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/10.HttpPartAnnotations.html
index 8a21772..fee802c 100644
--- a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/10.HttpPartAnnotations.html
+++ b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/10.HttpPartAnnotations.html
@@ -42,7 +42,7 @@ HTTP-Part Annotations
</p>
<ul class='doctree'>
<li class='ja'>{@link oaj.jsonschema.annotation.Schema Schema}
- <li class='ja'>{@link oaj.http.annotation.Items Items}
+ <li class='ja'>{@link oaj.jsonschema.annotation.Items Items}
</ul>
<h5 class='section'>Other Notes:</h5>
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
index 8d2db25..e4f0bf0 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
@@ -2503,7 +2503,7 @@ public final class RestCall extends BeanSession implements Closeable {
}
/**
- * @deprecated Use {@link #formData(String, Object, boolean, HttpPartSerializer, HttpPartSchema))}
+ * @deprecated Use {@link #formData(String, Object, boolean, HttpPartSerializer, HttpPartSchema)}
*/
@SuppressWarnings("javadoc")
@Deprecated
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
index 6c6f79f..e6343f5 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
@@ -3091,7 +3091,7 @@ public class RestClientBuilder extends BeanContextBuilder {
}
/**
- * @deprecated Use {@link #maxDepth(boolean)}
+ * @deprecated Use {@link #maxIndent(int)}
*/
@SuppressWarnings("javadoc")
@Deprecated
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/BasicRestCallHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/BasicRestCallHandler.java
index 176ba57..f405a26 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/BasicRestCallHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/BasicRestCallHandler.java
@@ -348,7 +348,7 @@ public class BasicRestCallHandler implements RestCallHandler {
}
/**
- * @deprecated Use {@link #handleResponse(HttpServletRequest, HttpServletResponse)}
+ * @deprecated Use {@link #handleResponse(RestRequest, RestResponse)}
*/
@SuppressWarnings("javadoc")
@Deprecated
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java
index ed2ff9a..d6bca0e 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java
@@ -631,7 +631,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
}
/**
- * @deprecated Use {@link #get(HttpPartParser, HttpPartSchema, Object, Class)}
+ * @deprecated Use {@link #get(HttpPartParser, HttpPartSchema, String, Object, Class)}
*/
@SuppressWarnings({ "unused", "javadoc" })
@Deprecated
@@ -665,7 +665,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
public <T> T getAll(HttpPartParser parser, String name, Type type, Type...args) throws ParseException {
return getAll(parser, null, name, type, args);
}
-
+
/**
* @deprecated Unused.
*/
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestRequest.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestRequest.java
index 3fcf1db..859388e 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestRequest.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestRequest.java
@@ -1727,7 +1727,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
}
/**
- * @deprecated Use {@Link #getClasspathReaderResource(String, boolean, MediaType, boolean)}
+ * @deprecated Use {@link #getClasspathReaderResource(String, boolean, MediaType, boolean)}
*/
@SuppressWarnings("javadoc")
@Deprecated
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Parameter.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
index 0ba0e07..29e8869 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
@@ -18,9 +18,9 @@ import static java.lang.annotation.RetentionPolicy.*;
import java.lang.annotation.*;
/**
- * Annotation used in conjunction with {@link MethodSwagger#parameters() @MethodSwagger.parameters()} to identify
+ * Annotation used in conjunction with {@link MethodSwagger#parameters() @MethodSwagger.parameters()} to identify
* content and header descriptions on specific method requests.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
@@ -35,10 +35,10 @@ import java.lang.annotation.*;
* ...
* }
* </p>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
- * <li class='link'><a class="doclink" href="../../../../../overview-summary.html#juneau-rest-server.OptionsPages">Overview > juneau-rest-server > OPTIONS Pages</a>
+ * <li class='link'>{@doc juneau-rest-server.Swagger}
* </ul>
*/
@Documented
@@ -49,7 +49,7 @@ public @interface Parameter {
/**
* 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.
@@ -62,7 +62,7 @@ public @interface Parameter {
/**
* 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.
@@ -72,7 +72,7 @@ public @interface Parameter {
/**
* Determines the format of the array if type array is used.
- *
+ *
* <p>
* Possible values are:
* <ul>
@@ -90,13 +90,13 @@ public @interface Parameter {
/**
* 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 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
@@ -106,7 +106,7 @@ public @interface Parameter {
/**
* The extending format for the previously mentioned <code>type</code>.
- *
+ *
* <p>
* See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
* details.
@@ -115,7 +115,7 @@ public @interface Parameter {
/**
* The location of the parameter.
- *
+ *
* <p>
* Possible values are:
* <ul>
@@ -130,10 +130,10 @@ public @interface Parameter {
/**
* Required if <code>type</code> is <js>"array"</js>.
- *
+ *
* <p>
* Describes the type of items in the array.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
@@ -147,7 +147,7 @@ public @interface Parameter {
* )
* <jk>public void</jk> doAnything() {
* </p>
- *
+ *
* <p>
* See <a class="doclink" href="http://swagger.io/specification/#itemsObject">Items Object</a> for further details.
*/
@@ -155,7 +155,7 @@ public @interface Parameter {
/**
* 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
@@ -169,7 +169,7 @@ public @interface Parameter {
/**
* 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>.
* Otherwise, the property MAY be included and its default value is <jk>false</jk>.
@@ -178,13 +178,13 @@ public @interface Parameter {
/**
* 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 class="doclink" href="http://swagger.io/specification/#schemaObject">here</a>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
@@ -202,7 +202,7 @@ public @interface Parameter {
/**
* 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>.
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByApache.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByApache.java
index ab8ebf1..a237919 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByApache.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByApache.java
@@ -17,14 +17,14 @@ import org.apache.juneau.rest.*;
/**
* Widget that places a powered-by-Apache message on the page.
- *
+ *
* <p>
* The variable it resolves is <js>"$W{PoweredByApache}"</js>.
- *
+ *
* <p>
* It produces a simple Apache icon floating on the right.
* Typically it's used in the footer of the page, as shown below in the <code>RootResources</code> from the examples:
- *
+ *
* <p class='bcode'>
* <ja>@RestResource</ja>(
* path=<js>"/"</js>,
@@ -37,14 +37,14 @@ import org.apache.juneau.rest.*;
* footer=<js>"$W{PoweredByApache}"</js>
* )
* </p>
- *
+ *
* <p>
* It renders the following image:
* <img class='bordered' src='doc-files/PoweredByApacheWidget.png'>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
- * <li class='link'><a class="doclink" href="../../../../../overview-summary.html#juneau-rest-server.Widgets">Overview > juneau-rest-server > Widgets</a>
+ * <li class='link'>{@doc juneau-rest-server.HtmlDocAnnotation.PredefinedWidgets}
* </ul>
*/
public class PoweredByApache extends Widget {
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/doc-files/PoweredByApacheWidget.png b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/doc-files/PoweredByApacheWidget.png
new file mode 100644
index 0000000..dd3d63f
Binary files /dev/null and b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/doc-files/PoweredByApacheWidget.png differ