Package org.hibernate.cfg

Interface PersistenceSettings

All Known Subinterfaces:

AvailableSettings

All Known Implementing Classes:

Environment

public interface PersistenceSettings

Settings related to persistence-units

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JAKARTA_PERSISTENCE_PROVIDER	Specifies a class implementing PersistenceProvider.
static final String	JAKARTA_TRANSACTION_TYPE	Specifies the type of transactions supported by the entity managers.
static final String	JPA_CALLBACKS_ENABLED	Allows JPA callbacks (via PreUpdate and friends) to be completely disabled.
static final String	JPA_PERSISTENCE_PROVIDER	Deprecated. Use JAKARTA_PERSISTENCE_PROVIDER instead
static final String	JPA_TRANSACTION_TYPE	Deprecated. Use JAKARTA_TRANSACTION_TYPE instead
static final String	PERSISTENCE_UNIT_NAME	Specifies the name of the persistence unit.
static final String	SCANNER	Specifies an implementation of Scanner, either: an instance of Scanner, a Class representing a class that implements Scanner the name of a class that implements Scanner.
static final String	SCANNER_ARCHIVE_INTERPRETER	Specifies an ArchiveDescriptorFactory to use in the scanning process, either: an instance of ArchiveDescriptorFactory, a Class representing a class that implements ArchiveDescriptorFactory, or the name of a class that implements ArchiveDescriptorFactory.
static final String	SCANNER_DISCOVERY	Identifies a comma-separated list of values indicating the types of things we should autodetect during scanning.
static final String	SESSION_FACTORY_JNDI_NAME	An optional name used to bind the SessionFactory into JNDI.
static final String	SESSION_FACTORY_NAME	Setting used to name the Hibernate SessionFactory.
static final String	SESSION_FACTORY_NAME_IS_JNDI	Does the value defined by SESSION_FACTORY_NAME represent a JNDI namespace into which the SessionFactory should be bound and made accessible?
static final String	SESSION_FACTORY_OBSERVER	Specifies a class which implements SessionFactoryObserver and has a constructor with no parameters.
static final String	UNOWNED_ASSOCIATION_TRANSIENT_CHECK	Specifies whether unowned (i.e.

Field Details

JAKARTA_PERSISTENCE_PROVIDER

static final String JAKARTA_PERSISTENCE_PROVIDER

Specifies a class implementing PersistenceProvider. Naturally, this should always be HibernatePersistenceProvider, which is the best damn persistence provider ever. There's no need to explicitly specify this setting when there are no inferior persistence providers floating about.

See JPA 2 sections 9.4.3 and 8.2.1.4

See Also:

• Constant Field Values

JAKARTA_TRANSACTION_TYPE

static final String JAKARTA_TRANSACTION_TYPE

Specifies the type of transactions supported by the entity managers. The default depends on whether the program is considered to be executing in a Java SE or EE environment:

• For Java SE, the default is RESOURCE_LOCAL.
• For Java EE, the default is JTA.

See JPA 2 sections 9.4.3 and 8.2.1.2

See Also:

• PersistenceUnitInfo.getTransactionType()
• Constant Field Values

SESSION_FACTORY_NAME

static final String SESSION_FACTORY_NAME

Setting used to name the Hibernate SessionFactory.

Naming the SessionFactory allows for it to be properly serialized across JVMs as long as the same name is used on each JVM.

If SESSION_FACTORY_NAME_IS_JNDI is set to true, this name will also be used as SESSION_FACTORY_JNDI_NAME.

See Also:

• SESSION_FACTORY_JNDI_NAME
• SessionFactoryRegistry
• SessionFactoryBuilder.applyName(String)
• Constant Field Values

SESSION_FACTORY_JNDI_NAME

static final String SESSION_FACTORY_JNDI_NAME

An optional name used to bind the SessionFactory into JNDI.

If SESSION_FACTORY_NAME_IS_JNDI is set to true, SESSION_FACTORY_NAME will be used as the JNDI name

Since:

7.0

See Also:

• SESSION_FACTORY_NAME_IS_JNDI
• SessionFactoryRegistry
• SessionFactoryBuilder.applyName(String)
• Constant Field Values

SESSION_FACTORY_NAME_IS_JNDI

static final String SESSION_FACTORY_NAME_IS_JNDI

Does the value defined by SESSION_FACTORY_NAME represent a JNDI namespace into which the SessionFactory should be bound and made accessible?

Defaults to true for backwards compatibility.

Set this to false if naming a SessionFactory is needed for serialization purposes, but no writable JNDI context exists in the runtime environment or if the user simply does not want JNDI to be used.

See Also:

• SESSION_FACTORY_NAME
• SessionFactoryBuilder.applyNameAsJndiName(boolean)
• Constant Field Values

Default Value:

true if SessionFactory.getName() comes from "hibernate.session_factory_name"; false if there is no SessionFactory.getName() or if it comes from "hibernate.persistenceUnitName"

PERSISTENCE_UNIT_NAME

static final String PERSISTENCE_UNIT_NAME

Specifies the name of the persistence unit.

See Also:

• PersistenceUnitInfo.getPersistenceUnitName()
• Constant Field Values

SCANNER

static final String SCANNER

Specifies an implementation of Scanner, either:

• an instance of Scanner,
• a Class representing a class that implements Scanner
• the name of a class that implements Scanner.

See Also:

• MetadataBuilder.applyScanner(org.hibernate.boot.archive.scan.spi.Scanner)
• Constant Field Values

SCANNER_ARCHIVE_INTERPRETER

static final String SCANNER_ARCHIVE_INTERPRETER

Specifies an ArchiveDescriptorFactory to use in the scanning process, either:

• an instance of ArchiveDescriptorFactory,
• a Class representing a class that implements ArchiveDescriptorFactory, or
• the name of a class that implements ArchiveDescriptorFactory.

See information on Scanner about expected constructor forms.

See Also:

• SCANNER
• Scanner
• MetadataBuilder.applyArchiveDescriptorFactory(org.hibernate.boot.archive.spi.ArchiveDescriptorFactory)
• Constant Field Values

SCANNER_DISCOVERY

static final String SCANNER_DISCOVERY

Identifies a comma-separated list of values indicating the types of things we should autodetect during scanning. Allowable values include:

• "class" specifies that .class files are discovered as managed classes
• "hbm" specifies that hbm.xml files are discovered as mapping files

When .class discovery is enabled, the module hibernate-scan-jandex must be added as a dependency, or some other implementation of the service ScannerFactory must be made available.

See Also:

• MetadataBuilder.applyScanOptions(org.hibernate.boot.archive.scan.spi.ScanOptions)
• Constant Field Values

JPA_CALLBACKS_ENABLED

@Incubating
static final String JPA_CALLBACKS_ENABLED

Allows JPA callbacks (via PreUpdate and friends) to be completely disabled. Mostly useful to save some memory when they are not used.

JPA callbacks are enabled by default. Set this property to false to disable them.

Experimental and will likely be removed as soon as the memory overhead is resolved.

Since:

5.4

See Also:

• CallbackType
• Constant Field Values

SESSION_FACTORY_OBSERVER

static final String SESSION_FACTORY_OBSERVER

Specifies a class which implements SessionFactoryObserver and has a constructor with no parameters.

See Also:

• SessionFactoryBuilder.addSessionFactoryObservers(SessionFactoryObserver...)
• Constant Field Values

JPA_PERSISTENCE_PROVIDER

@Deprecated
static final String JPA_PERSISTENCE_PROVIDER

Deprecated.

Use JAKARTA_PERSISTENCE_PROVIDER instead

See Also:

• Constant Field Values

JPA_TRANSACTION_TYPE

@Deprecated
static final String JPA_TRANSACTION_TYPE

Deprecated.

Use JAKARTA_TRANSACTION_TYPE instead

The type of transactions supported by the entity managers.

See JPA 2 sections 9.4.3 and 8.2.1.2

See Also:

• Constant Field Values

UNOWNED_ASSOCIATION_TRANSIENT_CHECK

static final String UNOWNED_ASSOCIATION_TRANSIENT_CHECK

Specifies whether unowned (i.e. mapped-by) associations should be considered when validating transient entity instance references.

See Also:

• Constant Field Values

Default Value:

false