Skip to content

Commit

Permalink
Merge branch 'release-6' into v6-master
Browse files Browse the repository at this point in the history
  • Loading branch information
tisuchida committed Dec 22, 2023
2 parents 8ea3f3d + bb07403 commit 806085b
Show file tree
Hide file tree
Showing 627 changed files with 3,235 additions and 46,939 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] Redis, SLF4J, etc.
33 changes: 15 additions & 18 deletions en/about_nablarch/versionup_policy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,26 +26,26 @@ A version consists of a combination of multiple modules.
:widths: 40 20 20 20

* - Module Example
- Nablarch5
- Nablarch5u1
- Nablarch5u2
- Nablarch6
- Nablarch6u1
- Nablarch6u2

* - nablarch-fw
- 1.0.0
- 1.0.1
- 1.0.2
- 2.0.0
- 2.0.1
- 2.0.2

* - nablarch-common-dao
- 1.0.0
- 1.1.0
- 1.1.0
- 2.0.0
- 2.1.0
- 2.1.0

* - nablarch-fw-jaxrs
- -
- -
- 1.0.0
- 2.0.0

In the above table, 5/5u1/5u2 are the release versions of Nablarch.
In the above table, 6/6u1/6u2 are the release versions of Nablarch.

.. _`versionup_policy-versionup_type`:

Expand All @@ -68,10 +68,8 @@ There are three types of Nablarch version upgrades.
|br|
e.g., Renewal of the execution control platform
- Application framework |br|
Extension component |br|
Development tools |br|
Development standard |br|
Implementation Examples
Development standard
- 1 year ~

* - Revision up
Expand Down Expand Up @@ -99,16 +97,16 @@ The version numbering system is as follows.

(product version number)u(update number)

e.g., 5(initial release of product version 5), 5u1(Update release 1 of product version 5)
e.g., 6(initial release of product version 6), 6u1(Update release 1 of product version 6)

Product Version Number
Incremented at minor upgrade. |br|
e.g., Nablarch 5u6 → Nablarch 6 |br|
e.g., Nablarch 6u6 → Nablarch 7 |br|
The starting number is 5.

Update Number
Incremented at revision up or bug fix. |br|
e.g., Nablarch 5u6 → Nablarch 5u7 |br|
e.g., Nablarch 6u6 → Nablarch 6u7 |br|
The starting number is 0. However, if the number is 0, no update number will be given.

.. _`versionup_policy-backward_compatibility_policy`:
Expand Down Expand Up @@ -185,4 +183,3 @@ If any of the following applies, we may upgrade the version so that backward com
* When a problem occurs due to a version upgrade of JDK, which is the environment in which the framework operates, and it cannot be fixed while maintaining backward compatibility.

If we make changes that don't maintain backward compatibility, we'll explain what they're doing and how to deal with them in the "Impact on the system and how to deal with it(システムへの影響の可能性の内容と対処)" section of the `Release Notes(Japanese Page) <https://nablarch.github.io/docs/LATEST/doc/releases/index.html>`_.

