Top Description Fields Constructors Methods
org.eclipse.persistence.config

public Class PersistenceUnitProperties

extends Object
Class Inheritance
Imports
java.io.File, java.sql.DriverManager, java.util.Collections, .HashMap, .HashSet, .Map, .Set, java.util.concurrent.TimeUnit, jakarta.persistence.EntityManager, .EntityManagerFactory, .FlushModeType, .MappedSuperclass, .Persistence, org.eclipse.persistence.annotations.Cache, .IdValidation, .PrimaryKey, org.eclipse.persistence.descriptors.ClassDescriptor, .MultitenantPolicy, org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy, org.eclipse.persistence.exceptions.ExceptionHandler, org.eclipse.persistence.internal.databaseaccess.BatchWritingMechanism, org.eclipse.persistence.internal.helper.Helper, org.eclipse.persistence.internal.sessions.remote.RemoteConnection, org.eclipse.persistence.logging.DefaultSessionLog, .SessionLog, org.eclipse.persistence.platform.database.DatabasePlatform, org.eclipse.persistence.platform.database.events.DatabaseEventListener, org.eclipse.persistence.platform.database.partitioning.DataPartitioningCallback, org.eclipse.persistence.platform.server.CustomServerPlatform, .ServerPlatform, org.eclipse.persistence.queries.JPAQueryBuilder, org.eclipse.persistence.sequencing.Sequence, org.eclipse.persistence.sessions.DatabaseLogin, .ExternalTransactionController, .Project, .SessionEventListener, .SessionProfiler, org.eclipse.persistence.sessions.coordination.RemoteCommandManager, .TransportManager, org.eclipse.persistence.sessions.factories.SessionManager, org.eclipse.persistence.sessions.remote.RemoteSession, org.eclipse.persistence.sessions.serializers.Serializer, org.eclipse.persistence.tools.profiler.PerformanceMonitor, .PerformanceProfiler, .QueryMonitor, org.eclipse.persistence.tools.tuning.SafeModeTuner, .SessionTuner

The class defines EclipseLink persistence unit property names. These values are used to assist in the configuration of properties passed to Persistence#createEntityManagerFactory(String, Map) which override the values specified in the persistence.xml file.

Usage Example:

Map<String, Object> props = new HashMap<String, Object>();

props.put(PersistenceUnitProperties.JDBC_USER, "user-name");
props.put(PersistenceUnitProperties.JDBC_PASSWORD, "password");

EntityManagerFactory emf = Persistence.createEntityManagerFactory("pu-name", props);

Property values are usually case-insensitive with some common sense exceptions, for instance class names.

See Also
Persistence#createEntityManagerFactory(String, Map)

Field Summary

Modifier and TypeField and Description
public static final String
ALLOW_NATIVE_SQL_QUERIES

The "eclipselink.jdbc.allow-native-sql-queries" property specifies whether any user defined SQL is allowed within a persistence unit.

public static final String
ALLOW_ZERO_ID

The "eclipselink.allow-zero-id" property configures if zero is considered a valid id on a new entity.

public static final String
APP_LOCATION

The property "eclipselink.application-location" specifies the file system directory location where DDL files are written (output) to.

public static final String
BATCH_WRITING

The "eclipselink.jdbc.batch-writing" property configures the use of batch writing to optimize transactions with multiple writes.

public static final String
BATCH_WRITING_SIZE

The "eclipselink.jdbc.batch-writing.size" property configures the batch size used for batch writing.

public static final String
BEAN_VALIDATION_NO_OPTIMISATION

Property for disabling Bean Validation optimisations.

public static final String
CACHE_EXTENDED_LOGGING

The "eclipselink.cache.extended.logging" property control (enable/disable) usage logging of JPA L2 cache.

public static final String
CACHE_QUERY_FORCE_DEFERRED_LOCKS

The "eclipselink.cache.query-force-deferred-locks" property force all queries and relationships to use deferred lock strategy during object building and L2 cache population.

public static final String
CACHE_SHARED_

Property prefix "eclipselink.cache.shared.

public static final String
CACHE_SHARED_DEFAULT

Default caching properties - apply to all entities.

public static final String
CACHE_SIZE_

Property prefix "eclipselink.cache.size.

public static final String
CACHE_SIZE_DEFAULT

Default caching properties - apply to all entities.

public static final String
CACHE_STATEMENTS

The "eclipselink.jdbc.cache-statements" property specifies whether JDBC statements should be cached.

public static final String
CACHE_STATEMENTS_SIZE

The "eclipselink.jdbc.cache-statements.size" property specifies the number of statements held when using internal statement caching.

public static final String
CACHE_TYPE_

Property prefix "eclipselink.cache.type.

public static final String
CACHE_TYPE_DEFAULT

Default caching properties - apply to all entities.

public static final String
CANONICAL_MODEL_GENERATE_COMMENTS

The "eclipselink.canonicalmodel.generate_comments" optional property can be used to disable usage of comments in declaration of Generated annotation.

public static final String
CANONICAL_MODEL_GENERATE_COMMENTS_DEFAULT

Default value for the "eclipselink.canonicalmodel.generate_comments" optional property.

public static final String
CANONICAL_MODEL_GENERATE_GENERATED

The "eclipselink.canonicalmodel.use_generated" optional property can be used to disable generation of jakarta.annotation.Generated annotation.

public static final String
CANONICAL_MODEL_GENERATE_GENERATED_DEFAULT

Default value for the "eclipselink.canonicalmodel.use_generated" optional property.

public static final String
CANONICAL_MODEL_GENERATE_TIMESTAMP

The "eclipselink.canonicalmodel.generate_timestamp" optional property can be used to disable usage of date in declaration of jakarta.annotation.Generated annotation.

