Skip to content

Commit

Permalink
Prepare FAQ, release notes and SECURITY for 4.0.10 and 5.0.3 release
Browse files Browse the repository at this point in the history
4.0.10 is now end-of-life
  • Loading branch information
mrotteveel committed Nov 23, 2023
1 parent 7bd3ab1 commit 8409efe
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 21 deletions.
6 changes: 4 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ The following versions of Jaybird are actively maintained and supported.
|---------|--------------------------|
| 6.0.x | :heavy_exclamation_mark: |
| 5.0.x | :white_check_mark: |
| 4.0.x | :white_check_mark: |
| 4.0.x | :x: |
| 3.0.x | :x: |
| < 3.0 | :x: |

(:heavy_exclamation_mark: = under development, not yet supported)
:white_check_mark: = supported \
:x: = not supported \
:heavy_exclamation_mark: = under development, not yet supported

NOTE: The [version of SECURITY.md on the master branch](https://github.com/FirebirdSQL/jaybird/blob/master/SECURITY.md) is leading.

Expand Down
40 changes: 24 additions & 16 deletions src/docs/asciidoc/faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
:source-highlighter: prettify
:toc: left
:icons: font
:jaybird5-full-version: 5.0.2
:jaybird5-full-version: 5.0.3
:jaybird5-template-version: {jaybird5-full-version}.<java>
:jaybird5-example-version: {jaybird5-full-version}.java11
:jaybird4-full-version: 4.0.9
:jaybird4-full-version: 4.0.10
:jaybird4-template-version: {jaybird4-full-version}.<java>
:jaybird4-example-version: {jaybird4-full-version}.java11
:jaybird3-full-version: 3.0.12
Expand Down Expand Up @@ -63,8 +63,8 @@ If you want to use Type 2 support (native or embedded), you need to explicitly i
[#jaybird-4]
==== Jaybird 4

Jaybird 4 is maintained at least until the end of 2023.
However, we recommend upgrading to <<jaybird-5>>.
Jaybird 4 is end-of-life and will receive no further updates.
We recommend upgrading to <<jaybird-5>>.

Jaybird 4 is available from Maven Central:

Expand Down Expand Up @@ -262,9 +262,8 @@ Future versions of Jaybird may specify an explicit version, or be released under
[discrete]
=== Jaybird 5
Jaybird 5 supports Java 8, 11, 17 and 20.
Support for Java 9 and higher is limited to Java 11, 17 and the most recent LTS version after Java 17 and
the latest Java release.
Jaybird 5 supports Java 8, 11, 17 and 21.
Support for Java 9 and higher is limited to Java 8, 11, 17, 21 and the most recent LTS version after Java 21 and the latest Java release.
Jaybird 5 is the last version to support Java 8 and 11, support will be dropped with Jaybird 6, raising the minimum supported version to Java 17.
Expand All @@ -279,12 +278,12 @@ See also https://github.com/FirebirdSQL/jaybird/blob/master/devdoc/jdp/jdp-2022-
[discrete]
=== Jaybird 4
Jaybird 4 supports Java 7, 8, 11, 17 and 20.
Support for Java 9 and higher is limited to Java 11, 17 and the most recent LTS version after Java 17 and
the latest Java release.
Jaybird 4 supports Java 7, 8, 11, 17 and 21.
Support for Java 9 and higher is limited to Java 11, 17 and 21.
Jaybird 4 is the last version to support Java 7, support will be dropped with Jaybird 5.
Jaybird 4 is still maintained (at least until the end of 2023), but we recommend upgrading to Jaybird 5.
Jaybird 4.0.10 is the last release of Jaybird 4, and is end-of-life.
We recommend upgrading to Jaybird 5.
[#java-jaybird-3-0]
[discrete]
Expand Down Expand Up @@ -315,6 +314,8 @@ Jaybird 2.2 is the last version to support Java 6, support has been dropped with
Jaybird itself is not (yet) modularized.
To ensure a stable module name, Jaybird, since 2.2.14 and 3.0.3, declares the automatic module name `org.firebirdsql.jaybird`.
Jaybird 6 will be modular.
[#which-firebird-versions-are-supported]
== Which Firebird versions are supported?
Expand All @@ -335,7 +336,7 @@ Future versions of Jaybird are not guaranteed to work with version 2.5 and earli
Jaybird 4 supports Firebird version 2.5, 3.0 and 4.0, and introduces support for Firebird 4.0 types `DECLOAT`, extended precision of `NUMERIC` and `DECIMAL`, and time zone types (`TIME WITH TIME ZONE` and `TIMESTAMP WITH TIME ZONE`).
Jaybird 4 only provides partial support for Firebird 5.0, and the generated-keys support does not work in all cases due to Firebird 5.0 now supporting multi-row `RETURNING`.
Full Firebird 5.0 support will become available in Jaybird 5.
Full Firebird 5.0 support is available in Jaybird 5.
[#firebird-jaybird-3-0]
[discrete]
Expand Down Expand Up @@ -385,6 +386,7 @@ Apart from this FAQ, you can get additional information from:
For version specific details, consult the release notes
* https://www.firebirdsql.org/file/documentation/drivers_documentation/java/5.0.x/release_notes.html[Jaybird 5.0.x release notes]
* https://www.firebirdsql.org/file/documentation/drivers_documentation/java/4.0.x/release_notes.html[Jaybird 4.0.x release notes]
* https://www.firebirdsql.org/file/documentation/drivers_documentation/java/3.0.x/release_notes.html[Jaybird 3.0.x release notes]
* https://www.firebirdsql.org/file/documentation/drivers_documentation/java/2.2.x/release_notes.html[Jaybird 2.2.x release notes]
Expand Down Expand Up @@ -621,17 +623,23 @@ With Jaybird 3.0.2 or higher, it is better to just not set system property `org
[#how-can-i-enable-the-windows-tcp-loopback-fast-path-introduced-in-firebird-3-0-2]
== How can I enable the Windows "TCP Loopback Fast Path" introduced in Firebird 3.0.2?
CAUTION: Microsoft has deprecated the `SIO_LOOPBACK_FAST_PATH` and recommends not to use it.
[CAUTION]
====
Microsoft has deprecated the `SIO_LOOPBACK_FAST_PATH` and recommends not to use it.
Support was removed in Firebird 5.0.
====
Firebird 3.0.2 adds support for "`TCP Loopback Fast Path`" (`SIO_LOOPBACK_FAST_PATH` socket option).
Firebird 3.0.2 adds support for "`TCP Loopback Fast Path`" (`SIO_LOOPBACK_FAST_PATH` socket option);
support was removed in Firebird 5.0.
This is available in Windows 8 / Windows Server 2012 and higher.
This feature enables performance optimizations when connecting through localhost (127.0.0.1 / ::1).
It requires support on both client and server side.
Java support for "TCP Loopback Fast Path" was introduced in Java 8 update 60, it can be enabled by specifying the system property `jdk.net.useFastTcpLoopback` with value `true` (e.g. specify `-Djdk.net.useFastTcpLoopback=true` in your Java commandline).
Unfortunately, Java only has an 'all-or-nothing' support for the "`TCP Loopback Fast Path`", so Jaybird cannot enable this for you: you must specify this property on JVM startup.
On the other hand, this has the benefit that this works for all Jaybird versions, as long as you use Java 8 update 60 or higher (and Firebird 3.0.2 or higher).
On the other hand, this has the benefit that this works for all Jaybird versions, as long as you use Java 8 update 60 or higher (and Firebird 3.0.2 or higher, but before 5.0.0).
[#common-connection-errors]
== Common connection errors
Expand Down Expand Up @@ -689,7 +697,7 @@ Connecting to unsupported Firebird versions with the pure Java protocol can resu
There are two options to address this:
. Specify connection property `enableProtocol` with a list of unsupported protocol versions to try in addition to the supported protocol versions, or `"*"` to try all available protocol versions (e.g. `enableProtocol=12` or `enableProtocol=*`).
. Specify connection property `enableProtocol` with a list of unsupported protocol versions to try in addition to the supported protocol versions, or `"{asterisk}"` to try all available protocol versions (e.g. `enableProtocol=12` or `enableProtocol={asterisk}`).
. Use a native connection instead of a pure Java connection.
[#error-occurred-during-login-please-check-server-firebird-log-for-details-335545106]
Expand Down
6 changes: 3 additions & 3 deletions src/docs/asciidoc/release_notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Feedback can be sent to the https://groups.google.com/g/firebird-java[Firebird-j
[#supported-firebird-versions]
=== Supported Firebird versions

Jaybird {version_wo_target} was tested against Firebird 2.5.9, 3.0.10, and 4.0.2 and a recent snapshot of Firebird 5.0, but should also support other Firebird versions from 2.5 and up.
Jaybird {version_wo_target} was tested against Firebird 2.5.9, 3.0.11, and 4.0.4, and a recent snapshot of Firebird 5.0, but should also support other Firebird versions from 2.5 and up.

This driver does not support InterBase servers due to Firebird-specific changes in the protocol and database attachment parameters that are sent to the server.

Expand All @@ -158,8 +158,8 @@ This driver does not support InterBase servers due to Firebird-specific changes
Jaybird 5 supports Java 8 (JDBC 4.2), and Java 9 and higher (JDBC 4.3).
Support for earlier Java versions has been dropped.

Given the limited support period for Java 9 and higher versions, we limit support to Java 8, 11, 17 and the most recent LTS version after Java 17 and the latest Java release.
Currently, that means we support Java 8, 11, 17 and 20.
Given the limited support period for Java 9 and higher versions, we limit support to Java 8, 11, 17, 21 and the latest Java release.
Currently, that means we support Java 8, 11, 17 and 21.

[NOTE]
====
Expand Down

0 comments on commit 8409efe

Please sign in to comment.