53 changes: 8 additions & 45 deletions en/application_framework/adaptors/doma_adaptor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,14 +108,14 @@ An implementation example is shown below.
DomaDaoRepository.get(ProjectDao.class).insert(project);
Using in a JSR352-compliant batch application
Using in a Jakarta Batch-compliant batch application
----------------------------------------------------------------
The following listeners are provided in this adapter to use Doma in JSR352-compliant batch applications.
The following listeners are provided in this adapter to use Doma in Jakarta Batch-compliant batch applications.
* :java:extdoc:`DomaTransactionStepListener<nablarch.integration.doma.batch.ee.listener.DomaTransactionStepListener>`
* :java:extdoc:`DomaTransactionItemWriteListener<nablarch.integration.doma.batch.ee.listener.DomaTransactionItemWriteListener>`
By defining these listeners in the listener list, it is possible to access the database using Doma even in JSR352-compliant batch applications.
By defining these listeners in the listener list, it is possible to access the database using Doma even in Jakarta Batch-compliant batch applications.
The configuration example shown below.
Expand Down Expand Up @@ -147,9 +147,9 @@ The configuration example shown below.
int[] batchInsert(List<Bonus> bonuses);
Deferred loading in jsr352-compliant batch applications
---------------------------------------------------------
When loading a large amount of data with JSR352-compliant batch applications, you may want to use deferred loading.
Deferred loading in Jakarta Batch-compliant batch applications
---------------------------------------------------------------
When loading a large amount of data with Jakarta Batch-compliant batch applications, you may want to use deferred loading.
In that case, specify :java:extdoc:`DomaTransactionNotSupportedConfig<nablarch.integration.doma.DomaTransactionNotSupportedConfig>` in the config attribute of Dao annotation.
Expand Down Expand Up @@ -210,43 +210,6 @@ ItemReader class
}
}
Use in ETL
--------------------------------------------------
When using ETL, using Doma in steps added to the project may be required.
In such a case, a listener list in which a job name and step name are specified is defined.
The configuration example shown below.
Job definition file
.. code-block:: xml
<job id="sampleJob" xmlns="http://xmlns.jcp.org/xml/ns/javaee" version="1.0">
<step id="sampleStep">
<listeners>
<listener ref="nablarchStepListenerExecutor" />
<listener ref="nablarchItemWriteListenerExecutor" />
</listeners>
<chunk>
<reader ref="sampleItemReader" />
<writer ref="sampleItemWriter" />
</chunk>
</step>
</job>
Component configuration file
.. code-block:: xml
<list name="sampleJob.sampleStep.stepListeners">
<!-- Other listeners are omitted -->
<component
class="nablarch.integration.doma.batch.ee.listener.DomaTransactionStepListener" />
</list>
<list name="sampleJob.sampleStep.itemWriteListeners">
<!-- Other listeners are omitted -->
<component
class="nablarch.integration.doma.batch.ee.listener.DomaTransactionItemWriteListener" />
</list>
Accessing multiple databases
--------------------------------------------------
Expand Down Expand Up @@ -315,7 +278,7 @@ Usage procedure
* Define :java:extdoc:`ConnectionFactoryFromDomaConnection <nablarch.integration.doma.ConnectionFactoryFromDomaConnection>` in the component configuration file.
The component name should be ``connectionFactoryFromDoma``.
* Configure ConnectionFactoryFromDomaConnection in the listener that controls the transaction of JSR352 Doma.
* Configure ConnectionFactoryFromDomaConnection in the listener that controls the transaction of Doma for Jakarta Batch.
.. code-block:: xml
Expand All @@ -328,7 +291,7 @@ Usage procedure
</component>
<!--
When using in JSR352-compliant batch application configure connectionFactoryFromDoma defined
When using in Jakarta Batch-compliant batch application configure connectionFactoryFromDoma defined
above in the listener that controls the transaction of Doma.
-->
<component class="nablarch.integration.doma.batch.ee.listener.DomaTransactionItemWriteListener">
Expand Down
16 changes: 12 additions & 4 deletions en/application_framework/adaptors/jaxrs_adaptor.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
.. _jaxrs_adaptor:

JAX-RS Adapter
============================
Jakarta RESTful Web Services Adapter
===========================================

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

.. tip::
This function was called "JAX-RS Adapter" until Nablarch5.
However, as Java EE was transferred to the Eclipse Foundation and the specification name changed, the name was changed to "Jakarta RESTful Web Services Adapter".

Only the name has changed, there is no functional difference.

For other features renamed in Nablarch 6, see :ref:`renamed_features_in_nablarch_6`.

Provides the following adapter to use in :ref:`RESTful web service <restful_web_service>`.


Expand Down Expand Up @@ -53,7 +61,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 `Jakarta RESTful Web Services(external site) <https://jakarta.ee/specifications/restful-ws/>`_ bundled with the web application server is `Jersey(external site) <https://jersey.java.net/>`_ , use the adapter for Jersey.

An application of Jersey adapter is shown below.

Expand Down Expand Up @@ -87,7 +95,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 `Jakarta RESTful Web Services (external site) <https://jakarta.ee/specifications/restful-ws/>`_ bundled with the web application server is `RESTEasy (external site) <http://resteasy.jboss.org/>`_ , use the adapter for RESTEasy.

An application of RESTEasy adapter is shown below.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Module list
.. tip::

Tests are conducted using Thymeleaf version 3.0.9 RELEASE.
Tests are conducted using Thymeleaf version 3.1.1.RELEASE.
When changing the version, test in the project to confirm that there are no problems.

Configuration for using the E-mail Thymeleaf adapter
Expand Down
28 changes: 14 additions & 14 deletions en/application_framework/adaptors/router_adaptor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,9 @@ Example of mapping URL to business action

.. _router_adaptor_path_annotation:

