This is an automated email from the ASF dual-hosted git repository.
kfujino pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/9.0.x by this push:
new 598eddc Add docs for JsonErrorReportValve.
598eddc is described below
commit 598eddc99910049231336fd09e85b3df4c4d9ca7
Author: KeiichiFujino <kfuj...@apache.org>
AuthorDate: Sun Oct 18 22:02:43 2020 +0900
Add docs for JsonErrorReportValve.
---
webapps/docs/changelog.xml | 5 +++--
webapps/docs/config/valve.xml | 31 +++++++++++++++++++++++++++++++
2 files changed, 34 insertions(+), 2 deletions(-)
diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index eff1dd0..1cbbb49 100644
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -64,8 +64,9 @@
connection scenario. (remm)
</fix>
<add>
- Add extended <code>ErrorReportValve</code> that returns response as
- JSON instead of HTML. (kfujino)
+ Add <code>JsonErrorReportValve</code> that extends the
+ <code>ErrorReportValve</code> that returns response as JSON instead of
+ HTML. (kfujino)
</add>
</changelog>
</subsection>
diff --git a/webapps/docs/config/valve.xml b/webapps/docs/config/valve.xml
index 0a6b0c3..7222018 100644
--- a/webapps/docs/config/valve.xml
+++ b/webapps/docs/config/valve.xml
@@ -2040,6 +2040,37 @@
</section>
+<section name="Json Error Report Valve">
+
+ <subsection name="Introduction">
+
+ <p>The <strong>Json Error Report Valve</strong> is a simple error handler
+ for HTTP status codes that will return Json error messages.</p>
+
+ <p>By specifying this class in <code>errorReportValveClass</code> attribute
+ in <code>HOST</code>, it will be used instead of
+ <code>ErrorReportValve</code> and will return JSON response instead of
HTML.
+ </p>
+
+ </subsection>
+
+ <subsection name="Attributes">
+
+ <p>The <strong>Json Error Report Valve</strong> supports the following
+ configuration attributes:</p>
+
+ <attributes>
+
+ <attribute name="className" required="true">
+ <p>Java class name of the implementation to use. This MUST be set to
+ <strong>org.apache.catalina.valves.JsonErrorReportValve</strong>.</p>
+ </attribute>
+
+ </attributes>
+
+ </subsection>
+
+</section>
<section name="Crawler Session Manager Valve">
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
