Skip to content

Commit e8cfbf3

Browse files
committed
Sync faq from master
1 parent 52f6fd1 commit e8cfbf3

File tree

1 file changed

+55
-12
lines changed

1 file changed

+55
-12
lines changed

src/docs/asciidoc/faq.adoc

Lines changed: 55 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
:source-highlighter: prettify
88
:toc: left
99
:icons: font
10-
:jaybird6-full-version: 6.0.0
11-
:jaybird6-jna-version: 5.16.0
12-
:jaybird5-full-version: 5.0.6
10+
:jaybird6-full-version: 6.0.1
11+
:jaybird6-jna-version: 5.17.0
12+
:jaybird5-full-version: 5.0.7
1313
:jaybird5-template-version: {jaybird5-full-version}.<java>
1414
:jaybird5-example-version: {jaybird5-full-version}.java11
15-
:jaybird5-jna-version: 5.15.0
15+
:jaybird5-jna-version: 5.17.0
1616
:jaybird4-full-version: 4.0.10
1717
:jaybird4-template-version: {jaybird4-full-version}.<java>
1818
:jaybird4-example-version: {jaybird4-full-version}.java11
@@ -23,6 +23,13 @@
2323
:sectnums:
2424
:fb-canonical-html: https://firebirdsql.org/docs/drivers/java/faq.html
2525

