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 7fbde1614 Update about page.
7fbde1614 is described below
commit 7fbde1614ade9679b99f412db140bbc044549bfa
Author: JamesBognar <[email protected]>
AuthorDate: Sat Jul 2 09:28:03 2022 -0400
Update about page.
---
content/about.html | 194 +++++++++++++++++++++++++--------------------------
templates/about.html | 194 +++++++++++++++++++++++++--------------------------
2 files changed, 188 insertions(+), 200 deletions(-)
diff --git a/content/about.html b/content/about.html
index 3b41e403a..c121cdc15 100644
--- a/content/about.html
+++ b/content/about.html
@@ -251,82 +251,82 @@
modules provides servlets for quickly and seemlessly
deploying REST endpoints in a Spring Boot application.
</p>
<p class='bjava'>
- | <ja>@SpringBootApplication</ja>
- | <ja>@Controller</ja>
- | <jk>public class</jk> App {
- |
- | <jc>//Entry point method.</jc>
- | <jk>public static void</jk>
main(String[] <jv>args</jv>) {
- | <jk>new</jk>
SpringApplicationBuilder(App.<jk>class</jk>).run(<jv>args</jv>);
- | }
- |
- | <jc>// Our root REST bean.
- | // Note that this must extend from
{@link SpringRestServlet} to allow use of injection.
- | // All REST objects are attached to
this bean using the {@link Rest#children()} annotation.</jc>
- | <ja>@Bean</ja>
- | <jk>public</jk> RootResources
getRootResources() {
- | <jk>return new</jk>
RootResources();
- | }
- |
- | <jc>// Registers our REST bean at the
URI root.</jc>
- | <ja>@Bean</ja>
- | <jk>public</jk>
ServletRegistrationBean<Servlet> getRootServlet(RootResources
<jv>rootResources</jv>) {
- | <jk>return new</jk>
ServletRegistrationBean<>(<jv>rootResources</jv>, <js>"/*"</js>);
- | }
- |
- | <jc>// Injected child resource.</jc>
- | <ja>@Bean</ja>
- | <jk>public</jk> HelloWorldResource
getHelloWorldResource() {
- | <jk>return new</jk>
HelloWorldResource();
- | }
- |
- | <jc>// Injected child bean used in
injected child resource.</jc>
- | <ja>@Bean</ja>
- | <jk>public</jk>
HelloWorldMessageProvider getHelloWorldMessageProvider() {
- | <jk>return new</jk>
HelloWorldMessageProvider(<js>"Hello Spring injection user!"</js>);
- | }
- | }
+ <ja>@SpringBootApplication</ja>
+ <ja>@Controller</ja>
+ <jk>public class</jk> App {
+
+ <jc>//Entry point method.</jc>
+ <jk>public static void</jk> main(String[] <jv>args</jv>) {
+ <jk>new</jk>
SpringApplicationBuilder(App.<jk>class</jk>).run(<jv>args</jv>);
+ }
+
+ <jc>// Our root REST bean.
+ // Note that this must extend from {@link SpringRestServlet} to
allow use of injection.
+ // All REST objects are attached to this bean using the {@link
Rest#children()} annotation.</jc>
+ <ja>@Bean</ja>
+ <jk>public</jk> RootResources getRootResources() {
+ <jk>return new</jk> RootResources();
+ }
+
+ <jc>// Registers our REST bean at the URI root.</jc>
+ <ja>@Bean</ja>
+ <jk>public</jk> ServletRegistrationBean<Servlet>
getRootServlet(RootResources <jv>rootResources</jv>) {
+ <jk>return new</jk>
ServletRegistrationBean<>(<jv>rootResources</jv>, <js>"/*"</js>);
+ }
+
+ <jc>// Injected child resource.</jc>
+ <ja>@Bean</ja>
+ <jk>public</jk> HelloWorldResource getHelloWorldResource() {
+ <jk>return new</jk> HelloWorldResource();
+ }
+
+ <jc>// Injected child bean used in injected child resource.</jc>
+ <ja>@Bean</ja>
+ <jk>public</jk> HelloWorldMessageProvider
getHelloWorldMessageProvider() {
+ <jk>return new</jk>
HelloWorldMessageProvider(<js>"Hello Spring injection user!"</js>);
+ }
+ }
</p>
<p>
Our root resource servlet serves as a router page. It
is defined as follows:
</p>
<p class='bjava'>
- | <ja>@Rest</ja>(
- | title=<js>"Root resources"</js>,
- | description=<js>"Example of a router
resource page."</js>,
- | children={
- |
HelloWorldResource.<jk>class</jk>,
- | }
- | )
- | <ja>@HtmlDocConfig</ja>(
- | widgets={
- |
ContentTypeMenuItem.<jk>class</jk>
- | },
- | navlinks={
- | <js>"api: servlet:/api"</js>,
- | <js>"stats:
servlet:/stats"</js>,
- |
<js>"$W{ContentTypeMenuItem}"</js>,
- | <js>"source:
$C{Source/gitHub}/org/apache/juneau/examples/rest/$R{servletClassSimple}.java"</js>
- | },
- | aside={
- | <js>"<div
class='text'>"</js>,
- | <js>" <p>This is an
example of a 'router' page that serves as a jumping-off point to child
resources.</p>"</js>,
- | <js>" <p>Resources can
be nested arbitrarily deep through router pages.</p>"</js>,
- | <js>" <p>Note the
<span class='link'>API</span> link provided that lets you see the
generated swagger doc for this page.</p>"</js>,
- | <js>" <p>Also note the
<span class='link'>STATS</span> link that provides basic usage
statistics.</p>"</js>,
- | <js>" <p>Also note the
<span class='link'>SOURCE</span> link on these pages to view the
source code for the page.</p>"</js>,
- | <js>" <p>All content on
pages in the UI are serialized POJOs. In this case, it's a serialized array of
beans with 2 properties, 'name' and 'description'.</p>"</js>,
- | <js>" <p>Other features
(such as this aside) are added through annotations.</p>"</js>,
- | <js>"</div>"</js>
- | },
- | asideFloat="RIGHT"
- | )
- | <ja>@SerializerConfig</ja>(
- | quoteChar=<js>"'"</js>
- | )
- | <jk>public class</jk> RootResources
<jk>extends</jk> BasicSpringRestServletGroup <jk>implements</jk>
BasicUniversalConfig {
- | <jk>private static final long</jk>
<jsf>serialVersionUID</jsf> = 1L;
- | }
+ <ja>@Rest</ja>(
+ title=<js>"Root resources"</js>,
+ description=<js>"Example of a router resource page."</js>,
+ children={
+ HelloWorldResource.<jk>class</jk>,
+ }
+ )
+ <ja>@HtmlDocConfig</ja>(
+ widgets={
+ ContentTypeMenuItem.<jk>class</jk>
+ },
+ navlinks={
+ <js>"api: servlet:/api"</js>,
+ <js>"stats: servlet:/stats"</js>,
+ <js>"$W{ContentTypeMenuItem}"</js>,
+ <js>"source:
$C{Source/gitHub}/org/apache/juneau/examples/rest/$R{servletClassSimple}.java"</js>
+ },
+ aside={
+ <js>"<div class='text'>"</js>,
+ <js>" <p>This is an example of a 'router' page
that serves as a jumping-off point to child resources.</p>"</js>,
+ <js>" <p>Resources can be nested arbitrarily
deep through router pages.</p>"</js>,
+ <js>" <p>Note the <span
class='link'>API</span> link provided that lets you see the generated
swagger doc for this page.</p>"</js>,
+ <js>" <p>Also note the <span
class='link'>STATS</span> link that provides basic usage
statistics.</p>"</js>,
+ <js>" <p>Also note the <span
class='link'>SOURCE</span> link on these pages to view the source code
for the page.</p>"</js>,
+ <js>" <p>All content on pages in the UI are
serialized POJOs. In this case, it's a serialized array of beans with 2
properties, 'name' and 'description'.</p>"</js>,
+ <js>" <p>Other features (such as this aside)
are added through annotations.</p>"</js>,
+ <js>"</div>"</js>
+ },
+ asideFloat="RIGHT"
+ )
+ <ja>@SerializerConfig</ja>(
+ quoteChar=<js>"'"</js>
+ )
+ <jk>public class</jk> RootResources <jk>extends</jk>
BasicSpringRestServletGroup <jk>implements</jk> BasicUniversalConfig {
+ <jk>private static final long</jk> <jsf>serialVersionUID</jsf>
= 1L;
+ }
</p>
<h5 class='figure'>HTML representation</h5>
@@ -340,39 +340,33 @@
defined as an injected bean.
</p>
<p class='bjava'>
- | <ja>@Rest</ja>(
- | title=<js>"Hello World"</js>,
- | description=<js>"An example of the
simplest-possible resource"</js>,
- | path=<js>"/helloWorld"</js>
- | )
- | <ja>@HtmlDocConfig</ja>(
- | aside={
- | <js>"<div
style='max-width:400px' class='text'>"</js>,
- | <js>" <p>This page
shows a resource that simply response with a 'Hello world!'
message</p>"</js>,
- | <js>" <p>The POJO
serialized is a simple String.</p>"</js>,
- | <js>"</div>"</js>
- | }
- | )
- | <jk>public class</jk> HelloWorldResource
<jk>extends</jk> BasicRestObject <jk>implements</jk> BasicUniversalConfig {
- |
- | <ja>@Inject</ja>
- | <jk>private</jk>
HelloWorldMessageProvider <jf>messageProvider</jf>;
- |
- | <ja>@RestGet</ja>(path=<js>"/*"</js>,
summary=<js>"Responds with injected message"</js>)
- | <jk>public</jk> String sayHello() {
- | <jk>return</jk>
<jf>messageProvider</jf>.get();
- | }
- | }
+ <ja>@Rest</ja>(
+ title=<js>"Hello World"</js>,
+ description=<js>"An example of the simplest-possible
resource"</js>,
+ path=<js>"/helloWorld"</js>
+ )
+ <ja>@HtmlDocConfig</ja>(
+ aside={
+ <js>"<div style='max-width:400px'
class='text'>"</js>,
+ <js>" <p>This page shows a resource that simply
response with a 'Hello world!' message</p>"</js>,
+ <js>" <p>The POJO serialized is a simple
String.</p>"</js>,
+ <js>"</div>"</js>
+ }
+ )
+ <jk>public class</jk> HelloWorldResource <jk>extends</jk>
BasicRestObject <jk>implements</jk> BasicUniversalConfig {
+
+ <ja>@Inject</ja>
+ <jk>private</jk> HelloWorldMessageProvider
<jf>messageProvider</jf>;
+
+ <ja>@RestGet</ja>(path=<js>"/*"</js>, summary=<js>"Responds
with injected message"</js>)
+ <jk>public</jk> String sayHello() {
+ <jk>return</jk> <jf>messageProvider</jf>.get();
+ }
+ }
</p>
<h5 class='figure'>HTML representation</h5>
<img class='bordered w800'
src='images/jrss.Overview.HelloWorldResource.png'>
-
-
-
-
-
-
<ul class='spaced-list'>
<li>
Fast memory-efficient serialization.
diff --git a/templates/about.html b/templates/about.html
index 7c6159767..392099eee 100644
--- a/templates/about.html
+++ b/templates/about.html
@@ -251,82 +251,82 @@
modules provides servlets for quickly and seemlessly
deploying REST endpoints in a Spring Boot application.
</p>
<p class='bjava'>
- | <ja>@SpringBootApplication</ja>
- | <ja>@Controller</ja>
- | <jk>public class</jk> App {
- |
- | <jc>//Entry point method.</jc>
- | <jk>public static void</jk>
main(String[] <jv>args</jv>) {
- | <jk>new</jk>
SpringApplicationBuilder(App.<jk>class</jk>).run(<jv>args</jv>);
- | }
- |
- | <jc>// Our root REST bean.
- | // Note that this must extend from
{@link SpringRestServlet} to allow use of injection.
- | // All REST objects are attached to
this bean using the {@link Rest#children()} annotation.</jc>
- | <ja>@Bean</ja>
- | <jk>public</jk> RootResources
getRootResources() {
- | <jk>return new</jk>
RootResources();
- | }
- |
- | <jc>// Registers our REST bean at the
URI root.</jc>
- | <ja>@Bean</ja>
- | <jk>public</jk>
ServletRegistrationBean<Servlet> getRootServlet(RootResources
<jv>rootResources</jv>) {
- | <jk>return new</jk>
ServletRegistrationBean<>(<jv>rootResources</jv>, <js>"/*"</js>);
- | }
- |
- | <jc>// Injected child resource.</jc>
- | <ja>@Bean</ja>
- | <jk>public</jk> HelloWorldResource
getHelloWorldResource() {
- | <jk>return new</jk>
HelloWorldResource();
- | }
- |
- | <jc>// Injected child bean used in
injected child resource.</jc>
- | <ja>@Bean</ja>
- | <jk>public</jk>
HelloWorldMessageProvider getHelloWorldMessageProvider() {
- | <jk>return new</jk>
HelloWorldMessageProvider(<js>"Hello Spring injection user!"</js>);
- | }
- | }
+ <ja>@SpringBootApplication</ja>
+ <ja>@Controller</ja>
+ <jk>public class</jk> App {
+
+ <jc>//Entry point method.</jc>
+ <jk>public static void</jk> main(String[] <jv>args</jv>) {
+ <jk>new</jk>
SpringApplicationBuilder(App.<jk>class</jk>).run(<jv>args</jv>);
+ }
+
+ <jc>// Our root REST bean.
+ // Note that this must extend from {@link SpringRestServlet} to
allow use of injection.
+ // All REST objects are attached to this bean using the {@link
Rest#children()} annotation.</jc>
+ <ja>@Bean</ja>
+ <jk>public</jk> RootResources getRootResources() {
+ <jk>return new</jk> RootResources();
+ }
+
+ <jc>// Registers our REST bean at the URI root.</jc>
+ <ja>@Bean</ja>
+ <jk>public</jk> ServletRegistrationBean<Servlet>
getRootServlet(RootResources <jv>rootResources</jv>) {
+ <jk>return new</jk>
ServletRegistrationBean<>(<jv>rootResources</jv>, <js>"/*"</js>);
+ }
+
+ <jc>// Injected child resource.</jc>
+ <ja>@Bean</ja>
+ <jk>public</jk> HelloWorldResource getHelloWorldResource() {
+ <jk>return new</jk> HelloWorldResource();
+ }
+
+ <jc>// Injected child bean used in injected child resource.</jc>
+ <ja>@Bean</ja>
+ <jk>public</jk> HelloWorldMessageProvider
getHelloWorldMessageProvider() {
+ <jk>return new</jk>
HelloWorldMessageProvider(<js>"Hello Spring injection user!"</js>);
+ }
+ }
</p>
<p>
Our root resource servlet serves as a router page. It
is defined as follows:
</p>
<p class='bjava'>
- | <ja>@Rest</ja>(
- | title=<js>"Root resources"</js>,
- | description=<js>"Example of a router
resource page."</js>,
- | children={
- |
HelloWorldResource.<jk>class</jk>,
- | }
- | )
- | <ja>@HtmlDocConfig</ja>(
- | widgets={
- |
ContentTypeMenuItem.<jk>class</jk>
- | },
- | navlinks={
- | <js>"api: servlet:/api"</js>,
- | <js>"stats:
servlet:/stats"</js>,
- |
<js>"$W{ContentTypeMenuItem}"</js>,
- | <js>"source:
$C{Source/gitHub}/org/apache/juneau/examples/rest/$R{servletClassSimple}.java"</js>
- | },
- | aside={
- | <js>"<div
class='text'>"</js>,
- | <js>" <p>This is an
example of a 'router' page that serves as a jumping-off point to child
resources.</p>"</js>,
- | <js>" <p>Resources can
be nested arbitrarily deep through router pages.</p>"</js>,
- | <js>" <p>Note the
<span class='link'>API</span> link provided that lets you see the
generated swagger doc for this page.</p>"</js>,
- | <js>" <p>Also note the
<span class='link'>STATS</span> link that provides basic usage
statistics.</p>"</js>,
- | <js>" <p>Also note the
<span class='link'>SOURCE</span> link on these pages to view the
source code for the page.</p>"</js>,
- | <js>" <p>All content on
pages in the UI are serialized POJOs. In this case, it's a serialized array of
beans with 2 properties, 'name' and 'description'.</p>"</js>,
- | <js>" <p>Other features
(such as this aside) are added through annotations.</p>"</js>,
- | <js>"</div>"</js>
- | },
- | asideFloat="RIGHT"
- | )
- | <ja>@SerializerConfig</ja>(
- | quoteChar=<js>"'"</js>
- | )
- | <jk>public class</jk> RootResources
<jk>extends</jk> BasicSpringRestServletGroup <jk>implements</jk>
BasicUniversalConfig {
- | <jk>private static final long</jk>
<jsf>serialVersionUID</jsf> = 1L;
- | }
+ <ja>@Rest</ja>(
+ title=<js>"Root resources"</js>,
+ description=<js>"Example of a router resource page."</js>,
+ children={
+ HelloWorldResource.<jk>class</jk>,
+ }
+ )
+ <ja>@HtmlDocConfig</ja>(
+ widgets={
+ ContentTypeMenuItem.<jk>class</jk>
+ },
+ navlinks={
+ <js>"api: servlet:/api"</js>,
+ <js>"stats: servlet:/stats"</js>,
+ <js>"$W{ContentTypeMenuItem}"</js>,
+ <js>"source:
$C{Source/gitHub}/org/apache/juneau/examples/rest/$R{servletClassSimple}.java"</js>
+ },
+ aside={
+ <js>"<div class='text'>"</js>,
+ <js>" <p>This is an example of a 'router' page
that serves as a jumping-off point to child resources.</p>"</js>,
+ <js>" <p>Resources can be nested arbitrarily
deep through router pages.</p>"</js>,
+ <js>" <p>Note the <span
class='link'>API</span> link provided that lets you see the generated
swagger doc for this page.</p>"</js>,
+ <js>" <p>Also note the <span
class='link'>STATS</span> link that provides basic usage
statistics.</p>"</js>,
+ <js>" <p>Also note the <span
class='link'>SOURCE</span> link on these pages to view the source code
for the page.</p>"</js>,
+ <js>" <p>All content on pages in the UI are
serialized POJOs. In this case, it's a serialized array of beans with 2
properties, 'name' and 'description'.</p>"</js>,
+ <js>" <p>Other features (such as this aside)
are added through annotations.</p>"</js>,
+ <js>"</div>"</js>
+ },
+ asideFloat="RIGHT"
+ )
+ <ja>@SerializerConfig</ja>(
+ quoteChar=<js>"'"</js>
+ )
+ <jk>public class</jk> RootResources <jk>extends</jk>
BasicSpringRestServletGroup <jk>implements</jk> BasicUniversalConfig {
+ <jk>private static final long</jk> <jsf>serialVersionUID</jsf>
= 1L;
+ }
</p>
<h5 class='figure'>HTML representation</h5>
@@ -340,39 +340,33 @@
defined as an injected bean.
</p>
<p class='bjava'>
- | <ja>@Rest</ja>(
- | title=<js>"Hello World"</js>,
- | description=<js>"An example of the
simplest-possible resource"</js>,
- | path=<js>"/helloWorld"</js>
- | )
- | <ja>@HtmlDocConfig</ja>(
- | aside={
- | <js>"<div
style='max-width:400px' class='text'>"</js>,
- | <js>" <p>This page
shows a resource that simply response with a 'Hello world!'
message</p>"</js>,
- | <js>" <p>The POJO
serialized is a simple String.</p>"</js>,
- | <js>"</div>"</js>
- | }
- | )
- | <jk>public class</jk> HelloWorldResource
<jk>extends</jk> BasicRestObject <jk>implements</jk> BasicUniversalConfig {
- |
- | <ja>@Inject</ja>
- | <jk>private</jk>
HelloWorldMessageProvider <jf>messageProvider</jf>;
- |
- | <ja>@RestGet</ja>(path=<js>"/*"</js>,
summary=<js>"Responds with injected message"</js>)
- | <jk>public</jk> String sayHello() {
- | <jk>return</jk>
<jf>messageProvider</jf>.get();
- | }
- | }
+ <ja>@Rest</ja>(
+ title=<js>"Hello World"</js>,
+ description=<js>"An example of the simplest-possible
resource"</js>,
+ path=<js>"/helloWorld"</js>
+ )
+ <ja>@HtmlDocConfig</ja>(
+ aside={
+ <js>"<div style='max-width:400px'
class='text'>"</js>,
+ <js>" <p>This page shows a resource that simply
response with a 'Hello world!' message</p>"</js>,
+ <js>" <p>The POJO serialized is a simple
String.</p>"</js>,
+ <js>"</div>"</js>
+ }
+ )
+ <jk>public class</jk> HelloWorldResource <jk>extends</jk>
BasicRestObject <jk>implements</jk> BasicUniversalConfig {
+
+ <ja>@Inject</ja>
+ <jk>private</jk> HelloWorldMessageProvider
<jf>messageProvider</jf>;
+
+ <ja>@RestGet</ja>(path=<js>"/*"</js>, summary=<js>"Responds
with injected message"</js>)
+ <jk>public</jk> String sayHello() {
+ <jk>return</jk> <jf>messageProvider</jf>.get();
+ }
+ }
</p>
<h5 class='figure'>HTML representation</h5>
<img class='bordered w800'
src='images/jrss.Overview.HelloWorldResource.png'>
-
-
-
-
-
-
<ul class='spaced-list'>
<li>
Fast memory-efficient serialization.