public static final String
CANONICAL_MODEL_GENERATE_TIMESTAMP_DEFAULT

Default value for the "eclipselink.canonicalmodel.generate_timestamp" optional property.

public static final String
CANONICAL_MODEL_LOAD_XML

The "eclipselink.canonicalmodel.load_xml" optional property can be used a performance enhancement between compile rounds.

public static final String
CANONICAL_MODEL_LOAD_XML_DEFAULT

Default value for the "eclipselink.canonicalmodel.load_xml" optional property.

public static final String
CANONICAL_MODEL_PREFIX

The "eclipselink.canonicalmodel.prefix" optional property specifies the prefix that will be added to the start of the class name of any canonical model class generated.

public static String
CANONICAL_MODEL_PREFIX_DEFAULT

Default prefix that will be added to the start of the class name of any canonical model class generated.

public static final String
CANONICAL_MODEL_SUB_PACKAGE

The "eclipselink.canonicalmodel.subpackage" optional property specifies a sub-package name that can be used to have the canonical model generator generate its classes in a sub-package of the package where the corresponding entity class is located.

public static String
CANONICAL_MODEL_SUB_PACKAGE_DEFAULT

Default sub-package name that is used to have the canonical model generator generate its classes in a sub-package of the package where the corresponding entity class is located.

public static final String
CANONICAL_MODEL_SUFFIX

The "eclipselink.canonicalmodel.suffix" optional property specifies the suffix that will be added to the end of the class name of any canonical model class generated.

public static String
CANONICAL_MODEL_SUFFIX_DEFAULT

Default suffix that will be added to the end of the class name of any canonical model class generated.

public static final String
CANONICAL_MODEL_USE_STATIC_FACTORY

The "eclipselink.canonicalmodel.use_static_factory" optional property can be used a performance enhancement between compile rounds within an IDE.

public static final String
CANONICAL_MODEL_USE_STATIC_FACTORY_DEFAULT

Default value for the "eclipselink.canonicalmodel.use_static_factory" optional property.

public static final String
CATEGORY_LOGGING_LEVEL_

Property prefix "eclipselink.logging.level.

public static final String
CDI_BEANMANAGER

The "jakarta.persistence.bean.manager" property is used to set CDI BeanManager when available

public static final String
CLASSLOADER

The "eclipselink.classloader" property specifies the classloader to use to create an EntityManagerFactory in the property map passed to Persistence.createEntityManagerFactory.

public static final String
COMPOSITE_UNIT

The "eclipselink.composite-unit" property indicates if it's a composite persistence unit ("true").

public static final String
COMPOSITE_UNIT_MEMBER

The "eclipselink.composite-unit.member" property indicates if the persistence unit must be a member of a composite persistence unit ("true"), can't be used as an independent persistence unit.

public static final String
COMPOSITE_UNIT_PROPERTIES

The "eclipselink.composite-unit.properties" property may be passed to createEntityManagerFactory method of a composite persistence unit to pass properties to member persistence units.

public static final String
CONCURRENCY_MANAGER_ACQUIRE_WAIT_TIME

This system property in milliseconds can control thread management in org.eclipse.persistence.internal.helper.ConcurrencyManager.

public static final String
CONCURRENCY_MANAGER_ALLOW_CONCURRENCY_EXCEPTION

This property control (enable/disable) if ConcurrencyException fired when dead-lock diagnostic is enabled.

public static final String
CONCURRENCY_MANAGER_ALLOW_INTERRUPTED_EXCEPTION

This property control (enable/disable) if InterruptedException fired when dead-lock diagnostic is enabled.

public static final String
CONCURRENCY_MANAGER_ALLOW_STACK_TRACE_READ_LOCK

This property control (enable/disable) collection debug/trace information during ReadLock acquisition, when dead-lock diagnostic is enabled.

public static final String
CONCURRENCY_MANAGER_BUILD_OBJECT_COMPLETE_WAIT_TIME

This system property in milliseconds can control thread management in org.eclipse.persistence.internal.helper.ConcurrencyManager.

public static final String
CONCURRENCY_MANAGER_MAX_FREQUENCY_DUMP_MASSIVE_MESSAGE

This system property in milliseconds can control thread management in org.eclipse.persistence.internal.helper.ConcurrencyManager and org.eclipse.persistence.internal.helper.ConcurrencyUtil.

public static final String
CONCURRENCY_MANAGER_MAX_FREQUENCY_DUMP_TINY_MESSAGE

This system property in milliseconds can control thread management in org.eclipse.persistence.internal.helper.ConcurrencyManager and org.eclipse.persistence.internal.helper.ConcurrencyUtil.

public static final String
CONCURRENCY_MANAGER_MAX_SLEEP_TIME

This system property in milliseconds can control thread management in org.eclipse.persistence.internal.helper.ConcurrencyManager.

public static final String
CONCURRENCY_MANAGER_OBJECT_BUILDING_NO_THREADS

This property control number of threads in semaphore in org.eclipse.persistence.internal.descriptors.ObjectBuilder If "eclipselink.concurrency.manager.object.building.semaphore" property is true default value is 10.

public static final String
CONCURRENCY_MANAGER_USE_SEMAPHORE_TO_SLOW_DOWN_OBJECT_BUILDING

This property control (enable/disable) semaphore in org.eclipse.persistence.internal.descriptors.ObjectBuilder Object building see org.eclipse.persistence.internal.descriptors.ObjectBuilder could be one of the primary sources pressure on concurrency manager.

public static final String
CONCURRENCY_MANAGER_USE_SEMAPHORE_TO_SLOW_DOWN_WRITE_LOCK_MANAGER_ACQUIRE_REQUIRED_LOCKS

