You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-commits@axis.apache.org by ro...@apache.org on 2021/07/28 17:47:39 UTC
[axis-axis2-java-core] branch master updated: more doc updates
This is an automated email from the ASF dual-hosted git repository.
robertlazarski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/axis-axis2-java-core.git
The following commit(s) were added to refs/heads/master by this push:
new 8d5a5b5 more doc updates
8d5a5b5 is described below
commit 8d5a5b528c7cbf9542435e3ed7d95ce12036b2f2
Author: Robert Lazarski <ro...@gmail.com>
AuthorDate: Wed Jul 28 07:46:26 2021 -1000
more doc updates
---
src/site/xdoc/docs/json-springboot-userguide.xml | 16 +++++++++++-----
src/site/xdoc/docs/json_support.xml | 8 ++++++++
src/site/xdoc/docs/json_support_gson.xml | 10 +++++++++-
src/site/xdoc/docs/toc.xml | 1 +
4 files changed, 29 insertions(+), 6 deletions(-)
diff --git a/src/site/xdoc/docs/json-springboot-userguide.xml b/src/site/xdoc/docs/json-springboot-userguide.xml
index 4c43144..ae42d03 100644
--- a/src/site/xdoc/docs/json-springboot-userguide.xml
+++ b/src/site/xdoc/docs/json-springboot-userguide.xml
@@ -36,6 +36,10 @@ JSON based REST Web services and also Web service clients via JSON and Curl, how
write a custom login, and how to use them in a token based Web service that also helps
prevent cross site scripting (XSS).
</p>
+<p>More docs concerning Axis2 and JSON can be found in the <a href="
+json_support_gson.html">Pure JSON Support</a> and <a href="
+json_gson_user_guide.html">JSON User Guide</a>
+</p>
<a name="Introduction"></a>
<h2>Introduction</h2>
@@ -48,7 +52,7 @@ you choose the latter, then the <a href="installationguide.html">Installation
Guide</a> will instruct you on how to build Axis2 Standard Binary
Distribution using the source.</p>
-<p>The source code for this guide provides a pom.xml for an entire demo application built by maven.
+<p>The source code for this guide provides a pom.xml for an entire demo WAR application built by maven.
</p>
<p>Please note that Axis2 is an open-source effort. If you feel the code
@@ -91,6 +95,8 @@ standards.
</p>
<p>
https://datatracker.ietf.org/doc/html/rfc7519
+</p>
+<p>
https://datatracker.ietf.org/doc/html/rfc7516
</p>
<p>
@@ -126,7 +132,7 @@ reflected XSS attack.
<p>
Concerning Spring Security and Spring Boot, the Axis2Application class that
extends SpringBootServletInitializer as typically done utilizes
-List<SecurityFilterChain> as a binary choice; A login url will match, otherwise invoke
+List of SecurityFilterChain as a binary choice; A login url will match, otherwise invoke
JWTAuthenticationFilter. All URL's to other services besides the login, will proceed
after JWTAuthenticationFilter verifies the token.
</p>
@@ -155,7 +161,7 @@ services.xml file:
<pre>
<message name="requestMessage">
<excludeOperations>
- <operation>setMyVar<</operation>
+ <operation>setMyVar</operation>
</excludeOperations>
</pre>
<p>
@@ -209,7 +215,7 @@ Invoking the client for a Test Service that validates a sample token can be done
follows:
</p>
<p>
-curl -v -H "Authorization: Bearer I2SpAHWrU5gYbGNwNNKg" -H "Content-Type: application/json" -X POST --data @/root/test.dat http://localhost:8080/axis2-json-api/services/testws'
+ curl -v -H "Authorization: Bearer I2SpAHWrU5gYbGNwNNKg" -H "Content-Type: application/json" -X POST --data @/home/myuser/test.dat http://localhost:8080/axis2-json-api/services/testws'
</p>
<p>
Where the contents of /home/myuser/test.dat are below. arg0 is the var name
@@ -219,7 +225,7 @@ and is used by Axis2 as part of the reflection based code:
{"doTestws":[{"arg0":{"messagein":hello}}]}
</p>
<p>
-Response, HTML encoded to prevent XSS. For the escaped results see ./src/site/xdoc/docs/json-springboot-userguide.xml.
+Response, HTML encoded to prevent XSS. For the results with encoding see ./src/site/xdoc/docs/json-springboot-userguide.xml.
</p>
<p>
{"response":{"messageout":"<script xmlns=\"http://www.w3.org/1999/xhtml\">alert('Hello');</script> \">","status":"OK"}}
diff --git a/src/site/xdoc/docs/json_support.xml b/src/site/xdoc/docs/json_support.xml
index 0a2e297..a21fc39 100644
--- a/src/site/xdoc/docs/json_support.xml
+++ b/src/site/xdoc/docs/json_support.xml
@@ -26,6 +26,14 @@
<body>
<h1>JSON Support in Axis2</h1>
<section name="Introduction">
+ <p>Update: This documentation represents early forms of JSON
+ conventions, Badgerfish and Mapped. GSON support was added a few
+ years later. Moshi support is now included as an alternative to
+ GSON. For users of JSON seeking modern features, see <a href=
+ "json_support_gson.html">JSON Support Guide.</a>. For users of
+ JSON and Spring Boot, see the sample application in the <a href=
+ "json-springboot-userguide.html">JSON and Spring Boot User's Guide.</a>
+ </p>
<p>This document explains the JSON support implementation in Axis2.
It includes an introduction to JSON, an outline as to why JSON
support is useful to Axis2 and how it should be used. This document
diff --git a/src/site/xdoc/docs/json_support_gson.xml b/src/site/xdoc/docs/json_support_gson.xml
index 4982f6a..1962da2 100644
--- a/src/site/xdoc/docs/json_support_gson.xml
+++ b/src/site/xdoc/docs/json_support_gson.xml
@@ -26,6 +26,14 @@
<body>
<h1>New JSON support in Apache Axis2</h1>
+ <p>Update: Moshi support is now included as an alternative to GSON,
+ though both are supported and will continue to be. Both libs are very
+ similar in features though Moshi is widely considered to have better
+ performance. GSON development has largely ceased. Switching between
+ Moshi and GSON is a matter of editing the axis2.xml file.
+ For users of JSON and Spring Boot, see the sample application in
+ the <a href="json-springboot-userguide.html">JSON and Spring Boot User's Guide.</a>
+ </p>
<p>This documentation explains how the existing JSON support in Apache Axis2 have been improved with two new
methods named, Native approach and XML stream API based approach. Here it initially explains about the
drawbacks of the old JSON support, how to overcome those drawbacks with the new approaches and, how to use
@@ -188,4 +196,4 @@
</body>
-</document>
\ No newline at end of file
+</document>
diff --git a/src/site/xdoc/docs/toc.xml b/src/site/xdoc/docs/toc.xml
index 73d0b80..ba49ac3 100644
--- a/src/site/xdoc/docs/toc.xml
+++ b/src/site/xdoc/docs/toc.xml
@@ -115,6 +115,7 @@ Support</a></li>
<li><a href="json_support_gson.html#native_approach">Native Approach</a></li>
<li><a href="json_support_gson.html#xml_stream_api_base_approach">XML Stream API Base Approach</a></li>
<li><a href="json_gson_user_guide.html">User Guide</a></li>
+ <li><a href="json-springboot-userguide.html">JSON and REST with Spring Boot User's Guide</a></li>
</ul>
</li>
</ul>