Interface StatelessSessionBuilder

All Superinterfaces:

CommonBuilder

All Known Subinterfaces:

SharedStatelessSessionBuilder

public interface StatelessSessionBuilder
extends CommonBuilder

Allows creation of a new StatelessSession with specific options overriding the defaults from the SessionFactory.

See Also:

• SessionFactory.withStatelessOptions()
• SharedStatelessSessionBuilder

Method Summary

Modifier and Type	Method	Description
StatelessSessionBuilder	asOf(Instant instant)	Specify the instant for reading temporal entity data.
StatelessSessionBuilder	atChangeset(Object changesetId)	Specify the changeset id for reading temporal or audited entity data.
StatelessSessionBuilder	cacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)	Specify the CacheRetrieveMode for the session.
StatelessSessionBuilder	cacheStoreMode(CacheStoreMode cacheStoreMode)	Specify the CacheStoreMode for the session.
StatelessSessionBuilder	connection(Connection connection)	Adds a specific connection to be used to the session options.
StatelessSessionBuilder	connectionHandling(ConnectionAcquisitionMode acquisitionMode, ConnectionReleaseMode releaseMode)	Specifies the connection handling modes for the session.
StatelessSessionBuilder	initialCacheMode(CacheMode cacheMode)	Specify the initial CacheMode for the session.
StatelessSessionBuilder	interceptor(Interceptor interceptor)	Adds a specific interceptor to the session options.
StatelessSessionBuilder	jdbcBatchSize(int batchSize)	Specifies a session-specific size for JDBC batching, overriding any SessionFactory-level size.
StatelessSessionBuilder	jdbcTimeZone(TimeZone timeZone)	Specify the JDBC time zone to use for the session.
StatelessSessionBuilder	noInterceptor()	Specifies that no Interceptor should be used.
StatelessSessionBuilder	noSessionInterceptorCreation()	Specifies that no session-scoped interceptor should be used for the session.
StatelessSessionBuilder	noStatementInspector()	Signifies that no SQL statement inspector should be used.
StatelessSession	open()	Open the session using the specified options.
StatelessSession	openStatelessSession()	Opens a session with the specified options.
StatelessSessionBuilder	readOnly(boolean readOnly)	Specify a read-only mode for the session.
StatelessSessionBuilder	statementInspector(UnaryOperator<String> operator)	Applies the given statement inspection function to the session.
StatelessSessionBuilder	statementInspector(StatementInspector statementInspector)	Deprecated. This operation exposes the SPI typeStatementInspector and is therefore a layer-breaker.
StatelessSessionBuilder	tenantIdentifier(Object tenantIdentifier)	Specify the tenant identifier to be associated with the opened session.

Method Details

openStatelessSession

@Nonnull
StatelessSession openStatelessSession()

Opens a session with the specified options.

See Also:

• open()

open

@Nonnull
StatelessSession open()

Description copied from interface: CommonBuilder

Open the session using the specified options.

Specified by:

open in interface CommonBuilder

connection

@Nonnull
StatelessSessionBuilder connection(@Nonnull
 Connection connection)

Description copied from interface: CommonBuilder

Adds a specific connection to be used to the session options.

Specified by:

connection in interface CommonBuilder

Parameters:

connection - The connection to use.

Returns:

this, for method chaining

connectionHandling

@Nonnull
StatelessSessionBuilder connectionHandling(@Nonnull
 ConnectionAcquisitionMode acquisitionMode,
 @Nonnull
 ConnectionReleaseMode releaseMode)

Description copied from interface: CommonBuilder

Specifies the connection handling modes for the session.

Specified by:

connectionHandling in interface CommonBuilder

Returns:

this, for method chaining

interceptor

@Nonnull
StatelessSessionBuilder interceptor(@Nullable
 Interceptor interceptor)

Description copied from interface: CommonBuilder

Adds a specific interceptor to the session options.

Specified by:

interceptor in interface CommonBuilder

Parameters:

interceptor - The interceptor to use.

Returns:

this, for method chaining

noInterceptor

@Nonnull
StatelessSessionBuilder noInterceptor()

Description copied from interface: CommonBuilder

Specifies that no Interceptor should be used. This indicates to ignore both (if either) the interceptor and session-scoped interceptor associated with the SessionFactory

Specified by:

noInterceptor in interface CommonBuilder

Returns:

this, for method chaining

noSessionInterceptorCreation

@Nonnull
StatelessSessionBuilder noSessionInterceptorCreation()

Description copied from interface: CommonBuilder

Specifies that no session-scoped interceptor should be used for the session. If the SessionFactory has a configured interceptor, it will still be used.

Specified by:

noSessionInterceptorCreation in interface CommonBuilder

Returns:

this, for method chaining

See Also:

• CommonBuilder.noInterceptor()

tenantIdentifier

@Nonnull
StatelessSessionBuilder tenantIdentifier(Object tenantIdentifier)

Description copied from interface: CommonBuilder

Specify the tenant identifier to be associated with the opened session.

try (var session = sessionFactory.withOptions()
		.tenantIdentifier(tenantId)
		.openSession()) {
	...
}

Specified by:

tenantIdentifier in interface CommonBuilder

Parameters:

tenantIdentifier - The tenant identifier.

Returns:

this, for method chaining

readOnly

@Incubating
@Nonnull
StatelessSessionBuilder readOnly(boolean readOnly)

