org.hibernate.reactive.stage

Interface Stage.SessionFactory

All Superinterfaces:

AutoCloseable

Enclosing interface:

Stage

public static interface Stage.SessionFactory
extends AutoCloseable

Factory for reactive sessions.

A Stage.SessionFactory may be obtained from an instance of EntityManagerFactory as follows:

 Stage.SessionFactory sessionFactory =
                        createEntityManagerFactory("example")
                                .unwrap(Stage.SessionFactory.class);
 

Here, configuration properties must be specified in persistence.xml.

Alternatively, a Stage.SessionFactory may be obtained via programmatic configuration of Hibernate using:

 Configuration configuration = new Configuration();
 ...
 Stage.SessionFactory sessionFactory =
                configuration.buildSessionFactory(
                        new ReactiveServiceRegistryBuilder()
                                .applySettings( configuration.getProperties() )
                                .build()
                )
                .unwrap(Stage.SessionFactory.class);
 

Method Summary

Modifier and Type	Method and Description
void	close() Destroy the session factory and clean up its connection pool.
org.hibernate.Cache	getCache() Obtain the Cache object for managing the second-level cache.
CriteriaBuilder	getCriteriaBuilder()
Metamodel	getMetamodel() Obtain the JPA Metamodel for the persistence unit.
boolean	isOpen()
CompletionStage<Stage.Session>	openSession() Obtain a new reactive session CompletionStage, the main interaction point between the user's program and Hibernate Reactive.
CompletionStage<Stage.Session>	openSession(String tenantId) Obtain a new reactive session CompletionStage for a specified tenant.
CompletionStage<Stage.StatelessSession>	openStatelessSession() Obtain a reactive stateless session CompletionStage.
CompletionStage<Stage.StatelessSession>	openStatelessSession(String tenantId) Obtain a reactive stateless session CompletionStage.
<T> CompletionStage<T>	withSession(Function<Stage.Session,CompletionStage<T>> work) Perform work using a reactive session.
<T> CompletionStage<T>	withSession(String tenantId, Function<Stage.Session,CompletionStage<T>> work) Perform work using a reactive session for a specified tenant.
<T> CompletionStage<T>	withStatelessSession(Function<Stage.StatelessSession,CompletionStage<T>> work) Perform work using a stateless session.
<T> CompletionStage<T>	withStatelessSession(String tenantId, Function<Stage.StatelessSession,CompletionStage<T>> work) Perform work using a stateless session.
<T> CompletionStage<T>	withStatelessTransaction(BiFunction<Stage.StatelessSession,Stage.Transaction,CompletionStage<T>> work) Perform work using a reactive session within an associated transaction.
default <T> CompletionStage<T>	withStatelessTransaction(Function<Stage.StatelessSession,CompletionStage<T>> work) Perform work using a reactive session within an associated transaction.
<T> CompletionStage<T>	withStatelessTransaction(String tenantId, BiFunction<Stage.StatelessSession,Stage.Transaction,CompletionStage<T>> work) Perform work using a reactive session within an associated transaction.
<T> CompletionStage<T>	withTransaction(BiFunction<Stage.Session,Stage.Transaction,CompletionStage<T>> work) Perform work using a reactive session within an associated transaction.
default <T> CompletionStage<T>	withTransaction(Function<Stage.Session,CompletionStage<T>> work) Perform work using a reactive session within an associated transaction.
<T> CompletionStage<T>	withTransaction(String tenantId, BiFunction<Stage.Session,Stage.Transaction,CompletionStage<T>> work) Perform work using a reactive session for a specified tenant within an associated transaction.

Method Detail

openSession

CompletionStage<Stage.Session> openSession()

Obtain a new reactive session CompletionStage, the main interaction point between the user's program and Hibernate Reactive.

When the CompletionStage completes successfully it returns a newly created session.

The client must explicitly close the session by calling Stage.Closeable.close().

See Also:

withSession(Function)

openSession

CompletionStage<Stage.Session> openSession(String tenantId)

Obtain a new reactive session CompletionStage for a specified tenant.

When the CompletionStage completes successfully it returns a newly created session.

The client must explicitly close the session by calling Stage.Closeable.close().

Parameters:

tenantId - the id of the tenant

See Also:

withSession(Function)

openStatelessSession

CompletionStage<Stage.StatelessSession> openStatelessSession()

Obtain a reactive stateless session CompletionStage.

When the CompletionStage completes successfully it returns a newly created session.

The client must explicitly close the session by calling Stage.StatelessSession.close().

openStatelessSession

CompletionStage<Stage.StatelessSession> openStatelessSession(String tenantId)

Obtain a reactive stateless session CompletionStage.

When the CompletionStage completes successfully it returns a newly created session.

The client must explicitly close the session by calling Stage.StatelessSession.close().

Parameters:

tenantId - the id of the tenant

withSession

<T> CompletionStage<T> withSession(Function<Stage.Session,CompletionStage<T>> work)

Perform work using a reactive session.

If there is already a session associated with the current reactive stream, then the work will be executed using that session. Otherwise, if there is no session associated with the current stream, a new session will be created.

The session will be closed automatically, but must be flushed explicitly if necessary.

Parameters:

work - a function which accepts the session and returns the result of the work as a CompletionStage.

withSession

<T> CompletionStage<T> withSession(String tenantId,
                                   Function<Stage.Session,CompletionStage<T>> work)

Perform work using a reactive session for a specified tenant.

If there is already a session associated with the current reactive stream, and the given tenant, then the work will be executed using that session. Otherwise, a new session will be created.

The session will be closed automatically, but must be flushed explicitly if necessary.