This property control (enable/disable) semaphore in org.eclipse.persistence.internal.helper.WriteLockManager#acquireRequiredLocks This algorithm org.eclipse.persistence.internal.helper.WriteLockManager#acquireRequiredLocks is being used when a transaction is committing and it is acquire locks to merge the change set.

public static final String
CONCURRENCY_MANAGER_WRITE_LOCK_MANAGER_ACQUIRE_REQUIRED_LOCKS_NO_THREADS

This property control number of threads in semaphore in org.eclipse.persistence.internal.helper.WriteLockManager#acquireRequiredLocks If "eclipselink.concurrency.manager.write.lock.manager.semaphore" property is true default value is 2.

public static final String
CONCURRENCY_SEMAPHORE_LOG_TIMEOUT

This property control timeout between log messages in org.eclipse.persistence.internal.helper.ConcurrencySemaphore#acquireSemaphoreIfAppropriate(boolean) when method/thread tries to get permit for the execution.

public static final String
public static final String
CONNECTION_POOL

Allow configuring a "eclipselink.connection-pool.

public static final String
CONNECTION_POOL_FAILOVER

The "failover" property.

public static final String
CONNECTION_POOL_INITIAL

The "initial" property.

public static final String
CONNECTION_POOL_INTERNALLY_POOL_DATASOURCE

Tell EclipseLink to use it's internal connection pool to pool connections from a datasource.

public static final String
CONNECTION_POOL_JTA_DATA_SOURCE

The "jtaDataSource" property.

public static final String
CONNECTION_POOL_MAX

The "max" property.

public static final String
CONNECTION_POOL_MIN

The "min" property.

public static final String
CONNECTION_POOL_NON_JTA_DATA_SOURCE

The "nonJtaDataSource" property.

public static final String
CONNECTION_POOL_PASSWORD

The "password" property.

public static final String
CONNECTION_POOL_READ

Allow configuring the "eclipselink.connection-pool.read.

public static final String
CONNECTION_POOL_SEQUENCE

Allow configuring the "eclipselink.connection-pool.sequence.

public static final String
CONNECTION_POOL_SHARED

The "shared" property.

public static final String
CONNECTION_POOL_URL

The "url" property.

public static final String
CONNECTION_POOL_USER

The "user" property.

public static final String
CONNECTION_POOL_WAIT

The "wait" property.

public static final String
COORDINATION_ASYNCH

The "eclipselink.cache.coordination.propagate-asynchronously" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_CHANNEL

The "eclipselink.cache.coordination.channel" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_JGROUPS_CONFIG

The "eclipselink.cache.coordination.jgroups.config" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_JMS_FACTORY

The "eclipselink.cache.coordination.jms.factory" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_JMS_HOST

The "eclipselink.cache.coordination.jms.host" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_JMS_REUSE_PUBLISHER

The "eclipselink.cache.coordination.jms.reuse-topic-publisher" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_JMS_TOPIC

The "eclipselink.cache.coordination.jms.topic" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_JNDI_CONTEXT

The "eclipselink.cache.coordination.jndi.initial-context-factory" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_JNDI_PASSWORD

The "eclipselink.cache.coordination.jndi.password" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_JNDI_USER

The "eclipselink.cache.coordination.jndi.user" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_NAMING_SERVICE

The "eclipselink.cache.coordination.naming-service" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_PROTOCOL

The "eclipselink.cache.coordination.protocol" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_REMOVE_CONNECTION

The "eclipselink.cache.coordination.remove-connection-on-error" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_RMI_ANNOUNCEMENT_DELAY

The "eclipselink.cache.coordination.rmi.announcement-delay" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_RMI_MULTICAST_GROUP

The "eclipselink.cache.coordination.rmi.multicast-group" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_RMI_MULTICAST_GROUP_PORT

The "eclipselink.cache.coordination.rmi.multicast-group.port" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_RMI_PACKET_TIME_TO_LIVE

The "eclipselink.cache.coordination.rmi.packet-time-to-live" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_RMI_URL

The "eclipselink.cache.coordination.rmi.url" property configures cache coordination for a clustered environment.

public static final String
COORDINATION_SERIALIZER

The "eclipselink.cache.coordination.serializer" property configures how cache coordination serializes message sent between nodes.

public static final String
COORDINATION_THREAD_POOL_SIZE

The "eclipselink.cache.coordination.thread.pool.size" property configures thread pool size for cache coordination threads.

public static final String
CREATE_JDBC_DDL_FILE

The property "eclipselink.create-ddl-jdbc-file-name" specifies the name of the DDL file which is used to create database tables.

public static final String
CREATE_ONLY

The parameter value "create-tables" specifies that database tables should be created.

public static final String
CREATE_OR_EXTEND

The parameter value "create-or-extend-tables" specifies that database tables should be created and if existing, missing columns will be added.

public static final String
DATABASE_EVENT_LISTENER

The "eclipselink.cache.database-event-listener" property allows integration with a database event notification service.

public static final String
DDL_BOTH_GENERATION

The parameter value "both" specifies that DDL will be written to file(s) and the database.

public static final String
DDL_DATABASE_GENERATION

The parameter value "database" specifies that DDL will be written to the database.

public static final String
DDL_GENERATION

The "eclipselink.ddl-generation" property allows the database schema to be generated on deployment.

public static final String
DDL_GENERATION_INDEX_FOREIGN_KEYS

The "eclipselink.ddl-generation.index-foreign-keys" property specifies if an index should be automatically generated for foreign key constraints.

public static final String
DDL_GENERATION_MODE

The "eclipselink.ddl-generation.output-mode" property specifies if database schema should be generated on the database, to a file, or both.

public static final String
DDL_SQL_SCRIPT_GENERATION

The parameter value "sql-script" specifies that DDL will be written to file(s).

public static final String
DEFAULT