Description copied from interface: CommonBuilder

Specify a read-only mode for the session. If a session is created in read-only mode, then Connection.setReadOnly(boolean) is called when a JDBC connection is obtained.

Furthermore, if read/write replication is in use, then:

• a read-only session will connect to a read-only replica, but
• a non-read-only session will connect to a writable replica.

When read/write replication is in use, it's strongly recommended that the session be created with the initial cache-mode set to CacheMode.GET, to avoid writing stale data read from a read-only replica to the second-level cache. Hibernate cannot possibly guarantee that data read from a read-only replica is up to date.

When read/write replication is in use, it's possible that an item read from the second-level cache might refer to data which does not yet exist in the read-only replica. In this situation, an exception occurs when the association is fetched. To completely avoid this possibility, the initial cache-mode must be set to CacheMode.IGNORE. However, it's also usually possible to structure data access code in a way which eliminates this possibility.

try (var readOnlySession =
		sessionFactory.withOptions()
			.readOnly(true)
			.initialCacheMode(CacheMode.IGNORE)
			.openSession()) {
	...
}

If a session is created in read-only mode, then it cannot be changed to read-write mode, and any call to Session.setDefaultReadOnly(boolean) with fail. On the other hand, if a session is created in read-write mode, then it may later be switched to read-only mode, but all database access is directed to the writable replica.

Specified by:

readOnly in interface CommonBuilder

Returns:

this, for method chaining

See Also:

• MultiTenantConnectionProvider.getReadOnlyConnection(Object)
• MultiTenantConnectionProvider.releaseReadOnlyConnection(Object, Connection)

jdbcBatchSize

@Incubating
@Nonnull
StatelessSessionBuilder jdbcBatchSize(int batchSize)

Description copied from interface: CommonBuilder

Specifies a session-specific size for JDBC batching, overriding any SessionFactory-level size.

Specified by:

jdbcBatchSize in interface CommonBuilder

Returns:

this, for method chaining

See Also:

• BatchSettings.STATEMENT_BATCH_SIZE

initialCacheMode

@Incubating
@Nonnull
StatelessSessionBuilder initialCacheMode(@Nonnull
 CacheMode cacheMode)

Description copied from interface: CommonBuilder

Specify the initial CacheMode for the session.

Specified by:

initialCacheMode in interface CommonBuilder

Returns:

this, for method chaining

See Also:

• SharedSessionContract.getCacheMode()

cacheStoreMode

@Nonnull
StatelessSessionBuilder cacheStoreMode(@Nullable
 CacheStoreMode cacheStoreMode)

Description copied from interface: CommonBuilder

Specify the CacheStoreMode for the session.

Specified by:

cacheStoreMode in interface CommonBuilder

Returns:

this, for method chaining

cacheRetrieveMode

@Nonnull
StatelessSessionBuilder cacheRetrieveMode(@Nullable
 CacheRetrieveMode cacheRetrieveMode)

Description copied from interface: CommonBuilder

Specify the CacheRetrieveMode for the session.

Specified by:

cacheRetrieveMode in interface CommonBuilder

Returns:

this, for method chaining

statementInspector

@Nonnull
StatelessSessionBuilder statementInspector(@Nullable
 UnaryOperator<String> operator)

Description copied from interface: CommonBuilder

Applies the given statement inspection function to the session.

Specified by:

statementInspector in interface CommonBuilder

Parameters:

operator - An operator which accepts a SQL string, returning a processed SQL string to be used by Hibernate instead. The operator may simply (and usually) return the original SQL.

Returns:

this, for method chaining

noStatementInspector

@Nonnull
StatelessSessionBuilder noStatementInspector()

Description copied from interface: CommonBuilder

Signifies that no SQL statement inspector should be used.

By default, if no inspector is explicitly specified, the inspector associated with the SessionFactory, if one, is inherited by the new session.

Specified by:

noStatementInspector in interface CommonBuilder

Returns:

this, for method chaining

jdbcTimeZone

@Nonnull
StatelessSessionBuilder jdbcTimeZone(@Nullable
 TimeZone timeZone)

Description copied from interface: CommonBuilder

Specify the JDBC time zone to use for the session.

Specified by:

jdbcTimeZone in interface CommonBuilder

Returns:

this, for method chaining

statementInspector

@Deprecated(since="7.0")
@Nonnull
StatelessSessionBuilder statementInspector(@Nonnull
 StatementInspector statementInspector)

Deprecated.

This operation exposes the SPI typeStatementInspector and is therefore a layer-breaker. Use statementInspector(UnaryOperator) instead.

Applies the given StatementInspector to the session.

Parameters:

statementInspector - The StatementInspector to use.

Returns:

this, for method chaining

asOf

@Nonnull
StatelessSessionBuilder asOf(@Nullable
 Instant instant)

Specify the instant for reading temporal entity data. Instances of temporal entities retrieved in the session will represent the revisions effective at the given instant.

Specified by:

asOf in interface CommonBuilder

See Also:

• Temporal

atChangeset

@Nonnull
StatelessSessionBuilder atChangeset(@Nullable
 Object changesetId)

Specify the changeset id for reading temporal or audited entity data. Instances of temporal or audited entities retrieved in the session represent the state effective at the given changeset. The given value should match the type returned by the configured changeset id supplier.

Specified by:

atChangeset in interface CommonBuilder

See Also:

• Temporal