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/11/19 19:37:29 UTC

[juneau] branch master updated: Springboot 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 6264463  Springboot javadocs.
6264463 is described below

commit 626446393de06e08f6e71f2df75a029929d36cb0
Author: JamesBognar <ja...@apache.org>
AuthorDate: Mon Nov 19 14:37:18 2018 -0500

    Springboot javadocs.
---
 ...tml => 13.juneau-examples-rest-springboot.html} | 13 ++---
 .../01.Classes.html}                               |  8 +--
 .../02.DeployingToHeroku.html}                     |  8 +--
 .../Topics/{13.Security.html => 14.Security.html}  |  0
 .../01.juneau-marshall.html                        |  0
 .../02.juneau-svl.html                             |  0
 .../03.juneau-rest-server.html                     |  0
 juneau-doc/src/main/javadoc/overview.html          | 61 +++++++++++++++++-----
 juneau-doc/src/main/javadoc/resources/docs.txt     |  3 ++
 .../src/main/javadoc/resources/fragments/toc.html  |  5 ++
 10 files changed, 68 insertions(+), 30 deletions(-)

diff --git a/juneau-doc/docs/Topics/13.Security.html b/juneau-doc/docs/Topics/13.juneau-examples-rest-springboot.html
similarity index 78%
copy from juneau-doc/docs/Topics/13.Security.html
copy to juneau-doc/docs/Topics/13.juneau-examples-rest-springboot.html
index 214f1da..eb753b9 100644
--- a/juneau-doc/docs/Topics/13.Security.html
+++ b/juneau-doc/docs/Topics/13.juneau-examples-rest-springboot.html
@@ -13,12 +13,13 @@
  ***************************************************************************************************************************/
  -->
 
-Security Best-Practices
+{todo} juneau-examples-rest-springboot
+
+<h5 class='figure'>Archive File</h5>
+<p class='bpcode w500'>
+	juneau-examples-rest-springboot-{@property juneauVersion}.bin.zip 
+</p>	
 
 <p>
-	Security is always an ongoing concern in any library.  
-	If you discover any security vulnerabilities in this code, please refer to the instructions found here:
+	TODO
 </p>