Default Suffix could be appended to some prefixes to form a property name setting the default for the persistence unit.

public static final String
DEFAULT_APP_LOCATION

The default location in the file system to output DDL files.

public static final String
DEFAULT_CREATE_JDBC_FILE_NAME

The default name of the DDL file which is used to create database tables.

public static final String
DEFAULT_DDL_GENERATION_MODE

The eclipselink.ddl-generation.output-mode parameter is configured to the default value of database.

public static final String
DEFAULT_DROP_JDBC_FILE_NAME

The default name of the DDL file which is used to drop database tables.

public static final String
DEPLOY_ON_STARTUP

The "eclipselink.deploy-on-startup" property controls whether EclipseLink creates the persistence unit when the application starts up, or when the persistence unit is first actually accessed by the application.

public static final String
DESCRIPTOR_CUSTOMIZER_

The "eclipselink.descriptor.customizer.

public static final String
DROP_AND_CREATE

The parameter value "drop-and-create-tables" specifies that database tables should be dropped, then created.

public static final String
DROP_JDBC_DDL_FILE

The property "eclipselink.drop-ddl-jdbc-file-name" specifies the name of the DDL file which is used to drop database tables.

public static final String
DROP_ONLY

The parameter value "drop-tables" specifies that database tables should be dropped only.

public static final String
EXCEPTION_HANDLER_CLASS

The "eclipselink.exception-handler" property allows an ExceptionHandler to be specified.

public static final String
EXCLUSIVE_CONNECTION_IS_LAZY

The "eclipselink.jdbc.exclusive-connection.is-lazy" property specifies when write connection is acquired lazily.

public static final String
EXCLUSIVE_CONNECTION_MODE

The "eclipselink.jdbc.exclusive-connection.mode" property specifies when reads are performed through the write connection.

public static final String
FLUSH_CLEAR_CACHE

The "eclipselink.flush-clear.cache" property defines EntityManager cache behavior after a call to flush method followed by a call to clear method.

public static final String
FREE_METADATA

The "eclipselink.memory.free-metadata" property configures the JPA internal deployment metadata to be released after deployment.

public static final String
ID_VALIDATION

The "eclipselink.id-validation" property defines which primary key components values are considered invalid.

public static final String
INCLUDE_DESCRIPTOR_QUERIES

The "eclipselink.session.include.descriptor.queries" property configures whether to enable the copying of all descriptor named queries to the session to be usable from the entity manager.

public static final String
JAVASE_DB_INTERACTION

The system property "INTERACT_WITH_DB" specifies to enable or disable the execution of DDL (configured with the "eclipselink.ddl-generation" property) against a database.

public static final String
JDBC_ALLOW_PARTIAL_PARAMETERS

Property "eclipselink.jdbc.allow-partial-bind-parameters" configures whether partial parameter binding should be allowed in the creation of JDBC prepared statements.

public static final String
JDBC_BIND_PARAMETERS

Property "eclipselink.jdbc.bind-parameters" configures whether parameter binding should be used in the creation of JDBC prepared statements.

public static final String
JDBC_CONNECTIONS_INITIAL

The "eclipselink.jdbc.connections.initial" property EclipseLink JDBC (internal) connection pools properties.

public static final String
JDBC_CONNECTIONS_MAX

The "eclipselink.jdbc.connections.max" property specifies the maximum number of read connection in the internal connection pool.

public static final String
JDBC_CONNECTIONS_MIN

The "eclipselink.jdbc.connections.min" property specifies the minimum number of connections in EclipseLink connection pool.

public static final String
JDBC_CONNECTIONS_WAIT

The "eclipselink.jdbc.connections.wait-timeout" property which specifies the timeout time in milliseconds (ms) that will be waited for an available connection before an exception is thrown.

public static final String
JDBC_CONNECTOR

The "eclipselink.jdbc.connector" property.

public static final String
JDBC_DRIVER

The "jakarta.persistence.jdbc.driver" property specifies the JDBC DriverManager class name used for internal connection pooling when a data source is not being used.

public static final String
JDBC_FORCE_BIND_PARAMETERS

Property "eclipselink.jdbc.force-bind-parameters" enables parameter binding in the creation of JDBC prepared statements.

public static final String
JDBC_PASSWORD

The "jakarta.persistence.jdbc.password" property specifies the data source or JDBC password.

public static final String
JDBC_PROPERTY

The "eclipselink.jdbc.property.

public static final String
JDBC_READ_CONNECTIONS_INITIAL

The "eclipselink.jdbc.read-connections.initial" property configures the number of connections connected at created at startup in the read connection pool.

public static final String
JDBC_READ_CONNECTIONS_MAX

The "eclipselink.jdbc.read-connections.max" property configures the maximum number of connections in the read connection pool.

public static final String
JDBC_READ_CONNECTIONS_MIN

The "eclipselink.jdbc.read-connections.min" property configures the minimum number of connections in read connection pool.

public static final String
JDBC_READ_CONNECTIONS_SHARED

The "eclipselink.jdbc.read-connections.shared" property configures whether connections in EclipseLink read connection pool should be shared (not exclusive).

public static final String
JDBC_RESULT_SET_ACCESS_OPTIMIZATION

The "eclipselink.jdbc.result-set-access-optimization" property allows to set whether a query should by default use ResultSet Access optimization.

public static final String
JDBC_SEQUENCE_CONNECTION_POOL

The "eclipselink.jdbc.sequence-connection-pool" property configures a separate connection pool should used for sequencing to retrieve new value(s).

public static final String
JDBC_SEQUENCE_CONNECTION_POOL_DATASOURCE

The "eclipselink.jdbc.sequence-connection-pool.non-jta-data-source property configures the name of the non-JTA data source that will be used for sequencing calls.

