Skip to content

mention Spring-specific stuff in Hibernate Data Repositories doc #10510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2025
Merged

mention Spring-specific stuff in Hibernate Data Repositories doc #10510

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion documentation/src/main/asciidoc/repositories/Configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,13 @@ This usually happens via dependency injection, so you'll need to make sure that
- in a Jakarta EE environment, `HibernateProcessor` generates special code which takes care of creating and destroying the `StatelessSession`, but
- in other environments, this is something we need to take care of ourselves.

Note that a `StatelessSession` should never be shared across transactions.

[CAUTION]
====
Depending on the libraries in your build path, `HibernateProcessor` generates different code.
For example, if Quarkus is on the build path, the repository implementation is generated to obtain the `StatelessSession` directly from CDI in a way which works in Quarkus but not in WildFly.
Similarly, if Spring is in the build path, the repository implementation is generated to use `ObjectProvider<StatelessSession>`, since Spring is not capable of transparently proxying contextual objects like CDI does.
====

If you have multiple persistence units, you'll need to disambiguate the persistence unit for a repository interface using `@Repository(dataStore="my-persistence-unit-name")`.
Expand All @@ -120,7 +123,16 @@ In principle, any implementation of `jakarta.inject` may be used to inject a rep
@Inject Library library;
----

However, this code will fail if the repository implementation is not able to obtain a `StatelessSession` from the bean container.
Of course, this code will fail if the repository implementation is not able to obtain a `StatelessSession` from the bean container.

[NOTE]
====
Unfortunately, `jakarta.inject` on its own is rather incomplete, and does not specify how injectable beans should be discovered.
Therefore, `HibernateProcessor` adds an appropriate bean-defining annotation to the repository implementation class, either:

- `@Dependent` if CDI is available, or
- `@Component` if Spring is available.
====

It's always possible to instantiate a repository implementation directly.

Expand Down