Mapping in JAX-RS Path Annotation
--------------------------------------------------------
Since version 1.2.0 of this adapter, it is possible to map routing using the ``javax.ws.rs.Path`` annotation (hereafter referred to as ``Path`` annotation) in JAX-RS.
Mapping in Jakarta RESTful Web Services Path Annotation
-------------------------------------------------------------
Since version 1.2.0 of this adapter, it is possible to map routing using the ``jakarta.ws.rs.Path`` annotation (hereafter referred to as ``Path`` annotation) in Jakarta RESTful Web Services.

This section describes how to enable routing with ``Path`` annotations for existing :ref:`RESTful Web Service <restful_web_service>` and details of the various configurations.

Expand Down Expand Up @@ -170,7 +170,7 @@ In addition, this :java:extdoc:`JaxRsPathOptionsProvider <nablarch.integration.r
**applicationPath**

| Specify a common prefix for the path to be mapped.
| This means the same value as in ``javax.ws.rs.ApplicationPath`` annotation in JAX-RS.
| This means the same value as in ``jakarta.ws.rs.ApplicationPath`` annotation in Jakarta RESTful Web Services.
**basePackage**

Expand Down Expand Up @@ -215,7 +215,7 @@ The following is an example implementation that defines the mapping using the ``
}
| By annotating the action class with a ``Path`` annotation, we can associate the path set in the ``value`` of the ``Path`` annotation with the action class.
| In addition, can map a HTTP method to methods in the action class by annotating methods in the action class with a corresponding annotation of HTTP method such as ``javax.ws.rs.GET`` .
| In addition, can map a HTTP method to methods in the action class by annotating methods in the action class with a corresponding annotation of HTTP method such as ``jakarta.ws.rs.GET`` .
In the above example implementation, the HTTP request will be dispatched as follows

Expand All @@ -230,13 +230,13 @@ Path HTTP method Method of dispatching target
.. tip::
The following annotations mapping the HTTP method are provided by default.

* ``javax.ws.rs.DELETE``
* ``javax.ws.rs.GET``
* ``javax.ws.rs.HEAD``
* ``javax.ws.rs.OPTIONS`` (JAX-RS 1.1 or higher)
* ``javax.ws.rs.PATCH`` (JAX-RS 2.1 or higher)
* ``javax.ws.rs.POST``
* ``javax.ws.rs.PUT``
* ``jakarta.ws.rs.DELETE``
* ``jakarta.ws.rs.GET``
* ``jakarta.ws.rs.HEAD``
* ``jakarta.ws.rs.OPTIONS``
* ``jakarta.ws.rs.PATCH``
* ``jakarta.ws.rs.POST``
* ``jakarta.ws.rs.PUT``

In addition, you can also define a subpath mapping by annotating the method with a ``Path`` annotation as follows.

Expand Down Expand Up @@ -295,8 +295,8 @@ Can also include parameters in the path, as follows
}
}
| The path parameter should be written in accordance with the JAX-RS specification, not in the http-request-router syntax.
| This is because this feature (routing definition with ``Path`` annotations) follows the JAX-RS specification.
| The path parameter should be written in accordance with the Jakarta RESTful Web Services specification, not in the http-request-router syntax.
| This is because this feature (routing definition with ``Path`` annotations) follows the Jakarta RESTful Web Services 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)>` .
Expand Down
6 changes: 3 additions & 3 deletions en/application_framework/adaptors/web_thymeleaf_adaptor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Module list
.. tip::

Tests are conducted using Thymeleaf version 3.0.9 RELEASE.
Tests are conducted using Thymeleaf version 3.1.1 RELEASE.
When changing the version, test in the project to confirm that there are no problems.

Configuration for using the web application Thymeleaf adapter
Expand Down Expand Up @@ -61,8 +61,8 @@ The configuration example of the component configuration file is shown below.

Though ``org.thymeleaf.templateresolver.ServletContextTemplateResolver`` is present in the implementation class of ``ITemplateResolver`` , it cannot be registered to the :ref:`repository` for the following reasons:

* ``javax.servlet.ServletContext`` is required as a constructor argument (it has no default constructor).
* ``javax.servlet.ServletContext`` cannot be accessed when building a system repository and objects cannot be created by :ref:`factory <repository-factory_injection>`.
* ``jakarta.servlet.ServletContext`` is required as a constructor argument (it has no default constructor).
* ``jakarta.servlet.ServletContext`` cannot be accessed when building a system repository and objects cannot be created by :ref:`factory <repository-factory_injection>`.

For this reason, use another implementation class such as ``ClassLoaderTemplateResolver`` and not ``ServletContextTemplateResolver`` .

Expand Down
Loading

0 comments on commit 806085b

Please sign in to comment.