public static final String
JDBC_SEQUENCE_CONNECTION_POOL_INITIAL

The "eclipselink.jdbc.sequence-connection-pool.initial property configures the initial number of connections in sequence connection pool.

public static final String
JDBC_SEQUENCE_CONNECTION_POOL_MAX

The "eclipselink.jdbc.sequence-connection-pool.max" property configures the maximum number of connections in the sequence connection pool.

public static final String
JDBC_SEQUENCE_CONNECTION_POOL_MIN

The "eclipselink.jdbc.sequence-connection-pool.min" property configures the minimum number of connections in sequence connection pool.

public static final String
JDBC_URL

The "jakarta.persistence.jdbc.url" property specifies the JDBC URL used for internal connection pooling when a data source is not being used.

public static final String
JDBC_USER

The "jakarta.persistence.jdbc.user" property specifies the data source or JDBC user name.

public static final String
JDBC_WRITE_CONNECTIONS_INITIAL

The "eclipselink.jdbc.write-connections.initial" property configures the number of connections connected at created at startup in the write connection pool.

public static final String
JDBC_WRITE_CONNECTIONS_MAX

The "eclipselink.jdbc.write-connections.max" property specifies the maximum number of connections supported in the internal write connection pool.

public static final String
JDBC_WRITE_CONNECTIONS_MIN

The "eclipselink.jdbc.write-connections.min" property specifies the minimum number of connections in the internal write connection pool.

public static final String
JOIN_EXISTING_TRANSACTION

The "eclipselink.transaction.join-existing" property set to "true" forces persistence context to read through JTA-managed ("write") connection in case there is an active transaction.

public static final String
JPQL_PARSER

The "eclipselink.jpql.parser" property allows the JPQL parser to be configured.

public static final String
JPQL_TOLERATE

The "eclipselink.tolerate-invalid-jpql" property allows an EntityManager to be created even in the event that an application has invalid JPQL statements declared in annotations or xml.

public static final String
JPQL_VALIDATION

The "eclipselink.jpql.validation" property allows the JPQL parser validation level to be configured.

public static final String
JTA_CONTROLLER

The "eclipselink.jta.controller" property allows to override JTA transaction controller class of ServerPlatform.

public static final String
JTA_DATASOURCE

The "jakarta.persistence.jtaDataSource" property specifies the JTA data source name that will look up a valid javax.sql.DataSource.

public static final String
LOGGING_CONNECTION

Property "eclipselink.logging.connection" indicates if the connection in use should have its identity included in each log message.

public static final String
LOGGING_EXCEPTIONS

Property "eclipselink.logging.exceptions" indicates if exception stack traces should be included in each log message.

public static final String
LOGGING_FILE

The "eclipselink.logging.file" property configures a file location where the log will be output to instead of standard out.

public static final String
LOGGING_LEVEL

The "eclipselink.logging.level" property allows the default logging levels to be specified.

public static final String
LOGGING_LOGGER

The "eclipselink.logging.logger" property specifies the type of logger.

public static final String
LOGGING_PARAMETERS

By default sql bind parameters are displayed in exceptions and logs when the log level is FINE or greater.

public static final String
LOGGING_SESSION

Property "eclipselink.logging.session" indicates if the session in use should have its identity included in each log message.

public static final String
LOGGING_THREAD

Property "eclipselink.logging.thread" indicates if current thread should have its identity included in each log message.

public static final String
LOGGING_TIMESTAMP

The "eclipselink.logging.timestamp" property configures if the current time stamp should be included in each log message.

public static final String
METADATA_SOURCE

The "eclipselink.metadata-source"property configures the type of MetadataSource implementation to use to read Metadata

Allowed Values:

  • "XML" - use org.eclipse.persistence.jpa.metadata.XMLMetadataSource
  • the fully qualified name for a class that implements org.eclipse.persistence.jpa.metadata.MetadataSource interface
public static final String
METADATA_SOURCE_PROPERTIES_FILE

The property "eclipselink.metadata-source.properties.file" specifies the name of the metadata repository properties file to read from using classloader to find the resource.

public static final String
METADATA_SOURCE_RCM_COMMAND

The "eclipselink.metadata-source.send-refresh-command" property works with cache coordination for a clustered environment to.

public static final String
METADATA_SOURCE_XML_FILE

The property "eclipselink.metadata-source.xml.file" specifies the name of the metadata repository xml file to read from using classloader to find the resource

This property should be used in conjunction with the "eclipselink.metadata-repository" when an XML repository is being used.

public static final String
METADATA_SOURCE_XML_URL

The property "eclipselink.metadata-source.xml.URL" specifies the name of the metadata repository xml URL to read from.

public static final String
MULTITENANT_PROPERTY_DEFAULT

The "eclipselink.tenant-id" property specifies the default context property used to populate multitenant entities.

public static final String
MULTITENANT_SCHEMA_PROPERTY_DEFAULT

The "eclipselink.tenant-schema-id" property specifies the context property used to distinguish tenants when using global schema per tenant multitenant strategy.

public static final String
MULTITENANT_SHARED_CACHE

Property "eclipselink.multitenant.tenants-share-cache" specifies that multitenant entities will share the L2 cache.

public static final String
MULTITENANT_SHARED_EMF

Property "eclipselink.multitenant.shared-emf" is used to indicate that multitenant entities will be used within a shared entity manager factory.

public static final String
MULTITENANT_STRATEGY

The "eclipselink.multitenant.strategy" property specifies the global, project wide multitenancy strategy.

public static final String
NAMING_INTO_INDEXED

The "eclipselink.jpa.naming_into_indexed" property defines if stored procedure parameters passed by name should be transformed into positional/index based passing if property value will be true.