-<ul class='spaced-list'>
-	<li class='extlink'>{@doc http://www.apache.org/security SECURITY}
-</ul>
diff --git a/juneau-doc/docs/Topics/13.Security.html b/juneau-doc/docs/Topics/13.juneau-examples-rest-springboot/01.Classes.html
similarity index 78%
copy from juneau-doc/docs/Topics/13.Security.html
copy to juneau-doc/docs/Topics/13.juneau-examples-rest-springboot/01.Classes.html
index 214f1da..420d290 100644
--- a/juneau-doc/docs/Topics/13.Security.html
+++ b/juneau-doc/docs/Topics/13.juneau-examples-rest-springboot/01.Classes.html
@@ -13,12 +13,8 @@
  ***************************************************************************************************************************/
  -->
 
-Security Best-Practices
+{todo} Classes
 
 <p>
-	Security is always an ongoing concern in any library.  
-	If you discover any security vulnerabilities in this code, please refer to the instructions found here:
+	TODO
 </p>
-<ul class='spaced-list'>
-	<li class='extlink'>{@doc http://www.apache.org/security SECURITY}
-</ul>
diff --git a/juneau-doc/docs/Topics/13.Security.html b/juneau-doc/docs/Topics/13.juneau-examples-rest-springboot/02.DeployingToHeroku.html
similarity index 78%
copy from juneau-doc/docs/Topics/13.Security.html
copy to juneau-doc/docs/Topics/13.juneau-examples-rest-springboot/02.DeployingToHeroku.html
index 214f1da..8f71344 100644
--- a/juneau-doc/docs/Topics/13.Security.html
+++ b/juneau-doc/docs/Topics/13.juneau-examples-rest-springboot/02.DeployingToHeroku.html
@@ -13,12 +13,8 @@
  ***************************************************************************************************************************/
  -->
 
-Security Best-Practices
+{todo} Deploying to Heroku
 
 <p>
-	Security is always an ongoing concern in any library.  
-	If you discover any security vulnerabilities in this code, please refer to the instructions found here:
+	TODO
 </p>
-<ul class='spaced-list'>
-	<li class='extlink'>{@doc http://www.apache.org/security SECURITY}
-</ul>
diff --git a/juneau-doc/docs/Topics/13.Security.html b/juneau-doc/docs/Topics/14.Security.html
similarity index 100%
rename from juneau-doc/docs/Topics/13.Security.html
rename to juneau-doc/docs/Topics/14.Security.html
diff --git a/juneau-doc/docs/Topics/13.Security/01.juneau-marshall.html b/juneau-doc/docs/Topics/14.Security/01.juneau-marshall.html
similarity index 100%
rename from juneau-doc/docs/Topics/13.Security/01.juneau-marshall.html
rename to juneau-doc/docs/Topics/14.Security/01.juneau-marshall.html
diff --git a/juneau-doc/docs/Topics/13.Security/02.juneau-svl.html b/juneau-doc/docs/Topics/14.Security/02.juneau-svl.html
similarity index 100%
rename from juneau-doc/docs/Topics/13.Security/02.juneau-svl.html
rename to juneau-doc/docs/Topics/14.Security/02.juneau-svl.html
diff --git a/juneau-doc/docs/Topics/13.Security/03.juneau-rest-server.html b/juneau-doc/docs/Topics/14.Security/03.juneau-rest-server.html
similarity index 100%
rename from juneau-doc/docs/Topics/13.Security/03.juneau-rest-server.html
rename to juneau-doc/docs/Topics/14.Security/03.juneau-rest-server.html
diff --git a/juneau-doc/src/main/javadoc/overview.html b/juneau-doc/src/main/javadoc/overview.html
index c403990..c9c5b08 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -423,6 +423,11 @@
 		<li><p class=''><a class='doclink' href='#juneau-examples-rest.ConfigResource'>ConfigResource</a></p>
 		<li><p class=''><a class='doclink' href='#juneau-examples-rest.LogsResource'>LogsResource</a></p>
 	</ol>
+	<li><p class='toc2 todo'><a class='doclink' href='#juneau-examples-rest-springboot'>juneau-examples-rest-springboot</a></p>
+	<ol>
+		<li><p class='todo'><a class='doclink' href='#juneau-examples-rest-springboot.Classes'>Classes</a></p>
+		<li><p class='todo'><a class='doclink' href='#juneau-examples-rest-springboot.DeployingToHeroku'>Deploying to Heroku</a></p>
+	</ol>
 	<li><p class='toc2 '><a class='doclink' href='#Security'>Security Best-Practices</a></p>
 	<ol>
 		<li><p class=''><a class='doclink' href='#Security.juneau-marshall'>juneau-marshall</a></p>
@@ -26210,8 +26215,40 @@
 
 <!-- ==================================================================================================== -->
 
-<h2 class='topic ' onclick='toggle(this)'><a href='#Security' id='Security'>13 - Security Best-Practices</a></h2>
-<div class='topic'><!-- START: 13 - Security -->
+<h2 class='topic todo' onclick='toggle(this)'><a href='#juneau-examples-rest-springboot' id='juneau-examples-rest-springboot'>13 - juneau-examples-rest-springboot</a></h2>
+<div class='topic'><!-- START: 13 - juneau-examples-rest-springboot -->
+<h5 class='figure'>Archive File</h5>
+<p class='bpcode w500'>
+	juneau-examples-rest-springboot-{@property juneauVersion}.bin.zip 
+</p>	
+
+<p>
+	TODO
+</p>
+
+<!-- ==================================================================================================== -->
+
+<h3 class='topic todo' onclick='toggle(this)'><a href='#juneau-examples-rest-springboot.Classes' id='juneau-examples-rest-springboot.Classes'>13.1 - Classes</a></h3>
+<div class='topic'><!-- START: 13.1 - juneau-examples-rest-springboot.Classes -->
+<p>
+	TODO
+</p>
+</div><!-- END: 13.1 - juneau-examples-rest-springboot.Classes -->
+
+<!-- ==================================================================================================== -->
+
+<h3 class='topic todo' onclick='toggle(this)'><a href='#juneau-examples-rest-springboot.DeployingToHeroku' id='juneau-examples-rest-springboot.DeployingToHeroku'>13.2 - Deploying to Heroku</a></h3>
+<div class='topic'><!-- START: 13.2 - juneau-examples-rest-springboot.DeployingToHeroku -->
+<p>
+	TODO
+</p>
+</div><!-- END: 13.2 - juneau-examples-rest-springboot.DeployingToHeroku -->
+</div><!-- END: 13 - juneau-examples-rest-springboot -->
+
+<!-- ==================================================================================================== -->
+
+<h2 class='topic ' onclick='toggle(this)'><a href='#Security' id='Security'>14 - Security Best-Practices</a></h2>
+<div class='topic'><!-- START: 14 - Security -->
 <p>
 	Security is always an ongoing concern in any library.  
 	If you discover any security vulnerabilities in this code, please refer to the instructions found here:
@@ -26222,8 +26259,8 @@
 
 <!-- ==================================================================================================== -->
 
-<h3 class='topic ' onclick='toggle(this)'><a href='#Security.juneau-marshall' id='Security.juneau-marshall'>13.1 - juneau-marshall</a></h3>
-<div class='topic'><!-- START: 13.1 - Security.juneau-marshall -->
+<h3 class='topic ' onclick='toggle(this)'><a href='#Security.juneau-marshall' id='Security.juneau-marshall'>14.1 - juneau-marshall</a></h3>
+<div class='topic'><!-- START: 14.1 - Security.juneau-marshall -->
 <h5 class='topic'>Demarshalling vulnerabilities</h5>
 <p>
 	One common security vulnerability is the ability to create arbitrary Java object instances through crafted
@@ -26296,12 +26333,12 @@
 	<li>The RDF parsers rely on Apache Jena 2.7.1.  
 		As of <code>7.0.1</code>, no known security vulnerabilities exist that affect Juneau at this time.
 </ul>
-</div><!-- END: 13.1 - Security.juneau-marshall -->
+</div><!-- END: 14.1 - Security.juneau-marshall -->
 
 <!-- ==================================================================================================== -->
 
-<h3 class='topic ' onclick='toggle(this)'><a href='#Security.juneau-svl' id='Security.juneau-svl'>13.2 - juneau-svl</a></h3>
-<div class='topic'><!-- START: 13.2 - Security.juneau-svl -->
+<h3 class='topic ' onclick='toggle(this)'><a href='#Security.juneau-svl' id='Security.juneau-svl'>14.2 - juneau-svl</a></h3>
+<div class='topic'><!-- START: 14.2 - Security.juneau-svl -->
 <p>
 	Care must be used when defining new {@link org.apache.juneau.svl.Var Vars} using the SVL API since mistakes 
 	could potentially expose system properties, environment variables, or even file system files.
@@ -26346,12 +26383,12 @@
 	{@link org.apache.juneau.svl.Var#allowNested()} and {@link org.apache.juneau.svl.Var#allowRecurse()} 
 	methods to prevent recursive handling of variables.
 </p>
-</div><!-- END: 13.2 - Security.juneau-svl -->
+</div><!-- END: 14.2 - Security.juneau-svl -->
 
 <!-- ==================================================================================================== -->
 
-<h3 class='topic ' onclick='toggle(this)'><a href='#Security.juneau-rest-server' id='Security.juneau-rest-server'>13.3 - juneau-rest-server</a></h3>
-<div class='topic'><!-- START: 13.3 - Security.juneau-rest-server -->
+<h3 class='topic ' onclick='toggle(this)'><a href='#Security.juneau-rest-server' id='Security.juneau-rest-server'>14.3 - juneau-rest-server</a></h3>
+<div class='topic'><!-- START: 14.3 - Security.juneau-rest-server -->
 <p>
 	Denial of service attacks can be alleviated through the {@link org.apache.juneau.rest.annotation.RestResource#maxInput() maxInput()}
 	setting.  Arbitrarily-large input will trigger an exception before causing out-of-memory errors.
@@ -26363,8 +26400,8 @@
 	becomes an issue.  However, this is NOT true of the RDF parsers that use an intermediate DOM.  If parsing 
 	RDF, you may want to consider lowering the max-input value above.
 </p>
-</div><!-- END: 13.3 - Security.juneau-rest-server -->
-</div><!-- END: 13 - Security -->
+</div><!-- END: 14.3 - Security.juneau-rest-server -->
+</div><!-- END: 14 - Security -->
 
 
 <h2 class='topic' onclick='toggle(this)'><a href='#ReleaseNotes' id='ReleaseNotes'>Release Notes</a></h2>
diff --git a/juneau-doc/src/main/javadoc/resources/docs.txt b/juneau-doc/src/main/javadoc/resources/docs.txt
index 98d7aaa..c6511d7 100644
--- a/juneau-doc/src/main/javadoc/resources/docs.txt
+++ b/juneau-doc/src/main/javadoc/resources/docs.txt
@@ -90,6 +90,9 @@ juneau-dto.Swagger = #juneau-dto.Swagger, Overview > juneau-dto > Swagger
 juneau-dto.SwaggerUI = #juneau-dto.SwaggerUI, Overview > juneau-dto > Swagger UI
 juneau-examples-core = #juneau-examples-core, Overview > juneau-examples-core
 juneau-examples-rest = #juneau-examples-rest, Overview > juneau-examples-rest
+juneau-examples-rest-springboot = #juneau-examples-rest-springboot, Overview > juneau-examples-rest-springboot
+juneau-examples-rest-springboot.Classes = #juneau-examples-rest-springboot.Classes, Overview > juneau-examples-rest-springboot > Classes
+juneau-examples-rest-springboot.DeployingToHeroku = #juneau-examples-rest-springboot.DeployingToHeroku, Overview > juneau-examples-rest-springboot > Deploying to Heroku
 juneau-examples-rest.ConfigResource = #juneau-examples-rest.ConfigResource, Overview > juneau-examples-rest > ConfigResource
 juneau-examples-rest.DtoExamples = #juneau-examples-rest.DtoExamples, Overview > juneau-examples-rest > DtoExamples
 juneau-examples-rest.HelloWorldResource = #juneau-examples-rest.HelloWorldResource, Overview > juneau-examples-rest > HelloWorldResource
diff --git a/juneau-doc/src/main/javadoc/resources/fragments/toc.html b/juneau-doc/src/main/javadoc/resources/fragments/toc.html
index f94fb68..c09c7dc 100644
--- a/juneau-doc/src/main/javadoc/resources/fragments/toc.html
+++ b/juneau-doc/src/main/javadoc/resources/fragments/toc.html
@@ -366,6 +366,11 @@
 		<li><p class=''><a class='doclink' href='{OVERVIEW_URL}#juneau-examples-rest.ConfigResource'>ConfigResource</a></p>
 		<li><p class=''><a class='doclink' href='{OVERVIEW_URL}#juneau-examples-rest.LogsResource'>LogsResource</a></p>
 	</ol>
+	<li><p class='toc2 todo'><a class='doclink' href='{OVERVIEW_URL}#juneau-examples-rest-springboot'>juneau-examples-rest-springboot</a></p>
+	<ol>
+		<li><p class='todo'><a class='doclink' href='{OVERVIEW_URL}#juneau-examples-rest-springboot.Classes'>Classes</a></p>
+		<li><p class='todo'><a class='doclink' href='{OVERVIEW_URL}#juneau-examples-rest-springboot.DeployingToHeroku'>Deploying to Heroku</a></p>
+	</ol>
 	<li><p class='toc2 '><a class='doclink' href='{OVERVIEW_URL}#Security'>Security Best-Practices</a></p>
 	<ol>
 		<li><p class=''><a class='doclink' href='{OVERVIEW_URL}#Security.juneau-marshall'>juneau-marshall</a></p>