26+
////
27+
SPDX-FileCopyrightText: Copyright 2021-2024 Firebird development team and individual contributors
28+
SPDX-FileCopyrightText: Copyright 2002-2004 Rick Fincher
29+
SPDX-FileCopyrightText: Copyright 2013-2025 Mark Rotteveel
30+
SPDX-License-Identifier: LicenseRef-PDL-1.0
31+
////
32+
2633
[#jaybird]
2734
= Jaybird
2835

@@ -324,14 +331,14 @@ Future versions of Jaybird may specify an explicit version, or be released under
324331
[discrete]
325332
=== Jaybird 6
326333
327-
Jaybird 6 supports Java 17, Java 21, and Java 23.
334+
Jaybird 6 supports Java 17, Java 21, and Java 24.
328335
Support for Java 17 and higher is limited to Java 17, Java 21, -- once available -- the latest LTS after Java 21, and the latest Java release.
329336
330337
[#java-jaybird-5]
331338
[discrete]
332339
=== Jaybird 5
333340
334-
Jaybird 5 supports Java 8, Java 11, Java 17, Java 21, and Java 23.
341+
Jaybird 5 supports Java 8, Java 11, Java 17, Java 21, and Java 24.
335342
Support for Java 9 and higher is limited to Java 8, Java 11, Java 17, Java 21, -- once available -- the latest LTS version after Java 21, and the latest Java release.
336343
337344
Jaybird 5 is the last version to support Java 8 and Java 11, support has been dropped with Jaybird 6, raising the minimum supported version to Java 17.
@@ -487,7 +494,6 @@ For version specific details, consult the release notes
487494
* The {firebird-java}[Firebird-Java group] and corresponding mailing list firebird-java@googlegroups.com
488495
+
489496
You can subscribe to the mailing list by sending an email to link:mailto:firebird-java+subscribe@googlegroups.com[firebird-java+subscribe@googlegroups.com]
490-
491497
* Looking for professional support of Jaybird?
492498
Jaybird is now part of the https://tidelift.com/subscription/pkg/maven-org-firebirdsql-jdbc-jaybird?utm_source=maven-org-firebirdsql-jdbc-jaybird&utm_medium=referral&utm_campaign=docs[Tidelift subscription].
493499
* The https://firebirdsql.org[Firebird project home page]
@@ -559,7 +565,7 @@ Jaybird 4 and higher also support:
559565
jdbc:firebird:host[/port]:<database>
560566
561567
[#open-officelibre-office-pure-java]
562-
=== Open Office/Libre Office (Pure Java)
568+
=== OpenOffice/LibreOffice (Pure Java)
563569
564570
Jaybird 5 and earlier can be used together with OpenOffice and LibreOffice Base.
565571
To address some compatibility issues (and differences in interpretation of JDBC specifications) a separate sub-protocol is used:
@@ -616,7 +622,7 @@ The JDBC URL sub-protocol `jdbc:firebirdsql:local` and `jdbc:firebird:local` are
616622
jdbc:firebirdsql:embedded:<database>
617623
618624
Similar to the Firebird client library, however `fbembed.dll` on Windows and `libfbembed.so` on Linux are used, falling back to `fbclient.dll`/`libfbclient.so` under the assumption it provides Embedded functionality.
619-
Requires correctly installed and configured Firebird embedded library and -- for Jaybird 2.2 or earlier -- the Jaybird native library, or -- for Jaybird 3 and higher -- the JNA jar file.
625+
Requires correctly installed and configured Firebird embedded library and -- for Jaybird 2.2 or earlier -- the Jaybird native library, or -- for Jaybird 3 and higher -- the JNA jar file.
620626
621627
Jaybird 4 and higher also support:
622628
@@ -698,7 +704,6 @@ To address this error, you can set the default connection character set using on
698704
* Use connection property `encoding` (alias: `lc_ctype`) with a Firebird character set name.
699705
+
700706
Use `encoding=NONE` for the default behavior (with some caveats, see <<how-does-character-set-none-work,How does character set `NONE` work?>>).
701-
702707
* Use connection property `charSet` (alias: `localEncoding`) with a Java character set name.
703708
* Use a combination of `encoding` and `charSet`, if you want to reinterpret a Firebird character set in a Java character set other than the default mapping.
704709
* By providing a default Firebird character set with system property `org.firebirdsql.jdbc.defaultConnectionEncoding`.
@@ -738,9 +743,27 @@ On the other hand, this has the benefit that this works for all Jaybird versions
738743
739744
This error means that the user does not exist, or that the specified password is not correct.
740745
746+
The following are common causes authentication can fail with the same error even if the username and password are correct.
747+
748+
==== Cause: authentication plugin mismatch
749+
741750
When connecting to Firebird 3.0 and higher, this error can also mean that the user does exist (with that password), but not for the authentication plugins tried for this connection.
751+
The list of authentication plugins tried is the conjunction of the plugins offered by the client (connection property `authPlugins`) and the `AuthServer` setting in _firebird.conf_.
752+
753+
For example, Jaybird 2.2.x and earlier only support legacy authentication, if you try to log in as a user created with the _Srp_ user manager, you will get the same error.
754+
755+
Similarly, Jaybird 4 and higher -- by default -- only connect using the _Srp256_ and _Srp_ authentication plugins, which means only users created with the _Srp_ user manager can be authenticated, and users created with _Legacy_UserManager_ cannot be authenticated.
756+
The recommended solution is to create the user for the _Srp_ user manager (e.g. see https://firebirdsql.org/file/documentation/chunk/en/refdocs/fblangref50/fblangref50-security-user.html#fblangref50-security-user-create[Firebird 5.0 `CREATE USER`^], specifically the `USING PLUGIN ...` clause).
757+
Alternatively, you can set connection property `authPlugins` to `Srp256,Srp,Legacy_Auth` to also try legacy authentication, see also https://firebirdsql.github.io/jaybird-manual/jaybird_manual.html#ref-auth-plugins[Authentication plugins] in the Jaybird manual.
742758
743-
For example, Jaybird 2.2.x and earlier only support legacy authentication, if you try to log in as a user created for SRP authentication, you will get the same error.
759+
You can check -- as `SYSDBA`, or with `RDB$ADMIN` in the security database -- what user manager(s) were used to create a user in the `SEC$USERS` virtual table.
760+
761+
==== Cause: case-sensitive username
762+
763+
With Firebird 3.0 and higher, this error can also be the result of using a case-sensitive username (i.e. the username was quoted, e.g. `CREATE USER "lowercaseuser" ...`).
764+
765+
To login, you must surround the username with quotes so it's handled case-sensitive.
766+
In a Java string literal, that means using `"\"lowercaseuser\""` instead of `"lowercaseuser"`.
744767
745768
[#incompatible-wire-encryption-levels-requested-on-client-and-server-335545064]
746769
=== Incompatible wire encryption levels requested on client and server (335545064)
@@ -776,7 +799,7 @@ Relax this setting (in `firebird.conf`) to `WireCrypt = Enabled`.
776799
777800
See also https://github.com/FirebirdSQL/jaybird/wiki/Jaybird-and-Firebird-3[Jaybird Wiki -- Jaybird and Firebird 3].
778801
779-
Make sure you check the other settings mentioned in that article, otherwise you'll get the next error.
802+
Make sure you check the other settings mentioned in that article, otherwise you'll get another error (<<error-occurred-during-login-please-check-server-firebird-log-for-details-335545106>>).
780803
781804
[#cause-unsupported-protocol]
782805
==== Cause: unsupported protocol version
@@ -969,3 +992,23 @@ With Jaybird 3.0.4 and higher for Java 7 (but not Java 8!) in Wildfly (or JBoss)
969992
----
970993
971994
Alternatively, use Jaybird for Java 8 (or higher).
995+
996+
[appendix#license-notice]
997+
== License Notice
998+
999+
The contents of this Documentation are subject to the Public Documentation License Version 1.0 (the “License”);
1000+
you may only use this Documentation if you comply with the terms of this License.
1001+
A copy of the License is available at https://firebirdsql.org/en/public-documentation-license/.
1002+
1003+
The Original Documentation is "`Jaybird Frequently Asked Questions`".
1004+
The Initial Writer of the Original Documentation is Mark Rotteveel, Copyright © 2013-2025.
1005+
All Rights Reserved.
1006+
(Initial Writer contact(s): mark (at) lawinegevaar (dot) nl).
1007+
1008+
Contributor(s): Rick Fincher. +
1009+
Portions created by Rick Fincher are Copyright © 2002-2004.
1010+
All Rights Reserved.
1011+
(Contributor contact(s): _unknown_).
1012+
1013+
The exact file history is recorded in our Git repository;
1014+
see https://github.com/FirebirdSQL/jaybird

0 commit comments

Comments
 (0)