public static final String
NATIVE_QUERY_UPPERCASE_COLUMNS

The "eclipselink.jdbc.uppercase-columns" property configures native SQL queries are used, the JDBC meta-data may return column names in lower case on some platforms.

public static final String
NATIVE_SQL

The "eclipselink.jdbc.native-sql" property specifies whether generic SQL should be used or platform specific 'native' SQL.

public static final String
NON_JTA_DATASOURCE

The "jakarta.persistence.nonJtaDataSource" property specifies the non-JTA data source name that will look up a valid javax.sql.DataSource.

public static final String
NONE

The parameter value "none" specifies that database tables should not be created or dropped.

public static final String
NOSQL_CONNECTION_FACTORY

The "eclipselink.nosql.connection-factory" property allows the JCA ConnectionFactory to be specified for a NoSQL or EIS adapter.

public static final String
NOSQL_CONNECTION_SPEC

The "eclipselink.nosql.connection-spec" property allows the connection information for an NoSQL or EIS datasource to be specified.

public static final String
NOSQL_PASSWORD

The "eclipselink.nosql.property.password" property specifies password for NoSQL connection.

public static final String
NOSQL_PROPERTY

The "eclipselink.nosql.property.

public static final String
NOSQL_USER

The "eclipselink.nosql.property.user" property specifies user name for NoSQL connection.

public static final String
ORACLE_PROXY_TYPE

The "eclipselink.oracle.proxy-type" property is used to specify proxy type that should be passed to OracleConnection.openProxySession method.

public static final String
ORDER_UPDATES

The "eclipselink.order-updates" property configures if updates should be ordered by primary key.

public static final String
ORM_SCHEMA_VALIDATION

The "eclipselink.orm.validate.schema" property set on the session is used to override orm.xml schema validation from its default of "false".

public static final String
PARTITIONING

The "eclipselink.partitioning" property specifies the default PartitioningPolicy for a persistence unit.

public static final String
PARTITIONING_CALLBACK

The "eclipselink.partitioning.callback" is used to integrate with an external DataSource's data affinity support, such as UCP.

public static final String
PERSISTENCE_CONTEXT_CLOSE_ON_COMMIT

The "eclipselink.persistence-context.close-on-commit" property specifies that the EntityManager will be closed or not used after commit (not extended).

public static final String
PERSISTENCE_CONTEXT_COMMIT_ORDER

The "eclipselink.persistence-context.commit-order" property defines the ordering of updates and deletes of a set of the same entity type during a commit or flush operation.

public static final String
PERSISTENCE_CONTEXT_COMMIT_WITHOUT_PERSIST_RULES

The "eclipselink.persistence-context.commit-without-persist-rules" property specifies that the EntityManager will search all managed objects and persist any related non-managed new objects that are found ignoring any absence of CascadeType.PERSIST settings.

public static final String
PERSISTENCE_CONTEXT_FLUSH_MODE

The "eclipselink.persistence-context.flush-mode" property configures the EntityManager FlushMode to be set as a persistence property.

public static final String
PERSISTENCE_CONTEXT_PERSIST_ON_COMMIT

The "eclipselink.persistence-context.persist-on-commit" property specifies that the EntityManager will search all managed objects and persist any related non-managed new objects that are cascade persist.

public static final String
PERSISTENCE_CONTEXT_REFERENCE_MODE

The "eclipselink.persistence-context.reference-mode" property configures whether there should be hard or soft references used within the Persistence Context.

public static final String
PESSIMISTIC_LOCK_TIMEOUT

The "jakarta.persistence.lock.timeout" property configures the WAIT timeout used in pessimistic locking, if the database query exceeds the timeout the database will terminate the query and return an exception.

public static final String
PESSIMISTIC_LOCK_TIMEOUT_UNIT

The "eclipselink.pessimistic.lock.timeout.unit" property configures the query timeout unit value.

public static final String
PROFILER

The "eclipselink.profiler" property configures the type of profiler used to capture runtime statistics.

public static final String
PROJECT_CACHE

The "eclipselink.project-cache" property configures the type of org.eclipse.persistence.jpa.metadata.ProjectCache implementation to use to retrieve and store projects representing the metadata for the project.

public static final String
PROJECT_CACHE_FILE

The property "eclipselink.project-cache.java-serialization.file" specifies the name of the file to read/write a serialized project representing the application's metadata

Specifies the name of the metadata repository xml file to read from using classloader to find the resource

This property should be used in conjunction with "eclipselink.project-cache" when a project is serialized to a file for caching.

public static final Map<String, String>
PROPERTY_LOG_OVERRIDES

INTERNAL: The following properties will not be displayed through logging but instead have an alternate value shown in the log.

public static final String
QUERY_CACHE

Property prefix "eclipselink.cache.query-results" used to configure the default option for query results caching.

public static final String
QUERY_RESULTS_CACHE_VALIDATION

This property control (enable/disable) query result cache validation in org.eclipse.persistence.internal.sessions.UnitOfWorkImpl#internalExecuteQuery This can be used to help debugging an object identity problem.

public static final String
QUERY_TIMEOUT

The "jakarta.persistence.query.timeout" property configures the default query timeout value.

public static final String
QUERY_TIMEOUT_UNIT

The "eclipselink.query.timeout.unit" property configures the query timeout unit value.

public static final String
REMOTE_PROTOCOL

The "eclipselink.remote.protocol" property configures remote JPA for a client or server.

public static final String
REMOTE_SERVER_NAME

The "eclipselink.remote.server.name" property configures remote JPA for a server.

public static final String
REMOTE_URL

The "eclipselink.remote.client.url" property configures remote JPA for a client.

public static final String
SCHEMA_DATABASE_MAJOR_VERSION

