Stage.SessionFactory (Hibernate Reactive Core 1.0.0.Alpha10 API)

All Superinterfaces:: AutoCloseable

All Known Implementing Classes:: StageSessionFactoryImpl

Enclosing interface:: Stage

public static interface Stage.SessionFactory
extends AutoCloseable

Factory for reactive sessions.

A Stage.SessionFactory may be obtained from an instance of javax.persistence.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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Destroy the session factory and clean up its connection pool.
`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()`
`Stage.Session`	`openSession()` Obtain a new `reactive session`, the main interaction point between the user's program and Hibernate Reactive.
`Stage.Session`	`openSession(String tenantId)` Obtain a new `reactive session` for a specified tenant.
`Stage.StatelessSession`	`openStatelessSession()` Obtain a `reactive stateless session`.
`<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>`	`withTransaction(BiFunction<Stage.Session,Stage.Transaction,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
```
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(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().
  - withSession
```
<T> CompletionStage<T> withSession(Function<Stage.Session,CompletionStage<T>> work)
```
    Perform work using a reactive session.
    The session will be closed automatically.
    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.
    The session will be closed automatically.
    Parameters:
    tenantId - the id of the tenant
    work - a function which accepts the session and returns the result of the work as a CompletionStage.
  - withTransaction
```
<T> CompletionStage<T> withTransaction(BiFunction<Stage.Session,Stage.Transaction,CompletionStage<T>> work)
```
    Perform work using a reactive session within an associated transaction.
    The session will be flushed and closed automatically, and the transaction committed automatically.
    Parameters:
    work - a function which accepts the session and returns the result of the work as a CompletionStage.
    See Also:
    withSession(Function), Stage.Session.withTransaction(Function)
  - withTransaction
```
<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.
    The session will be flushed and closed automatically, and the transaction committed automatically.
    Parameters:
    tenantId - the id of the tenant
    work - a function which accepts the session and returns the result of the work as a CompletionStage.
    See Also:
    withSession(Function), Stage.Session.withTransaction(Function)
  - getCriteriaBuilder
```
CriteriaBuilder getCriteriaBuilder()
```
    Returns:
    an instance of CriteriaBuilder for creating criteria queries.
  - getMetamodel
```
Metamodel getMetamodel()
```
    Obtain the JPA Metamodel for the persistence unit.
  - getCache
```
Cache getCache()
```
    Obtain the Cache object for managing the second-level cache.
  - close
```
void close()
```
    Destroy the session factory and clean up its connection pool.
    Specified by:
    close in interface AutoCloseable
  - isOpen
```
boolean isOpen()
```
    Returns:
    false if close() has been called

Interface Stage.SessionFactory

Method Summary

Method Detail

openSession

openSession

openStatelessSession

withSession

withSession

withTransaction

withTransaction

getCriteriaBuilder

getMetamodel

getCache

close

isOpen