Skip to content

Commit

Permalink
Release 5u24 (#579)
Browse files Browse the repository at this point in the history
* リリースノート追加

* リリースノート差し替え

* UniversalDaoのページング処理で、件数取得SQLの差し替えかたを追記しました。 (#539)

* 件数取得SQLについての記載追加

* ビルドエラー修正

* レビュー指摘修正

* レビュー指摘対応

* レビュー指摘対応

* レビュー指摘対応

* レビュー指摘対応

* レビュー指摘対応

* レビュー指摘対応

* レビュー指摘対応

* レビュー指摘対応

* レビュー指摘対応

* レビュー指摘対応

* レビュー指摘修正

* 件数取得SQLの差し替えかたを英訳しました。 (#540)

* ドキュメントの英訳

* レビュー指摘修正

* メッセージング基盤テストシミュレータの実行モジュールの作成手順修正 (#541)

* メッセージング基盤テストシミュレータの実行モジュールの作成手順修正(#555)

* 画像内の文言修正(WebSphere MQ→IBM MQ)(#555)

* メッセージング基盤テストシミュレータサンプルのJavaバージョンについての記載を追加(#555)

* IBM MQの利用バージョンを追加(#555)

* IBM MQの利用バージョンを追加(#555)

* メッセージング基盤テストシミュレータサンプル(英語版)修正(#555) (#550)

* メッセージング基盤テストシミュレータサンプル(英語版)修正(#555)

* メッセージング基盤テストシミュレータサンプル(英語版)の画像修正(#555)

* メッセージング基盤テストシミュレータサンプル(英語版)の画像修正(#555)

* Javadocのリンク先がLATEST固定になっていたため修正 (#551)

* WebSphere MQ→IBM MQに文言修正(#552) (#549)

* WebSphere MQ→IBM MQに文言修正(#552)

* 変更しWebSphere MQ→IBM MQの文言変更に伴う表現の修正(#552)

* WebSphere MQ→IBM MQに文言修正(英語版)(#552)

* Java21で使用する場合のセットアップ方法をドキュメントに追加(日本語のみ) (#555)

* Java21で使用する場合のセットアップ方法をドキュメントに追加(日本語のみ)

* Java21で使用する場合のセットアップ方法をドキュメントに追加(日本語のみ)

* Java21で使用する場合のセットアップ方法の修正

* Java21で使用する場合のセットアップ方法の修正

* Java21で使用する場合のセットアップ方法の追加(英語) (#556)

* Java21で使用する場合のセットアップ方法をドキュメントに追加(日本語のみ)

* Java21で使用する場合のセットアップ方法をドキュメントに追加(日本語のみ)

* Java21で使用する場合のセットアップ方法の修正

* Java21で使用する場合のセットアップ方法の修正

* Java21で使用する場合のセットアップ方法の追加(英語)~

* Java17で使用する場合のセットアップ方法で誤って削除したバージョンの修正(英語)

* Java21で使用する場合のセットアップ方法の追加の修正

* Java21で使用する場合のセットアップ方法からJacocoのバージョンアップを削除(nablarch-single-module-archetypeで修正したため) (#559)

* HttpRequest#getParam、HttpRequest#getParamMapの利用箇所を修正 (#561)

* RESTfulウェブサービスのサンプルを修正

* パスパラメータの定義の実装サンプルを修正

* リクエストパラメータの値を検証の実装サンプルを修正

* RESTfulウェブサービスのサンプルを修正

* RESTfulウェブサービスのサンプルを修正

* ディスパッチされるメソッドが直前にあるコード例と一致してないため修正

* HttpRequestの使用箇所をJaxRsHttpRequestに変更

* restでのHttpRequestの使用に関して注釈を追加

* HttpRequest#getParam、HttpRequest#getParamMapの利用箇所を修正 (#563)

* HttpRequest#getParam、HttpRequest#getParamMapの利用箇所を修正

* HttpRequest#getParam、HttpRequest#getParamMapの利用箇所を修正

* HttpRequest#getParam、HttpRequest#getParamMapの利用箇所を修正

* ディスパッチされるメソッドが直前にあるコード例と一致してないため修正

* doc: タイポ修正 (#565)

* 表記ゆれの修正 (#568)

* MavenプラグインのJVMオプション指定について注意喚起したほうがよいとの指摘に対応 (#569)

* Nab 571/link check (#571)

* linkcheckでBrokenのものに対応

* linkcheckでRedirectのものに対応

* javadocのURLをhttpからhttpsに修正

* Nab 571/link check (#572)

* linkcheckでBrokenのものに対応

* linkcheckでRedirectのものに対応

* javadocのURLをhttpからhttpsに修正

* linkcheckでBroken、Redirectに対応(英語)

* リンク先の英語版ページに変更

---------

Co-authored-by: oguchi-shiori03 <[email protected]>

* テスト環境の更新 (#576)

* テスト環境の更新

* テスト環境の更新

* リリース情報の追加 (#577)

* リリース作業:Nablarchバージョンの更新

* 不正なタグを修正

* releasenote差し替え

---------

Co-authored-by: Takayuki Uchida <[email protected]>
Co-authored-by: kumano_goro <[email protected]>
Co-authored-by: hijiri <[email protected]>
Co-authored-by: kankichi00 <[email protected]>
Co-authored-by: Takayuki Uchida <[email protected]>
Co-authored-by: tishijiri <[email protected]>
  • Loading branch information
7 people authored Mar 15, 2024
1 parent 8ea3f3d commit 88eb03a
Show file tree
Hide file tree
Showing 95 changed files with 506 additions and 198 deletions.
2 changes: 1 addition & 1 deletion en/about_nablarch/concept.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ However, for responding to a rapidly changing business environment, it is necess
For achieving this, it is important to reuse proven parts.
Nablarch is able to meet these needs by providing content that can be reused in a "ready-to-use" state, such as frameworks, adapters for adapting to frequently used middleware [1]_ and environments where inexperienced people can start developing immediately.

.. [1] Apache Log4j, WebSphere MQ, etc.
.. [1] Apache Log4j, IBM MQ, etc.
8 changes: 4 additions & 4 deletions en/application_framework/adaptors/jaxrs_adaptor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Provides the following adapter to use in :ref:`RESTful web service <restful_web_


* Adapter to convert JSON using `Jackson (external site) <https://github.com/FasterXML/jackson>`_
* Adapter for using :ref:`RESTful web service <restful_web_service>` with `Jersey (external site) <https://jersey.java.net/>`_
* Adapter for using :ref:`RESTful web service <restful_web_service>` with `RESTEasy (external site) <http://resteasy.jboss.org/>`_
* Adapter for using :ref:`RESTful web service <restful_web_service>` with `Jersey (external site) <https://eclipse-ee4j.github.io/jersey/>`_
* Adapter for using :ref:`RESTful web service <restful_web_service>` with `RESTEasy (external site) <https://resteasy.dev/>`_

Module list
--------------------------------------------------
Expand Down Expand Up @@ -53,7 +53,7 @@ Module list

Using RESTful web services under Jersey environment
-------------------------------------------------------
If the implementation of `JAX-RS(external site) <https://jcp.org/en/jsr/detail?id=339>`_ bundled with the web application server is `Jersey(external site) <https://jersey.java.net/>`_ , use the adapter for Jersey.
If the implementation of `JAX-RS(external site) <https://jcp.org/en/jsr/detail?id=339>`_ bundled with the web application server is `Jersey(external site) <https://eclipse-ee4j.github.io/jersey/>`_ , use the adapter for Jersey.

An application of Jersey adapter is shown below.

Expand Down Expand Up @@ -87,7 +87,7 @@ For :java:extdoc:`JaxRsMethodBinderFactory#setHandlerList <nablarch.fw.jaxrs.Jax

Using RESTful web services under RESTEasy environment
--------------------------------------------------------
If the implementation of `JAX-RS (external site) <https://jcp.org/en/jsr/detail?id=339>`_ bundled with the web application server is `RESTEasy (external site) <http://resteasy.jboss.org/>`_ , use the adapter for RESTEasy.
If the implementation of `JAX-RS (external site) <https://jcp.org/en/jsr/detail?id=339>`_ bundled with the web application server is `RESTEasy (external site) <https://resteasy.dev/>`_ , use the adapter for RESTEasy.

An application of RESTEasy adapter is shown below.

Expand Down
2 changes: 1 addition & 1 deletion en/application_framework/adaptors/log_adaptor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ When an adapter is used, all log output processing using :ref:`the log output fu

.. important::

The log4j adapter that was provided up to Nablarch5u15 uses `log4j1.2 (external site) <http://logging.apache.org/log4j/1.2/>`_. log4j 1.2 is EOL.
The log4j adapter that was provided up to Nablarch5u15 uses `log4j1.2 (external site) <https://logging.apache.org/log4j/1.x/>`_. log4j 1.2 is EOL.
Therefore, the log4j adapter has been deprecated as no fix for the `vulnerability <https://jvndb.jvn.jp/ja/contents/2019/JVNDB-2019-013606.html>`_ has been published. Use slf4j or JBoss Logging.

.. tip::
Expand Down
8 changes: 4 additions & 4 deletions en/application_framework/adaptors/micrometer_adaptor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -655,11 +655,11 @@ Working with Azure
How to send metrics to Azure with Micrometer
Azure provides the library using the Java agent (**Java 3.0 agent**) for sending metrics from Java applications to Azure.

* `Java codeless application monitoring Azure Monitor Application Insights(external site) <https://docs.microsoft.com/en-us/azure/azure-monitor/app/java-in-process-agent>`_
* `Java codeless application monitoring Azure Monitor Application Insights(external site) <https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=java>`_

The Java 3.0 agent automatically collects metrics output to Micrometer's `Global Registry(external site) <https://micrometer.io/docs/concepts#_global_registry>`_, and sends to Azure.

* `Send custom telemetry from your application(external site) <https://docs.microsoft.com/en-us/azure/azure-monitor/app/java-in-process-agent#send-custom-telemetry-from-your-application>`_
* `Send custom telemetry from your application(external site) <https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=java>`_

.. important::
The Java 3.0 agent loads a large number of jar files during the initialization process.
Expand All @@ -678,7 +678,7 @@ How to configure Micrometer adaptor
* Add the Java 3.0 agent to your application's JVM args
* Define a ``MeterRegistry`` component using the Global Registry

See the `Azure documentation(external site) <https://docs.microsoft.com/en-us/azure/azure-monitor/app/java-in-process-agent#quickstart>`_ for how to set JVM args.
See the `Azure documentation(external site) <https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=java#modify-your-application>`_ for how to set JVM args.

This adaptor provides :java:extdoc:`GlobalMeterRegistryFactory <nablarch.integration.micrometer.GlobalMeterRegistryFactory>` for factory of Global Registry component.
The following is an example of a component definition for this factory class.
Expand All @@ -701,7 +701,7 @@ Configuration
The metrics are sent by the Java 3.0 agent provided by Azure.
Therefore, you must use configuration options provided by the Java 3.0 agent.

For more information, see `Configuration Options(external site) <https://docs.microsoft.com/en-us/azure/azure-monitor/app/java-standalone-config>`_.
For more information, see `Configuration Options(external site) <https://learn.microsoft.com/en-us/azure/azure-monitor/app/java-standalone-config>`_.

.. important::
The configuration file for this adapter, ``micrometer.properties``, is not used.
Expand Down
26 changes: 13 additions & 13 deletions en/application_framework/adaptors/router_adaptor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ The following is an example implementation that defines the mapping using the ``
@POST
@Produces(MediaType.APPLICATION_JSON)
public int register(HttpRequest request) {
public int register(JaxRsHttpRequest request) {
// Omitted
}
}
Expand All @@ -224,7 +224,7 @@ In the above example implementation, the HTTP request will be dispatched as foll
Path HTTP method Method of dispatching target
============ ============== =============================
``/sample`` ``GET`` ``SampleAction#findAll()``
``/sample`` ``POST`` ``SampleAction#register(HttpRequest)``
``/sample`` ``POST`` ``SampleAction#register(JaxRsHttpRequest)``
============ ============== =============================

.. tip::
Expand Down Expand Up @@ -265,8 +265,8 @@ In this case, the dispatch of the HTTP request would be as follows.
================ ============== =============================
Path HTTP method Method of dispatching target
================ ============== =============================
``/sample/foo`` ``GET`` ``SampleAction#findAll()``
``/sample/bar`` ``GET`` ``SampleAction#register(HttpRequest)``
``/sample/foo`` ``GET`` ``TestAction#foo()``
``/sample/bar`` ``GET`` ``TestAction#bar()``
================ ============== =============================

Definition of path parameters
Expand All @@ -281,16 +281,16 @@ Can also include parameters in the path, as follows
@GET
@Path("/foo/{param}")
@Produces(MediaType.APPLICATION_JSON)
public Person foo(HttpRequest request) {
String param = request.getParam("param")[0];
public Person foo(JaxRsHttpRequest request) {
String param = request.getPathParam("param");
// Omitted
}
@GET
@Path("/bar/{id : \\d+}")
@Produces(MediaType.APPLICATION_JSON)
public Person bar(HttpRequest request) {
int id = Integer.parseInt(request.getParam("id")[0]);
public Person bar(JaxRsHttpRequest request) {
int id = Integer.parseInt(request.getPathParam("id");
// Omitted
}
}
Expand All @@ -299,7 +299,7 @@ Can also include parameters in the path, as follows
| This is because this feature (routing definition with ``Path`` annotations) follows the JAX-RS specification.
| By describing a part of the path as ``{parameter name}``, can define that part of the path as a parameter.
| Can get the value of the path parameter by passing the parameter name defined here to :java:extdoc:`HttpRequest#getParam(String) <nablarch.fw.web.HttpRequest.getParam(java.lang.String)>` .
| Can get the value of the path parameter by passing the parameter name defined here to :java:extdoc:`JaxRsHttpRequest#getPathParam(String) <nablarch.fw.jaxrs.JaxRsHttpRequest.getPathParam(java.lang.String)>` .
| In addition, can define the format of the path parameter in a regular expression by describing it as ``{parameter name: regular expression}``.
| In the example implementation above, set the regular expression to ``\\d+``, so the method will be dispatched only if the path value is a number.
Expand All @@ -309,10 +309,10 @@ An example of HTTP request dispatch would be as follows.
===================== ============== =============================
Path HTTP method Method of dispatching target
===================== ============== =============================
``/sample/foo/hello`` ``GET`` ``SampleAction#foo(HttpRequest)``
``/sample/foo/world`` ``GET`` ``SampleAction#foo(HttpRequest)``
``/sample/bar/123`` ``GET`` ``SampleAction#bar(HttpRequest)``
``/sample/bar/987`` ``GET`` ``SampleAction#bar(HttpRequest)``
``/sample/foo/hello`` ``GET`` ``TestAction#foo(JaxRsHttpRequest)``
``/sample/foo/world`` ``GET`` ``TestAction#foo(JaxRsHttpRequest)``
``/sample/bar/123`` ``GET`` ``TestAction#bar(JaxRsHttpRequest)``
``/sample/bar/987`` ``GET`` ``TestAction#bar(JaxRsHttpRequest)``
===================== ============== =============================
See the list of routing definitions
Expand Down
15 changes: 7 additions & 8 deletions en/application_framework/adaptors/webspheremq_adaptor.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
.. _webspheremq_adaptor:

IBM WebSphere MQ Adapter
IBM MQ Adapter
==================================================

.. contents:: Table of contents
:depth: 3
:local:

Provides an adapter to use `IBM WebSphere MQ (external site) <https://www.ibm.com/support/knowledgecenter/SSFKSJ_7.5.0/com.ibm.mq.pro.doc/q001010_.htm>`_ with :ref:`the MOM messaging function of Nablarch <mom_messaging>` .
Provides an adapter to use `IBM MQ (external site) <https://www.ibm.com/docs/en/ibm-mq/9.3?topic=mq-about>`_ with :ref:`the MOM messaging function of Nablarch <mom_messaging>` .

Refer to the official Website and manuals of IBM Corporation for the specifications and construction procedures of WebSphere MQ.
Refer to the official Website and manuals of IBM Corporation for the specifications and construction procedures of IBM MQ.

Module list
--------------------------------------------------
Expand All @@ -22,8 +22,7 @@ Module list
.. important::

For WebSphere MQ jars, refer to the product manual and add those that are required to the class path.
The library included with WebSphere MQ v7.5 is used for testing.
The library included with IBM MQ v9.3 is used for testing.
When changing the version, test in the project to confirm that there are no problems.

Configuration for using this adapter
Expand All @@ -37,7 +36,7 @@ A configuration example is shown below.

.. code-block:: xml
<!-- Provider implementation for IBM WebSphere MQ Adapter- -->
<!-- Provider implementation for IBM MQ Adapter- -->
<component name="wmqMessagingProvider"
class="nablarch.integration.messaging.wmq.provider.WmqMessagingProvider">
<!-- See Javadoc for configuration value-->
Expand All @@ -54,7 +53,7 @@ A configuration example is shown below.
Use distributed transaction
--------------------------------------------------
This adapter includes a function to realize distributed transactions using IBM WebSphere MQ as the transaction manager.
This adapter includes a function to realize distributed transactions using IBM MQ as the transaction manager.

This function is used to prevent omission and duplicate capture when sending and receiving messages to and from external systems.

Expand Down Expand Up @@ -120,7 +119,7 @@ A configuration example is shown below.
.. important::

For using distributed transactions, an XA resource manager has to be configured for WebSphere MQ and authority to the database has to be granted.
For using distributed transactions, an XA resource manager has to be configured for IBM MQ and authority to the database has to be granted.
Refer to the manual of the product to be used for the detailed configuration method and necessary authority.

.. |br| raw:: html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ The JDBC driver can be downloaded from the following site on the Internet.

* - IBM DB2 JDBC Driver Versions |br|
and Downloads - Japan
- http://www-01.ibm.com/support/docview.wss?uid=swg21363866 (External site)
- https://www.ibm.com/support/pages/db2-jdbc-driver-versions-and-downloads (External site)

An example of the command to register the downloaded JDBC driver to the local Maven repository is shown below.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Initial Setup Procedure
setup_blankProject/setup_NablarchBatch_Dbless
setup_blankProject/setup_Java11
setup_blankProject/setup_Java17
setup_blankProject/setup_Java21

.. toctree::
:maxdepth: 1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ When using blank projects in Java 17, perform the following procedure before com
* Add --add-opens options (only for JSR352-compliant batch project)
* Change of Java Version

.. _setup_blank_project_for_Java17_add_dependencies:

Add dependent module
-------------------------------------------------------------

Expand Down Expand Up @@ -56,6 +58,7 @@ There are two differences from the :ref:`Add dependent module in Java 11 <setup_
</dependency>
</dependencies>
.. _setup_blank_project_for_Java17_gsp_dba_maven_plugin:

Configure gsp-dba-maven-plugin to work with Java 17
----------------------------------------------------------
Expand Down Expand Up @@ -91,6 +94,7 @@ Therefore, make changes to 2 files as given below.
<!-- Change the location of HttpServerFactoryJetty6 as follows -->
<component name="httpServerFactory" class="nablarch.fw.web.httpserver.HttpServerFactoryJetty9"/>
.. _setup_blank_project_for_Java17_add_JVMoption:

Add --add-opens options (only for JSR352-compliant batch project)
------------------------------------------------------------------------------------------------------------------
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
.. _setup_blank_project_for_Java21:

----------------------------------------------------------
How to Setup When Using With Java21
----------------------------------------------------------

When using blank projects in Java 21, perform the following procedure before communication confirmation of each blank project.

* Add dependent module
* Configure gsp-dba-maven-plugin to work with Java 21
* Change of Jetty module used in automatic test (only for web projects or RESTful web service projects)
* Add --add-opens options (only for JSR352-compliant batch project)
* Change the standard encoding(if you want the standard encoding to be the same execution environment as Java 17 or earlier)
* Change of Java Version

Add dependent module
-------------------------------------------------------------

The above steps are the same as when using Java 17, so refer to :ref:`setup_blank_project_for_Java17 <setup_blank_project_for_Java17_add_dependencies>`


Configure gsp-dba-maven-plugin to work with Java 17
----------------------------------------------------------

The above steps are the same as when using Java 17, so refer to :ref:`setup_blank_project_for_Java17 <setup_blank_project_for_Java17_gsp_dba_maven_plugin>`


Change of Jetty module used in automatic test (only for web projects or RESTful web service projects)
------------------------------------------------------------------------------------------------------------------

The above steps are the same as when using Java 17, so refer to :ref:`setup_blank_project_for_Java17 <setup_java17_jetty9>`


Add --add-opens options (only for JSR352-compliant batch project)
------------------------------------------------------------------------------------------------------------------

The above steps are the same as when using Java 17, so refer to :ref:`setup_blank_project_for_Java17 <setup_blank_project_for_Java17_add_JVMoption>`


Change the standard encoding(If you want to make the standard encoding dependent on the execution environment as before Java 17)
----------------------------------------------------------------------------------------------------------------------------------------------------------

Since Java 18, the standard encoding is UTF-8, making it environment independent. If you want to make the standard encoding dependent on the execution environment as before Java 17, specify the system property as a runtime option for the Java command as shown below.

* ``-Dfile.encoding=COMPAT``

.. tip::
When running from Maven, the environment variable `MAVEN_OPTS (external site) <https://maven.apache.org/configure.html#maven_opts-environment-variable>`_ can be used to set the JVM options. However, ``Picked up MAVEN_OPTS: -Dfile.encoding=COMPAT`` is displayed in the log.
Please note that the settings for JVM options may differ depending on Maven plugin.(For example, in maven-surefire-plugin that runs the test, it needs to be specified in ``argLine`` in plugin settings in pom.xml)

.. important::
The ``-Dfile.encoding=COMPAT`` option is not valid until Java 17, so be careful not to apply this JVM option to previous execution environments.

Change of Java Version
------------------------------

In a blank project, Java 8 is set as the Java version
that the source and class files conform to, so change the file as below.

* pom.xml

.. code-block:: xml
<!-- Change Java version as follows -->
<java.version>21</java.version>
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,6 @@ By editing it like this, X-Ray SDK for Java JDBC interceptor will be added to th
.. _Tracing calls to downstream HTTP web services with the X-Ray SDK for Java(external site): https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-httpclients.html
.. _Apache HttpComponents(external site): https://hc.apache.org/
.. _Jersey(external site): https://eclipse-ee4j.github.io/jersey/
.. _Client Transport Connectors(external site): https://eclipse-ee4j.github.io/jersey.github.io/documentation/latest/client.html#d0e4974
.. _Client Transport Connectors(external site): https://eclipse-ee4j.github.io/jersey.github.io/documentation/latest/client.html#d0e5043
.. _Tracing SQL queries with the X-Ray SDK for Java(external site): https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-sqlclients.html
.. _Intercept JDBC-Based SQL Queries(external site): https://github.com/aws/aws-xray-sdk-java#intercept-jdbc-based-sql-queries
Loading

0 comments on commit 88eb03a

Please sign in to comment.