If sufficient database version information is not included from the JDBC DatabaseMetaData method getDatabaseProductName, the "jakarta.persistence.database-major-version" property should be specified as needed.

public static final String
SCHEMA_DATABASE_MINOR_VERSION

If sufficient database version information is not included from the JDBC DatabaseMetaData method getDatabaseProductName, the "jakarta.persistence.database-minor-version" property should be specified as needed.

public static final String
SCHEMA_DATABASE_PRODUCT_NAME

If scripts are to be generated by the persistence provider and a connection to the target database is not supplied, the "jakarta.persistence.database-product-name" property must be specified.

public static final String
SCHEMA_GENERATION_CONNECTION

The "jakarta.persistence.schema-generation.connection" property specifies the JDBC connection to be used for schema generation.

public static final String
SCHEMA_GENERATION_CREATE_ACTION

The parameter value "create"

For use with the "jakarta.persistence.schema-generation.database.action" and "jakarta.persistence.schema-generation.scripts.action" properties.

public static final String
SCHEMA_GENERATION_CREATE_DATABASE_SCHEMAS

In Java EE environments, it is anticipated that the Java EE platform provider may wish to control the creation of database schemas rather than delegate this task to the persistence provider.

public static final String
SCHEMA_GENERATION_CREATE_SCRIPT_SOURCE

The "jakarta.persistence.schema-generation.create-script-source" is used for script execution.

public static final String
SCHEMA_GENERATION_CREATE_SOURCE

The "jakarta.persistence.schema-generation.create-source" property specifies whether the creation of database artifacts is to occur on the basis of the object/relational mapping metadata, DDL script, or a combination of the two.

public static final String
SCHEMA_GENERATION_DATABASE_ACTION

The "jakarta.persistence.schema-generation.database.action" property specifies the action to be taken by the persistence provider with regard to the database artifacts.

public static final String
SCHEMA_GENERATION_DROP_ACTION

The parameter value "drop"

For use with the "jakarta.persistence.schema-generation.database.action" and "jakarta.persistence.schema-generation.scripts.action" properties.

public static final String
SCHEMA_GENERATION_DROP_AND_CREATE_ACTION

The parameter value "drop-and-create"

For use with the "jakarta.persistence.schema-generation.database.action" and "jakarta.persistence.schema-generation.scripts.action" properties.

public static final String
SCHEMA_GENERATION_DROP_SCRIPT_SOURCE

The "jakarta.persistence.schema-generation.drop-script-source" is used for script execution.

public static final String
SCHEMA_GENERATION_DROP_SOURCE

The "jakarta.persistence.schema-generation.drop-source" property specifies whether the dropping of database artifacts is to occur on the basis of the object/relational mapping metadata, DDL script, or a combination of the two.

public static final String
SCHEMA_GENERATION_METADATA_SOURCE

The parameter value "metadata"

For use with the "jakarta.persistence.schema-generation.create-source" and "jakarta.persistence.schema-generation.drop-source" properties.

public static final String
SCHEMA_GENERATION_METADATA_THEN_SCRIPT_SOURCE

The parameter value "metadata-then-script"

For use with the "jakarta.persistence.schema-generation.create-source" and "jakarta.persistence.schema-generation.drop-source" properties.

public static final String
SCHEMA_GENERATION_NONE_ACTION

The parameter value "none"

For use with the "jakarta.persistence.schema-generation.database.action" and "jakarta.persistence.schema-generation.scripts.action" properties.

public static final String
SCHEMA_GENERATION_SCRIPT_SOURCE

The parameter value "script"

For use with the "jakarta.persistence.schema-generation.create-source" and "jakarta.persistence.schema-generation.drop-source" properties.

public static final String
SCHEMA_GENERATION_SCRIPT_TERMINATE_STATEMENTS

When the "eclipselink.ddlgen-terminate-statements" property is set to true and a DDL script is being generated, the value of DatabasePlatform#getStoredProcedureTerminationToken() is appended to the end of each statement.

public static final String
SCHEMA_GENERATION_SCRIPT_THEN_METADATA_SOURCE

The parameter value "script-then-metadata"

For use with the "jakarta.persistence.schema-generation.create-source" and "jakarta.persistence.schema-generation.drop-source" properties.

public static final String
SCHEMA_GENERATION_SCRIPTS_ACTION

The "jakarta.persistence.schema-generation.scripts.action" property specifies which scripts are to be generated by the persistence provider.

public static final String
SCHEMA_GENERATION_SCRIPTS_CREATE_TARGET

If scripts are to be generated, the target locations for the writing of these scripts must be specified.

public static final String
SCHEMA_GENERATION_SCRIPTS_DROP_TARGET

If scripts are to be generated, the target locations for the writing of these scripts must be specified.

public static final String
SCHEMA_GENERATION_SQL_LOAD_SCRIPT_SOURCE

In Java EE container environments, it is generally expected that the container will be responsible for executing data load scripts, although the container is permitted to delegate this task to the persistence provider.

public static final String
SEQUENCING_SEQUENCE_DEFAULT

The "eclipselink.sequencing.default-sequence-to-table" property determines the default behavior when a GeneratedValue of type SEQUENCE is used on a database platform that does not support SEQUENCE generation.

public static final String
SEQUENCING_START_AT_NEXTVAL

By default, EclipseLink generates sequence values at (NEXTVAL - allocationSize).

public static final String
SERIALIZER

The "eclipselink.serializer" property specifies class name for session serializer (must implement org.eclipse.persistence.sessions.serializers.Serializer)

Default value is "org.eclipse.persistence.sessions.serializers.JavaSerializer"

public static final String
SESSION_CUSTOMIZER

The "eclipselink.session.customizer" property configures a SessionCustomizer used to alter the runtime configuration through API.

