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 2019/07/30 13:52:48 UTC
[juneau-website] branch asf-site updated: Javadocs.
This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/juneau-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 4b7ef54 Javadocs.
4b7ef54 is described below
commit 4b7ef540b4f4192e13adb7c5a0ea16429714568b
Author: JamesBognar <ja...@apache.org>
AuthorDate: Tue Jul 30 09:52:34 2019 -0400
Javadocs.
---
content/about.html | 119 +++++--
content/site/apidocs-8.0.1/overview-summary.html | 379 +++++++++++++++++----
.../apidocs-8.0.1/resources/fragments/about.html | 110 ++++--
.../apidocs-8.0.1/resources/fragments/toc.html | 4 +-
templates/about.html | 119 +++++--
templates/index.html | 11 +-
6 files changed, 574 insertions(+), 168 deletions(-)
diff --git a/content/about.html b/content/about.html
index ebc4406..01f5202 100644
--- a/content/about.html
+++ b/content/about.html
@@ -30,37 +30,94 @@
<p>
Apache Juneau™ is a single cohesive Java ecosystem consisting of the following parts:
</p>
- <ul class='spaced-list'>
- <li>
- <b>juneau-marshall</b>
- <br>A universal toolkit for marshalling POJOs to a wide variety of content types using a common framework.
- <li>
- <b>juneau-dto</b>
- <br>A set of predefined DTOs for serializing and parsing languages such as HTML5, Swagger and ATOM.
- <li>
- <b>juneau-svl</b>
- <br>A simple yet powerful variable replacement language API.
- <li>
- <b>juneau-config</b>
- <br>A sophisticated configuration API.
- <li>
- <b>juneau-rest-server</b>
- <br>A universal REST server API for creating REST interfaces using POJOs simply deployed in any Servlet 3.1.0+ container.
- <br>Includes auto-generation of Swagger and self-hosting of Swagger UI through OPTIONS page requests.
- <li>
- <b>juneau-rest-server-springboot</b>
- <br>Integration support for deploying Juneau-based REST resources as Spring beans in a Spring Boot application.
- <li>
- <b>juneau-rest-client</b>
- <br>A universal REST client API for interacting with Juneau or 3rd-party REST interfaces using POJOs and proxy interfaces.
- <li>
- <b>juneau-microservice</b>
- <br>A builder-based API for creating microservices.
- <li>
- <b>juneau-microservice-jetty</b>
- <br>REST microservice API that combines all the features above as a simple configurable Jetty server for
- creating lightweight standalone REST interfaces that start up in milliseconds.
- </ul>
+ <table class='styled w800'>
+ <tr>
+ <th>Group</th><th>Component</th><th>Description</th>
+ </tr>
+ <tr class='dark bb'>
+ <td rowspan="5" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-core</td>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html#juneau-marshall'>juneau-marshall</a></td>
+ <td>
+ A universal toolkit for marshalling POJOs to a wide variety of content types using a common framework with no external library dependencies.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html##juneau-marshall-rdf'>juneau-marshall-rdf</a></td>
+ <td>
+ Extended marshalling support for RDF languages.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html##juneau-dto'>juneau-dto</a></td>
+ <td>
+ A variety of predefined DTOs for serializing and parsing languages such as HTML5, Swagger and ATOM.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html##juneau-svl'>juneau-svl</a></td>
+ <td>
+ A simple yet powerful variable replacement language API.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html##juneau-config'>juneau-config</a></td>
+ <td>
+ A sophisticated configuration file API.
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td rowspan="4" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-rest</td>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html##juneau-rest-server'>juneau-rest-server</a></td>
+ <td>
+ A universal REST server API for creating Swagger-based self-documenting REST interfaces using POJOs, simply deployed as
+ one or more top-level servlets in any Servlet 3.1.0+ container.
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html##juneau-rest-server-springboot'>juneau-rest-server-springboot</a></td>
+ <td>
+ Spring Boot integration support
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html##juneau-rest-server-jaxrs'>juneau-rest-server-jaxrs</a></td>
+ <td>
+ JAX/RS integration support.
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html##juneau-rest-client'>juneau-rest-client</a></td>
+ <td>
+ A universal REST client API for interacting with Juneau or 3rd-party REST interfaces using POJOs and proxy interfaces.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td rowspan="4" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-microservice</td>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html##juneau-microservice-core'>juneau-microservice-core</a></td>
+ <td>
+ A base framework for defining microservices.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html##juneau-microservice-jetty'>juneau-microservice-jetty</a></td>
+ <td>
+ A REST microservice API that combines all the features above with a simple configurable Jetty server for
+ creating lightweight standalone REST interfaces that start up in milliseconds.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html##my-jetty-microservice'>my-jetty-microservice</a></td>
+ <td>
+ Starter project template for Jetty-based microservices.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html##my-springboot-microservice'>my-springboot-microservice</a></td>
+ <td>
+ Starter project template for Spring-boot-based microservices.
+ </td>
+ </tr>
+ </table>
<p>
Questions via email to <a class='doclink' href='mailto:dev@juneau.apache.org?Subject=Apache%20Juneau%20question'>dev@juneau.apache.org</a> are always welcome.
</p>
diff --git a/content/site/apidocs-8.0.1/overview-summary.html b/content/site/apidocs-8.0.1/overview-summary.html
index 05fbb5e..797eeb1 100644
--- a/content/site/apidocs-8.0.1/overview-summary.html
+++ b/content/site/apidocs-8.0.1/overview-summary.html
@@ -778,50 +778,94 @@
<p>
Apache Juneau™ is a single cohesive Java ecosystem consisting of the following parts:
</p>
-<ul class='spaced-list'>
- <li><b>juneau-marshall</b>
- <p>
+<table class='styled w800'>
+ <tr>
+ <th>Group</th><th>Component</th><th>Description</th>
+ </tr>
+ <tr class='dark bb'>
+ <td rowspan="5" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-core</td>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html#juneau-marshall'>juneau-marshall</a></td>
+ <td>
A universal toolkit for marshalling POJOs to a wide variety of content types using a common framework with no external library dependencies.
- </p>
- <li><b>juneau-dto</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-marshall-rdf'>juneau-marshall-rdf</a></td>
+ <td>
+ Extended marshalling support for RDF languages.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-dto'>juneau-dto</a></td>
+ <td>
A variety of predefined DTOs for serializing and parsing languages such as HTML5, Swagger and ATOM.
- </p>
- <li><b>juneau-svl</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-svl'>juneau-svl</a></td>
+ <td>
A simple yet powerful variable replacement language API.
- </p>
- <li><b>juneau-config</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-config'>juneau-config</a></td>
+ <td>
A sophisticated configuration file API.
- </p>
- <li><b>juneau-rest-server</b>
- <p>
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td rowspan="4" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-rest</td>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-rest-server'>juneau-rest-server</a></td>
+ <td>
A universal REST server API for creating Swagger-based self-documenting REST interfaces using POJOs, simply deployed as
one or more top-level servlets in any Servlet 3.1.0+ container.
- </p>
- <li><b>juneau-rest-server-springboot</b>
- <p>
- Spring Boot integration support.
- </p>
- <li><b>juneau-rest-client</b>
- <p>
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-rest-server-springboot'>juneau-rest-server-springboot</a></td>
+ <td>
+ Spring Boot integration support
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-rest-server-jaxrs'>juneau-rest-server-jaxrs</a></td>
+ <td>
+ JAX/RS integration support.
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-rest-client'>juneau-rest-client</a></td>
+ <td>
A universal REST client API for interacting with Juneau or 3rd-party REST interfaces using POJOs and proxy interfaces.
- </p>
- <li><b>juneau-microservice</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td rowspan="4" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-microservice</td>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-microservice-core'>juneau-microservice-core</a></td>
+ <td>
+ A base framework for defining microservices.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-microservice-jetty'>juneau-microservice-jetty</a></td>
+ <td>
A REST microservice API that combines all the features above with a simple configurable Jetty server for
creating lightweight standalone REST interfaces that start up in milliseconds.
- </p>
- <li><b>my-jetty-microservice.zip</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##my-jetty-microservice'>my-jetty-microservice</a></td>
+ <td>
Starter project template for Jetty-based microservices.
- </p>
- <li><b>my-springboot-microservice.zip</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##my-springboot-microservice'>my-springboot-microservice</a></td>
+ <td>
Starter project template for Spring-boot-based microservices.
- </p>
-</ul>
+ </td>
+ </tr>
+</table>
<a href='#TOC' id='TOC'></a><h5 class='toc'>Table of Contents</h5>
@@ -1027,7 +1071,7 @@
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestResource'>@RestResource</a></p>
<ol>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestResource.AnnotationInheritance'>Annotation Inheritance</a></p>
- <li><p class='todo'><a class='doclink' href='#juneau-rest-server.RestResource.RestResourcePath'>@RestResource(path)</a></p>
+ <li><p class='new'><a class='doclink' href='#juneau-rest-server.RestResource.RestResourcePath'>@RestResource(path)</a></p>
</ol>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestContext'>RestContext</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod'>@RestMethod</a></p>
@@ -1037,7 +1081,7 @@
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.RestResponse'>RestResponse</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.RequestBody'>RequestBody</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.RequestHeaders'>RequestHeaders</a></p>
- <li><p class='todo'><a class='doclink' href='#juneau-rest-server.RestMethod.RequestAttributes'>RequestAttributes</a></p>
+ <li><p class='new'><a class='doclink' href='#juneau-rest-server.RestMethod.RequestAttributes'>RequestAttributes</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.RequestQuery'>RequestQuery</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.RequestFormData'>RequestFormData</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.RestMethodPath'>@RestMethod(path)</a></p>
@@ -1242,46 +1286,94 @@
<p>
Apache Juneau™ is a single cohesive Java ecosystem consisting of the following parts:
</p>
-<ul class='spaced-list'>
- <li><b>juneau-marshall</b>
- <p>
+<table class='styled w800'>
+ <tr>
+ <th>Group</th><th>Component</th><th>Description</th>
+ </tr>
+ <tr class='dark bb'>
+ <td rowspan="5" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-core</td>
+ <td class='code'><a class='doclink' href='#juneau-marshall'>juneau-marshall</a></td>
+ <td>
A universal toolkit for marshalling POJOs to a wide variety of content types using a common framework with no external library dependencies.
- </p>
- <li><b>juneau-dto</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='#juneau-marshall-rdf'>juneau-marshall-rdf</a></td>
+ <td>
+ Extended marshalling support for RDF languages.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='#juneau-dto'>juneau-dto</a></td>
+ <td>
A variety of predefined DTOs for serializing and parsing languages such as HTML5, Swagger and ATOM.
- </p>
- <li><b>juneau-svl</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='#juneau-svl'>juneau-svl</a></td>
+ <td>
A simple yet powerful variable replacement language API.
- </p>
- <li><b>juneau-config</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='#juneau-config'>juneau-config</a></td>
+ <td>
A sophisticated configuration file API.
- </p>
- <li><b>juneau-rest-server</b>
- <p>
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td rowspan="4" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-rest</td>
+ <td class='code'><a class='doclink' href='#juneau-rest-server'>juneau-rest-server</a></td>
+ <td>
A universal REST server API for creating Swagger-based self-documenting REST interfaces using POJOs, simply deployed as
one or more top-level servlets in any Servlet 3.1.0+ container.
- </p>
- <li><b>juneau-rest-client</b>
- <p>
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='#juneau-rest-server-springboot'>juneau-rest-server-springboot</a></td>
+ <td>
+ Spring Boot integration support
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='#juneau-rest-server-jaxrs'>juneau-rest-server-jaxrs</a></td>
+ <td>
+ JAX/RS integration support.
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='#juneau-rest-client'>juneau-rest-client</a></td>
+ <td>
A universal REST client API for interacting with Juneau or 3rd-party REST interfaces using POJOs and proxy interfaces.
- </p>
- <li><b>juneau-microservice</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td rowspan="4" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-microservice</td>
+ <td class='code'><a class='doclink' href='#juneau-microservice-core'>juneau-microservice-core</a></td>
+ <td>
+ A base framework for defining microservices.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='#juneau-microservice-jetty'>juneau-microservice-jetty</a></td>
+ <td>
A REST microservice API that combines all the features above with a simple configurable Jetty server for
creating lightweight standalone REST interfaces that start up in milliseconds.
- </p>
- <li><b>my-jetty-microservice.zip</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='#my-jetty-microservice'>my-jetty-microservice</a></td>
+ <td>
Starter project template for Jetty-based microservices.
- </p>
- <li><b>my-springboot-microservice.zip</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='#my-springboot-microservice'>my-springboot-microservice</a></td>
+ <td>
Starter project template for Spring-boot-based microservices.
- </p>
-</ul>
+ </td>
+ </tr>
+</table>
<p>
Questions via email to <a class='doclink' href='mailto:dev@juneau.apache.org?Subject=Apache%20Juneau%20question'>dev@juneau.apache.org</a> are always welcome.
</p>
@@ -1294,8 +1386,8 @@
<h5 class='topic'>History</h5>
<p>
Juneau started off as a popular internal IBM toolkit called Juno.
- Originally used for serializing POJOs to and from JSON, it later expanded in scope to include a variety of
- content types, and then later REST servlet, client, and microservice APIs.
+ Originally used for serializing POJOs to and from JSON (at a time when the concept was new), it later expanded in
+ scope to include a variety of content types, and then later REST servlet, client, and microservice APIs.
It's use grew to more than 50 projects and was one of the most popular community source projects within IBM.
</p>
<p>
@@ -14916,9 +15008,130 @@
<!-- ==================================================================================================== -->
-<h4 class='topic todo' onclick='toggle(this)'><a href='#juneau-rest-server.RestResource.RestResourcePath' id='juneau-rest-server.RestResource.RestResourcePath'>7.4.2 - @RestResource(path)</a></h4>
+<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.RestResource.RestResourcePath' id='juneau-rest-server.RestResource.RestResourcePath'>7.4.2 - @RestResource(path)</a></h4>
<div class='topic'><!-- START: 7.4.2 - juneau-rest-server.RestResource.RestResourcePath -->
<p>
+ The <a href="org/apache/juneau/rest/annotation/RestResource.html#path--"><code>@RestResource(path)</code></a> annotation is used in the following situations:
+<p>
+<ul class='spaced-list'>
+ <li>
+ On child resources (resource classes attached to parents via the <a href="org/apache/juneau/rest/annotation/RestResource.html#children--"><code>@RestResource(children)</code></a> annotation) to identify
+ the subpath used to access the child resource relative to the parent.
+ <li>
+ On top-level <a href="org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>RestServlet</code></a> classes deployed as Spring beans when <a href="org/apache/juneau/rest/springboot/JuneauRestInitializer.html" title="class in org.apache.juneau.rest.springboot"><code>JuneauRestInitializer</code></a> is being used.
+</ul>
+
+<h5 class='topic'>On child resources</h5>
+<p>
+ The typical usage is to define a path to a child resource relative to the parent resource.
+</p>
+<h5 class='figure'>Example:</h5>
+<p class='bpcode w800'>
+ <ja>@RestResource</ja>(
+ children={
+ ChildResource.<jk>class</jk>
+ }
+ )
+ <jk>public class</jk> TopLevelResource <jk>extends</jk> BasicRestServlet {...}
+</p>
+<p class='bpcode w800'>
+ <ja>@RestResource</ja>(
+ path=<js>"/child"</js>,
+ children={
+ GrandchildResource.<jk>class</jk>
+ }
+ )
+ <jk>public class</jk> ChildResource {...}
+</p>
+<p class='bpcode w800'>
+ <ja>@RestResource</ja>(
+ path=<js>"/grandchild"</js>
+ )
+ <jk>public class</jk> GrandchildResource {
+ <ja>@RestMethod</ja>(
+ path=<js>"/"</js>
+ )
+ <jk>public</jk> String sayHello() {
+ <jk>return</jk> <js>"Hello!"</js>;
+ }
+ }
+</p>
+<p>
+ In the example above, assuming the <c>TopLevelResource</c> servlet is deployed to path <c>/myContext/myServlet</c>,
+ then the <c>sayHello</c> method is accessible through the URI <c>/myContext/myServlet/child/grandchild</c>.
+</p>
+<p>
+ Note that in this scenario, the <c>path</c> attribute is not defined on the top-level resource.
+ Specifying the path on the top-level resource has no effect, but can be used for readability purposes.
+</p>
+
+<h5 class='topic'>On top-level resources deployed as Spring beans</h5>
+<p>
+ The path can also be used on top-level resources deployed as Spring beans when used with the <a href="org/apache/juneau/rest/springboot/JuneauRestInitializer.html" title="class in org.apache.juneau.rest.springboot"><code>JuneauRestInitializer</code></a>
+ Spring Boot initializer class:
+</p>
+<h5 class='figure'>Example:</h5>
+<p class='bpcode w800'>
+ <ja>@SpringBootApplication</ja>
+ <ja>@Controller</ja>
+ <jk>public class</jk> App {
+
+ <jc>// Our entry-point method.</jc>
+ <jk>public static void</jk> main(String[] args) {
+ <jk>new</jk> SpringApplicationBuilder(App.<jk>class</jk>)
+ .initializers(<jk>new</jk> JuneauRestInitializer(App.<jk>class</jk>))
+ .run(args);
+ }
+
+ <jc>// Our top-level servlet.</jc>
+ <ja>@Bean</ja>
+ <ja>@JuneauRestRoot</ja>
+ <jk>public</jk> MyResource getMyResource() {
+ <jk>return new</jk> MyResource();
+ }
+ }
+</p>
+<p class='bpcode w800'>
+ <ja>@RestResource</ja>(
+ path=<js>"/myResource"</js>
+ )
+ <jk>public class</jk> MyResource <jk>extends</jk> BasicRestServlet {...}
+</p>
+
+<p>
+ In this case, the servlet will get registered using the path defined on the resource class.
+</p>
+
+<h5 class='topic'>Path variables</h5>
+<p>
+ The path can contain variables that get resolved to <a href="org/apache/juneau/http/annotation/Path.html" title="annotation in org.apache.juneau.http.annotation"><code>@Path</code></a> parameters
+ or access through the <a href="org/apache/juneau/rest/RestRequest.html#getPathMatch--"><code>RestRequest.getPathMatch()</code></a> method.
+</p>
+<h5 class='figure'>Example:</h5>
+<p class='bpcode'>
+ <ja>@RestResource</ja>(
+ path=<js>"/myResource/{foo}/{bar}"</js>
+ )
+ <jk>public class</jk> MyResource <jk>extends</jk> BasicRestServlet {
+
+ <ja>@RestMethod</ja>(
+ path=<js>"/{baz}"</js>
+ )
+ <jk>public void</jk> String doX(<ja>@Path</ja> String foo, <ja>@Path</ja> <jk>int</jk> bar, <ja>@Path</ja> MyPojo baz) {
+ ...
+ }
+ }
+</p>
+<p>
+ Variables can be used on either top-level or child resources and can be defined on multiple levels.
+</p>
+<div class='info'>
+ All variables in the path must be specified or else the target will not resolve and a <c>404</c> will result.
+</div>
+<p>
+ When variables are used on a path of a top-level resource deployed as a Spring bean in a Spring Boot application,
+ the first part of the URL must be a literal which will be used as the servlet path of the registered servlet.
+</p>
</div><!-- END: 7.4.2 - juneau-rest-server.RestResource.RestResourcePath -->
</div><!-- END: 7.4 - juneau-rest-server.RestResource -->
@@ -15316,7 +15529,7 @@
<jc>// Get a standard header.</jc>
CacheControl = headers.getCacheControl();
- }
+ }
</p>
<p>
Some important methods on this class are:
@@ -15341,10 +15554,36 @@
<!-- ==================================================================================================== -->
-<h4 class='topic todo' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.RequestAttributes' id='juneau-rest-server.RestMethod.RequestAttributes'>7.6.6 - RequestAttributes</a></h4>
+<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.RequestAttributes' id='juneau-rest-server.RestMethod.RequestAttributes'>7.6.6 - RequestAttributes</a></h4>
<div class='topic'><!-- START: 7.6.6 - juneau-rest-server.RestMethod.RequestAttributes -->
<p>
- TODO
+ The <a href="org/apache/juneau/rest/RequestAttributes.html" title="class in org.apache.juneau.rest"><code>RequestAttributes</code></a> object is the API for accessing the standard servlet attributes on an HTTP request
+ (i.e. <code>javax.servlet.http.ServletRequest#getAttribute(String)</code>.
+ It wraps the request attributes in a <code>Map</code> interface and provides several convenience methods.
+</p>
+<p>
+ The <c>RequestAttributes</c> object extends from <a href="org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau"><code>ObjectMap</code></a> so all the convenience methods defined on
+ that API are also available when working with request attributes:
+</p>
+<p class='bpcode w800'>
+ <ja>@RestMethod</ja>(...)
+ <jk>public</jk> Object myMethod(RequestAttributes attributes) {...}
+</p>
+<h5 class='figure'>Example:</h5>
+<p class='bpcode w800'>
+ <ja>@RestMethod</ja>(...)
+ <jk>public</jk> Object myMethod(RequestAttributes attributes) {
+
+ <jc>// Add a default value.</jc>
+ attributes.putIfNotExists(<js>"Foo"</js>, 123);
+
+ <jc>// Get an attribute value as a POJO.</jc>
+ UUID etag = attributes.get(<js>"ETag"</js>, UUID.<jk>class</jk>);
+ }
+</p>
+<p>
+ Modifications made to request attributes through the <c>RequestAttributes</c> bean are automatically reflected in
+ the underlying servlet request attributes making it possible to mix the usage of both APIs.
</p>
</div><!-- END: 7.6.6 - juneau-rest-server.RestMethod.RequestAttributes -->
diff --git a/content/site/apidocs-8.0.1/resources/fragments/about.html b/content/site/apidocs-8.0.1/resources/fragments/about.html
index 264e0ed..d64cdff 100644
--- a/content/site/apidocs-8.0.1/resources/fragments/about.html
+++ b/content/site/apidocs-8.0.1/resources/fragments/about.html
@@ -15,47 +15,91 @@
<p>
Apache Juneau™ is a single cohesive Java ecosystem consisting of the following parts:
</p>
-<ul class='spaced-list'>
- <li><b>juneau-marshall</b>
- <p>
+<table class='styled w800'>
+ <tr>
+ <th>Group</th><th>Component</th><th>Description</th>
+ </tr>
+ <tr class='dark bb'>
+ <td rowspan="5" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-core</td>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html#juneau-marshall'>juneau-marshall</a></td>
+ <td>
A universal toolkit for marshalling POJOs to a wide variety of content types using a common framework with no external library dependencies.
- </p>
- <li><b>juneau-dto</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-marshall-rdf'>juneau-marshall-rdf</a></td>
+ <td>
+ Extended marshalling support for RDF languages.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-dto'>juneau-dto</a></td>
+ <td>
A variety of predefined DTOs for serializing and parsing languages such as HTML5, Swagger and ATOM.
- </p>
- <li><b>juneau-svl</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-svl'>juneau-svl</a></td>
+ <td>
A simple yet powerful variable replacement language API.
- </p>
- <li><b>juneau-config</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-config'>juneau-config</a></td>
+ <td>
A sophisticated configuration file API.
- </p>
- <li><b>juneau-rest-server</b>
- <p>
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td rowspan="4" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-rest</td>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-rest-server'>juneau-rest-server</a></td>
+ <td>
A universal REST server API for creating Swagger-based self-documenting REST interfaces using POJOs, simply deployed as
one or more top-level servlets in any Servlet 3.1.0+ container.
- </p>
- <li><b>juneau-rest-server-springboot</b>
- <p>
- Spring Boot integration support.
- </p>
- <li><b>juneau-rest-client</b>
- <p>
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-rest-server-springboot'>juneau-rest-server-springboot</a></td>
+ <td>
+ Spring Boot integration support
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-rest-server-jaxrs'>juneau-rest-server-jaxrs</a></td>
+ <td>
+ JAX/RS integration support.
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-rest-client'>juneau-rest-client</a></td>
+ <td>
A universal REST client API for interacting with Juneau or 3rd-party REST interfaces using POJOs and proxy interfaces.
- </p>
- <li><b>juneau-microservice</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td rowspan="4" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-microservice</td>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-microservice-core'>juneau-microservice-core</a></td>
+ <td>
+ A base framework for defining microservices.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-microservice-jetty'>juneau-microservice-jetty</a></td>
+ <td>
A REST microservice API that combines all the features above with a simple configurable Jetty server for
creating lightweight standalone REST interfaces that start up in milliseconds.
- </p>
- <li><b>my-jetty-microservice.zip</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##my-jetty-microservice'>my-jetty-microservice</a></td>
+ <td>
Starter project template for Jetty-based microservices.
- </p>
- <li><b>my-springboot-microservice.zip</b>
- <p>
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##my-springboot-microservice'>my-springboot-microservice</a></td>
+ <td>
Starter project template for Spring-boot-based microservices.
- </p>
-</ul>
+ </td>
+ </tr>
+</table>
diff --git a/content/site/apidocs-8.0.1/resources/fragments/toc.html b/content/site/apidocs-8.0.1/resources/fragments/toc.html
index 06e1cfb..5d6c5b4 100644
--- a/content/site/apidocs-8.0.1/resources/fragments/toc.html
+++ b/content/site/apidocs-8.0.1/resources/fragments/toc.html
@@ -214,7 +214,7 @@
<li><p class=''><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestResource'>@RestResource</a></p>
<ol>
<li><p class=''><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestResource.AnnotationInheritance'>Annotation Inheritance</a></p>
- <li><p class='todo'><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestResource.RestResourcePath'>@RestResource(path)</a></p>
+ <li><p class='new'><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestResource.RestResourcePath'>@RestResource(path)</a></p>
</ol>
<li><p class=''><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestContext'>RestContext</a></p>
<li><p class=''><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestMethod'>@RestMethod</a></p>
@@ -224,7 +224,7 @@
<li><p class=''><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestMethod.RestResponse'>RestResponse</a></p>
<li><p class=''><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestMethod.RequestBody'>RequestBody</a></p>
<li><p class=''><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestMethod.RequestHeaders'>RequestHeaders</a></p>
- <li><p class='todo'><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestMethod.RequestAttributes'>RequestAttributes</a></p>
+ <li><p class='new'><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestMethod.RequestAttributes'>RequestAttributes</a></p>
<li><p class=''><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestMethod.RequestQuery'>RequestQuery</a></p>
<li><p class=''><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestMethod.RequestFormData'>RequestFormData</a></p>
<li><p class=''><a class='doclink' href='{OVERVIEW_URL}#juneau-rest-server.RestMethod.RestMethodPath'>@RestMethod(path)</a></p>
diff --git a/templates/about.html b/templates/about.html
index ebc4406..e5fd6b1 100644
--- a/templates/about.html
+++ b/templates/about.html
@@ -30,37 +30,94 @@
<p>
Apache Juneau™ is a single cohesive Java ecosystem consisting of the following parts:
</p>
- <ul class='spaced-list'>
- <li>
- <b>juneau-marshall</b>
- <br>A universal toolkit for marshalling POJOs to a wide variety of content types using a common framework.
- <li>
- <b>juneau-dto</b>
- <br>A set of predefined DTOs for serializing and parsing languages such as HTML5, Swagger and ATOM.
- <li>
- <b>juneau-svl</b>
- <br>A simple yet powerful variable replacement language API.
- <li>
- <b>juneau-config</b>
- <br>A sophisticated configuration API.
- <li>
- <b>juneau-rest-server</b>
- <br>A universal REST server API for creating REST interfaces using POJOs simply deployed in any Servlet 3.1.0+ container.
- <br>Includes auto-generation of Swagger and self-hosting of Swagger UI through OPTIONS page requests.
- <li>
- <b>juneau-rest-server-springboot</b>
- <br>Integration support for deploying Juneau-based REST resources as Spring beans in a Spring Boot application.
- <li>
- <b>juneau-rest-client</b>
- <br>A universal REST client API for interacting with Juneau or 3rd-party REST interfaces using POJOs and proxy interfaces.
- <li>
- <b>juneau-microservice</b>
- <br>A builder-based API for creating microservices.
- <li>
- <b>juneau-microservice-jetty</b>
- <br>REST microservice API that combines all the features above as a simple configurable Jetty server for
- creating lightweight standalone REST interfaces that start up in milliseconds.
- </ul>
+ <table class='styled w800'>
+ <tr>
+ <th>Group</th><th>Component</th><th>Description</th>
+ </tr>
+ <tr class='dark bb'>
+ <td rowspan="5" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-core</td>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html#juneau-marshall'>juneau-marshall</a></td>
+ <td>
+ A universal toolkit for marshalling POJOs to a wide variety of content types using a common framework with no external library dependencies.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-marshall-rdf'>juneau-marshall-rdf</a></td>
+ <td>
+ Extended marshalling support for RDF languages.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-dto'>juneau-dto</a></td>
+ <td>
+ A variety of predefined DTOs for serializing and parsing languages such as HTML5, Swagger and ATOM.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-svl'>juneau-svl</a></td>
+ <td>
+ A simple yet powerful variable replacement language API.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-config'>juneau-config</a></td>
+ <td>
+ A sophisticated configuration file API.
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td rowspan="4" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-rest</td>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-rest-server'>juneau-rest-server</a></td>
+ <td>
+ A universal REST server API for creating Swagger-based self-documenting REST interfaces using POJOs, simply deployed as
+ one or more top-level servlets in any Servlet 3.1.0+ container.
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-rest-server-springboot'>juneau-rest-server-springboot</a></td>
+ <td>
+ Spring Boot integration support
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-rest-server-jaxrs'>juneau-rest-server-jaxrs</a></td>
+ <td>
+ JAX/RS integration support.
+ </td>
+ </tr>
+ <tr class='light bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-rest-client'>juneau-rest-client</a></td>
+ <td>
+ A universal REST client API for interacting with Juneau or 3rd-party REST interfaces using POJOs and proxy interfaces.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td rowspan="4" style='text-align:center;font-weight:bold;padding:20px;' class='code'>juneau-microservice</td>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-microservice-core'>juneau-microservice-core</a></td>
+ <td>
+ A base framework for defining microservices.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##juneau-microservice-jetty'>juneau-microservice-jetty</a></td>
+ <td>
+ A REST microservice API that combines all the features above with a simple configurable Jetty server for
+ creating lightweight standalone REST interfaces that start up in milliseconds.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##my-jetty-microservice'>my-jetty-microservice</a></td>
+ <td>
+ Starter project template for Jetty-based microservices.
+ </td>
+ </tr>
+ <tr class='dark bb'>
+ <td class='code'><a class='doclink' href='http://juneau.apache.org/site/apidocs-{@property juneauVersion}/overview-summary.html##my-springboot-microservice'>my-springboot-microservice</a></td>
+ <td>
+ Starter project template for Spring-boot-based microservices.
+ </td>
+ </tr>
+ </table>
<p>
Questions via email to <a class='doclink' href='mailto:dev@juneau.apache.org?Subject=Apache%20Juneau%20question'>dev@juneau.apache.org</a> are always welcome.
</p>
diff --git a/templates/index.html b/templates/index.html
index cebc20f..e7cf347 100644
--- a/templates/index.html
+++ b/templates/index.html
@@ -44,7 +44,16 @@
<style>
@import url("styles/juneau-code.css");
@import url("styles/juneau-doc.css");
- html, body { margin:0px; height: 100%; width: 100%; font-family: sans-serif;}
+ html, body {
+ margin:0px;
+ height: 100%;
+ width: 100%;
+ font-family: varela round,sans-serif;
+ font-weight: 400;
+ font-size: 95%;
+ color: #34302d;
+ -webkit-font-smoothing: antialiased;
+ }
header {
background-color: #e8ebef;
font-size: 2.0em;