org.hibernate.reactive.stage

Interface Stage.SessionFactory

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

StageSessionFactoryImpl

Enclosing interface:

Stage

public static interface Stage.SessionFactory
extends java.lang.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.
javax.persistence.criteria.CriteriaBuilder	getCriteriaBuilder()
javax.persistence.metamodel.Metamodel	getMetamodel() Obtain the JPA Metamodel for the persistence unit.
boolean	isOpen()
Stage.Session	openSession() Obtain a new reactive session, the main interaction point between the user's program and Hibernate Reactive.
Stage.Session	openSession(java.lang.String tenantId) Obtain a new reactive session for a specified tenant.
Stage.StatelessSession	openStatelessSession() Obtain a reactive stateless session.
Stage.StatelessSession	openStatelessSession(java.lang.String tenantId) Obtain a reactive stateless session.
<T> java.util.concurrent.CompletionStage<T>	withSession(java.util.function.Function<Stage.Session,java.util.concurrent.CompletionStage<T>> work) Perform work using a reactive session.
<T> java.util.concurrent.CompletionStage<T>	withSession(java.lang.String tenantId, java.util.function.Function<Stage.Session,java.util.concurrent.CompletionStage<T>> work) Perform work using a reactive session for a specified tenant.
<T> java.util.concurrent.CompletionStage<T>	withStatelessSession(java.util.function.Function<Stage.StatelessSession,java.util.concurrent.CompletionStage<T>> work) Perform work using a stateless session.
<T> java.util.concurrent.CompletionStage<T>	withStatelessSession(java.lang.String tenantId, java.util.function.Function<Stage.StatelessSession,java.util.concurrent.CompletionStage<T>> work) Perform work using a stateless session.
<T> java.util.concurrent.CompletionStage<T>	withStatelessTransaction(java.util.function.BiFunction<Stage.StatelessSession,Stage.Transaction,java.util.concurrent.CompletionStage<T>> work) Perform work using a reactive session within an associated transaction.
<T> java.util.concurrent.CompletionStage<T>	withStatelessTransaction(java.lang.String tenantId, java.util.function.BiFunction<Stage.StatelessSession,Stage.Transaction,java.util.concurrent.CompletionStage<T>> work) Perform work using a reactive session within an associated transaction.
<T> java.util.concurrent.CompletionStage<T>	withTransaction(java.util.function.BiFunction<Stage.Session,Stage.Transaction,java.util.concurrent.CompletionStage<T>> work) Perform work using a reactive session within an associated transaction.
<T> java.util.concurrent.CompletionStage<T>	withTransaction(java.lang.String tenantId, java.util.function.BiFunction<Stage.Session,Stage.Transaction,java.util.concurrent.CompletionStage<T>> work) Perform work using a reactive session for a specified tenant within an associated transaction.

Method Detail

openSession

Stage.Session openSession()

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

The underlying database connection is obtained lazily when the returned Stage.Session needs to access the database.

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

See Also:

withSession(Function)

openSession

Stage.Session openSession(java.lang.String tenantId)

Obtain a new reactive session for a specified tenant.

The underlying database connection is obtained lazily when the returned Stage.Session needs to access the database.

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

Parameters:

tenantId - the id of the tenant

See Also:

withSession(Function)

openStatelessSession

Stage.StatelessSession openStatelessSession()

Obtain a reactive stateless session.

The underlying database connection is obtained lazily when the returned Stage.StatelessSession needs to access the database.

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

openStatelessSession

Stage.StatelessSession openStatelessSession(java.lang.String tenantId)

Obtain a reactive stateless session.

The underlying database connection is obtained lazily when the returned Stage.StatelessSession needs to access the database.

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

Parameters:

tenantId - the id of the tenant

withSession

<T> java.util.concurrent.CompletionStage<T> withSession(java.util.function.Function<Stage.Session,java.util.concurrent.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> java.util.concurrent.CompletionStage<T> withSession(java.lang.String tenantId,
                                                        java.util.function.Function<Stage.Session,java.util.concurrent.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.