public static final String
SESSION_EVENT_LISTENER_CLASS

The "eclipselink.session-event-listener" property configures a session event listener class.

public static final String
SESSION_NAME

The "eclipselink.session-name" property configures a specific name to use when storing the singleton server session within the SessionManager.

public static final String
SESSIONS_XML

The "eclipselink.sessions-xml" property configures the use of the specified native sessions.xml configuration file.

public static final String
SHARED_CACHE_MODE

The "jakarta.persistence.sharedCache.mode" property determines whether second-level caching is in effect for the persistence unit.

public static final String
SQL_CALL_DEFERRAL

The "eclipselink.jpa.sqlcall.deferral.default" property defines if SQL calls should be deferred to end of transaction by default or not.

public static final String
SQL_CAST

The "eclipselink.jdbc.sql-cast" property specifies if platform specific CAST SQL operations should be used.

private static final Set<String>
supportedNonServerSessionProperties

INTERNAL: The following properties passed to Persistence#createEntityManagerFactory(String, Map) cached and processed on the EntityManagerFactory directly.

public static final String
TABLE_CREATION_SUFFIX

The "eclipselink.ddl.table-creation-suffix" property is used in conjunction with DDL generation options to append a string to the end of generated CREATE Table statements.

public static final String
TARGET_DATABASE

The "eclipselink.target-database" property configures the database that will be used controlling custom operations and SQL generation for the specified database.

public static final String
TARGET_DATABASE_PROPERTIES

The "eclipselink.target-database-properties" property configures additional properties for the configured target-database.

public static final String
TARGET_SERVER

The "eclipselink.target-server" property configures the ServerPlatform that will be used to enable integration with a host container.

public static final String
TEMPORAL_MUTABLE

The "eclipselink.temporal.mutable" property configures the default for detecting changes to temporal field (Date, Calendar).

public static final String
THREAD_EXTENDED_LOGGING

The "eclipselink.thread.extended.logging" property control (enable/disable) some additional logging messages like print error message if cached Entity is picked by different thread, or if EntityManager/UnitOfWork is reused/passed to different thread.

public static final String
THREAD_EXTENDED_LOGGING_THREADDUMP

The "eclipselink.thread.extended.logging.threaddump" property control (enable/disable) store and display thread dump.

public static final String
THROW_EXCEPTIONS

The "eclipselink.orm.throw.exceptions" property specifies if the first exception that occurs during deployment should be thrown, or if all exceptions should be caught and summary thrown at end of deployment attempt.

public static final String
TRANSACTION_TYPE

The "jakarta.persistence.transactionType" property specifies the transaction type for the persistence unit.

public static final String
TUNING

The "eclipselink.tuning"property configures the type of tuner to use to configure the persistence unit.

public static final String
UPPERCASE_COLUMN_NAMES

The "eclipselink.jpa.uppercase-column-names" property configures JPA processing to uppercase all column name definitions.

public static final String
USE_LOCAL_TIMESTAMP

The "eclipselink.locking.timestamp.local" property defines if locking policies should default to local time(true) or server time(false).

public static final String
VALIDATE_EXISTENCE

The "eclipselink.validate-existence" property configures if the existence of an object should be verified on persist(), otherwise it will assume to be new if not in the persistence context.

public static final String
VALIDATION_GROUP_PRE_PERSIST

The "jakarta.persistence.validation.group.pre-persist" property specifies the name of the validator groups to execute for preUpdate event.

public static final String
VALIDATION_GROUP_PRE_REMOVE

The "jakarta.persistence.validation.group.pre-remove" property specifies the name of the validator groups to execute for preRemove event.

public static final String
VALIDATION_GROUP_PRE_UPDATE

The "jakarta.persistence.validation.group.pre-update" property specifies the name of the validator groups to execute for preUpdate event.

public static final String
VALIDATION_MODE

The "jakarta.persistence.validation.mode" property specifies whether the automatic lifecycle event validation is in effect.

public static final String
VALIDATION_ONLY_PROPERTY

The "eclipselink.validation-only" property validates deployment which includes initializing descriptors but does not connect (no login to the database).

public static final String
VALIDATOR_FACTORY

The "jakarta.persistence.validation.factory" property specifies an instance of jakarta.validation.ValidatorFactory used by EclipseLink to perform Automatic Validation upon Lifecycle Events.

public static final String
WEAVING

The "eclipselink.weaving" property configures whether weaving should be performed.

public static final String
WEAVING_CHANGE_TRACKING

The "eclipselink.weaving.changetracking" property configures whether AttributeLevelChangeTracking should be enabled through weaving.

public static final String
WEAVING_EAGER

The "eclipselink.weaving.eager" property configures whether EAGER mapping's attributes should be woven to use indirection.

public static final String
WEAVING_FETCHGROUPS

The "eclipselink.weaving.fetchgroups" property configures whether FetchGroup support should be enabled through weaving.

public static final String
WEAVING_INTERNAL

The "eclipselink.weaving.internal" property indicates whether internal optimizations should be enabled through weaving.

public static final String
WEAVING_LAZY

The "eclipselink.weaving.lazy" property configures whether LAZY OneToOne and ManyToOne mappings should be enabled through weaving.

public static final String
WEAVING_MAPPEDSUPERCLASS

The "eclipselink.weaving.mappedsuperclass" property configures whether MappedSuperclasses with no direct sub-classes will be woven.

public static final String
WEAVING_REST

The "eclipselink.weaving.rest" property configures whether classes will be woven to support EclipseLink JPA_RS functionality

This property will only be considered if weaving is enabled.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static String

Returns:

the overridden log string
getOverriddenLogStringForProperty
(String
property which value should be overriden in the log
propertyName
)

INTERNAL: Return the overridden log string.

public static Set<String>
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait