org.eclipse.persistence.config
Class PersistenceUnitProperties

java.lang.Object
  org.eclipse.persistence.config.PersistenceUnitProperties

public class PersistenceUnitProperties
extends java.lang.Object

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 props = new HashMap();

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

static java.lang.String	ALLOW_ZERO_ID The "eclipselink.allow-zero-id" property configures if zero is considered a valid id on a new entity.
static java.lang.String	APP_LOCATION
static java.lang.String	BATCH_WRITING The "eclipselink.jdbc.batch-writing" property configures the use of batch writing to optimize transactions with multiple writes.
static java.lang.String	BATCH_WRITING_SIZE The "eclipselink.jdbc.batch-writing.size" property configures the batch size used for batch writing.
static java.lang.String	CACHE_SHARED_ Indicates whether entity's cache should be shared (non-isolated).
static java.lang.String	CACHE_SHARED_DEFAULT Default caching properties - apply to all entities.
static java.lang.String	CACHE_SIZE_ Property prefix "eclipselink.cache.size.
static java.lang.String	CACHE_SIZE_DEFAULT Default caching properties - apply to all entities.
static java.lang.String	CACHE_STATEMENTS The "eclipselink.jdbc.cache-statements" property specifies whether JDBC statements should be cached.
static java.lang.String	CACHE_STATEMENTS_SIZE The "eclipselink.jdbc.cache-statements.size" property specifies the number of statements held when using internal statement caching.
static java.lang.String	CACHE_TYPE_ All valid values for CACHE_TYPE_ properties are declared in CacheType class.
static java.lang.String	CACHE_TYPE_DEFAULT Default caching properties - apply to all entities.
static java.lang.String	CATEGORY_LOGGING_LEVEL_ Property prefix "eclipselink.logging.level.
static java.lang.String	CLASSLOADER Specify the classloader to use to create an EntityManagerFactory in the property map passed to Persistence.createEntityManagerFactory.
static java.lang.String	COORDINATION_ASYNCH the "eclipselink.cache.coordination.propagate-asynchronously" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_CHANNEL the "eclipselink.cache.coordination.channel" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_JMS_FACTORY The "eclipselink.cache.coordination.jms.factory" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_JMS_HOST The "eclipselink.cache.coordination.jms.host" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_JMS_TOPIC The "eclipselink.cache.coordination.jms.topic" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_JNDI_CONTEXT The "eclipselink.cache.coordination.jndi.initial-context-factory" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_JNDI_PASSWORD The "eclipselink.cache.coordination.jndi.password" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_JNDI_USER the "eclipselink.cache.coordination.jndi.user" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_NAMING_SERVICE The "eclipselink.cache.coordination.naming-service" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_PROTOCOL The "eclipselink.cache.coordination.protocol" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_REMOVE_CONNECTION The "eclipselink.cache.coordination.remove-connection-on-error" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_RMI_ANNOUNCEMENT_DELAY The "eclipselink.cache.coordination.rmi.announcement-delay" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_RMI_MULTICAST_GROUP The "eclipselink.cache.coordination.rmi.multicast-group" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_RMI_MULTICAST_GROUP_PORT The "eclipselink.cache.coordination.rmi.multicast-group.port" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_RMI_PACKET_TIME_TO_LIVE The "eclipselink.cache.coordination.rmi.packet-time-to-live" property configures cache coordination for a clustered environment.
static java.lang.String	COORDINATION_RMI_URL The "eclipselink.cache.coordination.rmi.url" property configures cache coordination for a clustered environment.
static java.lang.String	CREATE_JDBC_DDL_FILE
static java.lang.String	CREATE_ONLY
static java.lang.String	DDL_BOTH_GENERATION
static java.lang.String	DDL_DATABASE_GENERATION
static java.lang.String	DDL_GENERATION Allows the database schema to be generated on deployment.
static java.lang.String	DDL_GENERATION_MODE Configures if database schema should be generated on the database, to a file, or both.
static java.lang.String	DDL_SQL_SCRIPT_GENERATION
static java.lang.String	DEFAULT Default Suffix could be appended to some prefixes to form a property name setting the default for the persistence unit.
static java.lang.String	DEFAULT_APP_LOCATION
static java.lang.String	DEFAULT_CREATE_JDBC_FILE_NAME
static java.lang.String	DEFAULT_DDL_GENERATION_MODE
static java.lang.String	DEFAULT_DROP_JDBC_FILE_NAME
static java.lang.String	DESCRIPTOR_CUSTOMIZER_ The "eclipselink.descriptor.customizer."
static java.lang.String	DROP_AND_CREATE
static java.lang.String	DROP_JDBC_DDL_FILE
static java.lang.String	ECLIPSELINK_PERSISTENCE_UNITS This "eclipselink.persistenceunits" property specifies the set of persistence unit names that will be processed when generating the canonical model.
static java.lang.String	ECLIPSELINK_PERSISTENCE_XML The "eclipselink.persistencexml" property specifies the full resource name to look for the persistence XML files in.
static java.lang.String	ECLIPSELINK_PERSISTENCE_XML_DEFAULT The default resource location used to locate the persistence.xml configuration files.
static java.lang.String	EXCEPTION_HANDLER_CLASS The "eclipselink.exception-handler" property allows an ExceptionHandler to be specified.
static java.lang.String	EXCLUDE_ECLIPSELINK_ORM_FILE The "eclipselink.exclude-eclipselink-orm" property configures the exclusion of an EclipseLink ORM mapping file for a specific persistence unit.
static java.lang.String	EXCLUSIVE_CONNECTION_IS_LAZY The "eclipselink.jdbc.exclusive-connection.is-lazy" property specifies when write connection is acquired lazily.
static java.lang.String	EXCLUSIVE_CONNECTION_MODE The "eclipselink.jdbc.exclusive-connection.mode" property specifies when reads are performed through the write connection.
static java.lang.String	FLUSH_CLEAR_CACHE Defines EntityManager cache behavior after a call to flush method followed by a call to clear method.
static java.lang.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.
static java.lang.String	JAVASE_DB_INTERACTION
static java.lang.String	JDBC_BIND_PARAMETERS Property "eclipselink.jdbc.bind-parameters configures whether parameter binding will be used in the creation of JDBC prepared statements.
static java.lang.String	JDBC_CONNECTIONS_INITIAL The "eclipselink.jdbc.connections.initial" property EclipseLink JDBC (internal) connection pools properties.
static java.lang.String	JDBC_CONNECTIONS_MAX The "eclipselink.jdbc.connections.max" property specifies the maximum number of read connection in the internal connection pool.
static java.lang.String	JDBC_CONNECTIONS_MIN The "eclipselink.jdbc.connections.min" property specifies the minimum number of connections in EclipseLink connection pool.
static java.lang.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.
static java.lang.String	JDBC_DRIVER The javax.persistence.jdbc.driver" property specifies the JDBC DriverManager class name used for internal connection pooling when a data source is not being used.
static java.lang.String	JDBC_PASSWORD The javax.persistence.jdbc.password" property specifies the data source or JDBC password.
static java.lang.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.
static java.lang.String	JDBC_READ_CONNECTIONS_MAX The "eclipselink.jdbc.read-connections.max" property configures the maximum number of connections in the read connection pool.
static java.lang.String	JDBC_READ_CONNECTIONS_MIN The "eclipselink.jdbc.read-connections.min" property configures the minimum number of connections in read connection pool.
static java.lang.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).
static java.lang.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).
static java.lang.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.
static java.lang.String	JDBC_SEQUENCE_CONNECTION_POOL_INITIAL The "eclipselink.jdbc.sequence-connection-pool.initial property configures the initial number of connections in sequence connection pool.
static java.lang.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.
static java.lang.String	JDBC_SEQUENCE_CONNECTION_POOL_MIN The "eclipselink.jdbc.sequence-connection-pool.min" property configures the minimum number of connections in sequence connection pool.
static java.lang.String	JDBC_URL The javax.persistence.jdbc.url" property specifies the JDBC URL used for internal connection pooling when a data source is not being used.
static java.lang.String	JDBC_USER The javax.persistence.jdbc.user" property specifies the data source or JDBC user name.
static java.lang.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.
static java.lang.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.
static java.lang.String	JDBC_WRITE_CONNECTIONS_MIN The "eclipselink.jdbc.write-connections.min" property specifies the minimum number of connections in the internal write connection pool.
static java.lang.String	JOIN_EXISTING_TRANSACTION The "eclipselink.transaction.join-existing" property Set to "true" this property forces persistence context to read through JTA-managed ("write") connection in case there is an active transaction.The property set in persistence.xml or passed to createEntityManagerFactory affects all EntityManagers created by the factory.
static java.lang.String	JTA_DATASOURCE The javax.persistence.jtaDataSource" property specifies the JTA data source name that will look up a valid DataSource.
static java.lang.String	LOGGING_CONNECTION Property: "eclipselink.logging.connection" Values: "true" (Default) "false"
static java.lang.String	LOGGING_EXCEPTIONS Values: "true" (Default) "false"
static java.lang.String	LOGGING_FILE The "eclipselink.logging.file" property configures a file location where the log will be output to instead of standard out.
static java.lang.String	LOGGING_LEVEL Property "eclipselink.logging.level allows the default logging levels to be specified.
static java.lang.String	LOGGING_LOGGER The type of logger.
static java.lang.String	LOGGING_SESSION Property "eclipselink.logging.session" indicating if the session in use should have its identity included in each log message.
static java.lang.String	LOGGING_THREAD Property "eclipselink.logging.thread" indicating if current thread should have its identity included in each log message.
static java.lang.String	LOGGING_TIMESTAMP The "eclipselink.logging.timestamp" property configures if the current timestamp should be included in each log message.
static java.lang.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.
static java.lang.String	NATIVE_SQL The "eclipselink.jdbc.native-sql" property specifies whether generic SQL should be used or platform specific 'native' SQL.
static java.lang.String	NON_JTA_DATASOURCE The javax.persistence.nonJtaDataSource" property specifies the non-JTA data source name that will look up a valid DataSource.
static java.lang.String	NONE
static java.lang.String	ORACLE_PROXY_TYPE The "eclipselink.oracle.proxy-type" property is used to specify proxy type that should be passed to OracleConnection.openProxySession method.
static java.lang.String	ORM_SCHEMA_VALIDATION This property set on the session is used to override orm.xml schema validation from its default of false.
static java.lang.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).
static java.lang.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.
static java.lang.String	PERSISTENCE_CONTEXT_FLUSH_MODE The "eclipselink.persistence-context.flush-mode property configures the EntityManager FlushMode to be set as a persistence property.
static java.lang.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.
static java.lang.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.
static java.lang.String	PESSIMISTIC_LOCK_TIMEOUT The "javax.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.
static java.lang.String	PROFILER The "eclipselink.profiler"property configures the type of profiler used to capture runtime statistics.
static java.util.Map<java.lang.String,java.lang.String>	PROPERTY_LOG_OVERRIDES INTERNAL: The following properties will not be displayed through logging but instead have an alternate value shown in the log.
static java.lang.String	QUERY_TIMEOUT The "javax.persistence.query.timeout" property configures the default query timeout value.
static java.lang.String	SESSION_CUSTOMIZER The "eclipselink.session.customizer" property configures a SessionCustomizer used to alter the runtime configuration through API.
static java.lang.String	SESSION_EVENT_LISTENER_CLASS The "eclipselink.session-event-listener" property configures a session event listener class.
static java.lang.String	SESSION_NAME The "eclipselink.session-name" property configures a specific name to use when storing the singleton server session within the SessionManager.
static java.lang.String	SESSIONS_XML The "eclipselink.sessions-xml" property configures the use of the specified native sessions.xml configuration file.
static java.lang.String	SQL_CAST The "eclipselink.jdbc.sql-cast" property specifies is platform specific CAST SQL operations should be used.
static java.lang.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.
static java.lang.String	TARGET_SERVER The "eclipselink.target-server" property configures the ServerPlatform that will be used to enable integration with a host container.
static java.lang.String	TEMPORAL_MUTABLE The "eclipselink.temporal.mutable" property configures the default for detecting changes to temporal field (Date, Calendar).
static java.lang.String	THROW_EXCEPTIONS Configures 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.
static java.lang.String	TRANSACTION_TYPE The javax.persistence.transactionType" property specifies the transaction type for the persistence unit.
static java.lang.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.
static java.lang.String	VALIDATION_GROUP_PRE_PERSIST The "javax.persistence.validation.group.pre-persist" property specifies the name of the validator groups to execute for preUpdate event.
static java.lang.String	VALIDATION_GROUP_PRE_REMOVE The "javax.persistence.validation.group.pre-remove" property specifies the name of the validator groups to execute for preRemove event.
static java.lang.String	VALIDATION_GROUP_PRE_UPDATE The "javax.persistence.validation.group.pre-update" property specifies the name of the validator groups to execute for preUpdate event.
static java.lang.String	VALIDATION_MODE The "javax.persistence.validation.mode" property specifies whether the automatic lifecycle event validation is in effect.
static java.lang.String	VALIDATION_ONLY_PROPERTY Validate deployment, but do not connect.
static java.lang.String	VALIDATOR_FACTORY The "javax.persistence.validation.factory" property specifies an instance of javax.validation.ValidatorFactory used by EclipseLink to perform Automatic Validation upon Lifecycle Events.
static java.lang.String	WEAVING The "eclipselink.weaving" property configures whether weaving should be performed.
static java.lang.String	WEAVING_CHANGE_TRACKING The "eclipselink.weaving.changetracking" property configures whether AttributeLevelChangeTracking should be enabled through weaving.
static java.lang.String	WEAVING_EAGER The "eclipselink.weaving.eager" property configures whether EAGER mapping's attributes should be woven to use indirection.
static java.lang.String	WEAVING_FETCHGROUPS The "eclipselink.weaving.fetchgroups" property configures whether FetchGroup support should be enabled through weaving.
static java.lang.String	WEAVING_INTERNAL The "eclipselink.weaving.internal" property indicates whether internal optimizations should be enabled through weaving.
static java.lang.String	WEAVING_LAZY The "eclipselink.weaving.lazy" property configures whether LAZY OneToOne and ManyToOne mappings should be enabled through weaving.

Constructor Summary

PersistenceUnitProperties()

Method Summary

static java.lang.String	getOverriddenLogStringForProperty(java.lang.String propertyName) INTERNAL: Return the overridden log string.
static java.util.Set<java.lang.String>	getSupportedNonServerSessionProperties()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TRANSACTION_TYPE

public static final java.lang.String TRANSACTION_TYPE

The javax.persistence.transactionType" property specifies the transaction type for the persistence unit. This property overrides the value specified in the persistence.xml.

Values: A string value of "JTA" or "RESOURCE_LOCAL"

See Also:

Constant Field Values

JTA_DATASOURCE

public static final java.lang.String JTA_DATASOURCE

The javax.persistence.jtaDataSource" property specifies the JTA data source name that will look up a valid DataSource. This property is used to override the value specified in the persistence.xml.

Values: A well formed JNDI resource name that can locate the data source in the target container or an instance of DataSource

See Also:

Constant Field Values

NON_JTA_DATASOURCE

public static final java.lang.String NON_JTA_DATASOURCE

The javax.persistence.nonJtaDataSource" property specifies the non-JTA data source name that will look up a valid DataSource. This can be used to override the value specified in the persistence.xml.

Values: A well formed JNDI resource name that can locate the data source in the target container or an instance of DataSource

See Also:

Constant Field Values

JDBC_DRIVER

public static final java.lang.String JDBC_DRIVER

The javax.persistence.jdbc.driver" property specifies the JDBC DriverManager class name used for internal connection pooling when a data source is not being used. The value must be a string which is the qualified class name for a valid class that implements java.sql.Driver.

Persistence XML example:

The previous value for this property "eclipselink.jdbc.driver is now deprecated and should be replaced with this new name.

See Also:

Constant Field Values

JDBC_URL

public static final java.lang.String JDBC_URL

The javax.persistence.jdbc.url" property specifies the JDBC URL used for internal connection pooling when a data source is not being used. The value must be a string which represents a valid URL for the specified JDBC driver.

Persistence XML example:

The previous value for this property "eclipselink.jdbc.url is now deprecated and should be replaced with this new name.

See Also:

Constant Field Values

JDBC_USER

public static final java.lang.String JDBC_USER

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

Persistence XML example:

The previous value for this property "eclipselink.jdbc.user is now deprecated and should be replaced with this new name.

See Also:

Constant Field Values

JDBC_PASSWORD

public static final java.lang.String JDBC_PASSWORD

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

Persistence XML example: The previous value for this property "eclipselink.jdbc.password is now deprecated and should be replaced with this new name.

See Also:

Constant Field Values

NATIVE_SQL

public static final java.lang.String NATIVE_SQL

The "eclipselink.jdbc.native-sql" property specifies whether generic SQL should be used or platform specific 'native' SQL. The platform specific SQL customizes join syntax, date operators, sequencing, ...

Allowed Values (String):

• "true" - use database specific SQL
• "false" (DEFAULT) - use generic SQL

See Also:

DatabaseLogin.setUsesNativeSQL(boolean), Constant Field Values

SQL_CAST

public static final java.lang.String SQL_CAST

The "eclipselink.jdbc.sql-cast" property specifies is platform specific CAST SQL operations should be used. Casting is normally not required, and can cause issue when used. Allowed Values (String):

• "true" - enable platform specific cast
• "false" (DEFAULT) - disable platform specific cast

See Also:

DatabasePlatform.setIsCastRequired(boolean), Constant Field Values

JDBC_CONNECTIONS_WAIT

public static final java.lang.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. Ignored in case external connection pools are used.

Default: 180000 ms (3 minutes).

The value specified should be a string containing a positive integer value. A value of 0 means wait forever.

See Also:

Constant Field Values

JDBC_CONNECTIONS_MAX

public static final java.lang.String JDBC_CONNECTIONS_MAX

The "eclipselink.jdbc.connections.max" property specifies the maximum number of read connection in the internal connection pool. If the maximum size is reached, threads requiring a connection will wait until one is released back to the pool. By default a single shared (exclusive) read/write pool is used with min/max 32 connections and 1 initial. Ignored in case external connection pools are used.

The value specified should be a string containing a positive integer value.

See Also:

Constant Field Values

JDBC_CONNECTIONS_MIN

public static final java.lang.String JDBC_CONNECTIONS_MIN

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

Ignored in case external connection pools are used. Connections beyond the minimum will be disconnected when returned to the pool, so this should normally be equal to the number of active threads, or server's thread pool size. By default a single shared (exclusive) read/write pool is used with min/max 32 connections and 1 initial.

The value specified should be a string containing a positive integer value.

See Also:

Constant Field Values

JDBC_CONNECTIONS_INITIAL

public static final java.lang.String JDBC_CONNECTIONS_INITIAL

The "eclipselink.jdbc.connections.initial" property EclipseLink JDBC (internal) connection pools properties. Initial number of connections in EclipseLink connection pool. This is the number of connections connected at startup. By default a single shared (exclusive) read/write pool is used with min/max 32 connections and 1 initial.Ignored in case external connection pools are used.

The value specified should be a string containing a positive integer value.

See Also:

Constant Field Values

JDBC_WRITE_CONNECTIONS_MAX

public static final java.lang.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. Maximum number of connections in EclipseLink write connection pool. If the maximum size is reached, threads requiring a connection will wait until one is released back to the pool. By default a single shared (exclusive) read/write pool is used with min/max 32 connections and 1 initial.Ignored in case external connection pools are used.

The value specified should be a string containing a positive integer value.

See Also:

Constant Field Values

JDBC_WRITE_CONNECTIONS_MIN

public static final java.lang.String JDBC_WRITE_CONNECTIONS_MIN

The "eclipselink.jdbc.write-connections.min" property specifies the minimum number of connections in the internal write connection pool. Connections beyond the minimum will be disconnected when returned to the pool, so this should normally be equal to the number of active threads, or server's thread pool size. By default a single shared (exclusive) read/write pool is used with min/max 32 connections and 1 initial. Ignored in case external connection pools are used.

The value specified should be a string containing a positive integer value.

See Also:

Constant Field Values

JDBC_WRITE_CONNECTIONS_INITIAL

public static final java.lang.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. By default a single shared (exclusive) read/write pool is used with min/max 32 connections and 1 initial.

This property is ignored in case external connection pools are used. Initial number of connections in EclipseLink write connection pool.

The value must be a string containing a zero or greater integer value.

See Also:

Constant Field Values

JDBC_READ_CONNECTIONS_MAX

public static final java.lang.String JDBC_READ_CONNECTIONS_MAX

The "eclipselink.jdbc.read-connections.max" property configures the maximum number of connections in the read connection pool. If the maximum size is reached, threads requiring a connection will wait until one is released back to the pool (unless shared). By default a separate read connection pool is not used. By default a single shared (exclusive) read/write pool is used with min/max 32 connections and 1 initial.

This property is ignored in case external connection pools are used. Initial number of connections in EclipseLink write connection pool.

The value specified should be a string containing a zero or greater integer value.

See Also:

to configure the timeout waiting on a connection., Constant Field Values

JDBC_READ_CONNECTIONS_MIN

public static final java.lang.String JDBC_READ_CONNECTIONS_MIN

The "eclipselink.jdbc.read-connections.min" property configures the minimum number of connections in read connection pool. Connections beyond the minimum will be disconnected when returned to the pool, so this should normally be equal to the number of active threads, or server's thread pool size. By default a separate read connection pool is not used. By default a single shared (exclusive) read/write pool is used with min/max 32 connections and 1 initial.

This property is ignored in case external connection pools are used. Initial number of connections in EclipseLink write connection pool.

The value specified should be a string containing a zero or greater integer value.

See Also:

Constant Field Values

JDBC_READ_CONNECTIONS_INITIAL

public static final java.lang.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. By default a single shared (exclusive) read/write pool is used with min/max 32 connections and 1 initial.

This property is ignored in case external connection pools are used. Initial number of connections in EclipseLink write connection pool.

The value must be a string containing a zero or greater integer value.

See Also:

Constant Field Values

JDBC_READ_CONNECTIONS_SHARED

public static final java.lang.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). Connection sharing means the same JDBC connection will be used concurrently for multiple reading threads.

This property is ignored in case external connection pools are used. Initial number of connections in EclipseLink write connection pool.

Values (case insensitive):

"false" (DEFAULT): indicates read connections will not be shared
• "true": indicates read connections can be shared

See Also:

Constant Field Values

JDBC_SEQUENCE_CONNECTION_POOL_MAX

public static final java.lang.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. If the maximum size is reached, threads requiring a connection will wait until one is released back to the pool.

By default a separate sequence connection pool is not used (the sequence is allocated on the write connection).

This property is ignored in case external connection pools are used. Initial number of connections in EclipseLink write connection pool.

The value must be a string containing a zero or greater integer value. The default value is two (2).

See Also:

Required to configure the use of a sequence pool/data-source, to configure the timeout, Constant Field Values

JDBC_SEQUENCE_CONNECTION_POOL_MIN

public static final java.lang.String JDBC_SEQUENCE_CONNECTION_POOL_MIN

The "eclipselink.jdbc.sequence-connection-pool.min" property configures the minimum number of connections in sequence connection pool. Connections beyond the minimum will be disconnected when returned to the pool, so this should normally be equal to the maximum to avoid connecting/disconnecting.

By default a separate sequence connection pool is not used (the sequence is allocated on the write connection).

This property is ignored in case external connection pools are used. Initial number of connections in EclipseLink write connection pool.

The value must be a string containing a zero or greater integer value. The default value is two (2).

See Also:

Required to configure the use of a sequence pool/data-source, Constant Field Values

JDBC_SEQUENCE_CONNECTION_POOL_INITIAL

public static final java.lang.String JDBC_SEQUENCE_CONNECTION_POOL_INITIAL

The "eclipselink.jdbc.sequence-connection-pool.initial property configures the initial number of connections in sequence connection pool. This is the number of connections connected at startup.

By default a separate sequence connection pool is not used (the sequence is allocated on the write connection).

This property is ignored in case external connection pools are used. Initial number of connections in EclipseLink write connection pool.

The value must be a string containing a zero or greater integer value. The default value is two (2).

See Also:

Required to configure the use of a sequence pool/data-source, Constant Field Values

JDBC_SEQUENCE_CONNECTION_POOL

public static final java.lang.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). This improves sequence allocation by allocating sequencing outside the current transaction. This can be used with internal or external (DataSource) connection pooling, external must provide a non-jta-datasource resource name using JDBC_SEQUENCE_CONNECTION_POOL_DATASOURCE. A sequence connection pool is generally only used with using TABLE sequencing to minimize contention on the sequence table(s).

Values (case-insensitive):

• "false" (DEFAULT):
• "true":

See Also:

to configure the use of a non-JTA data source for sequence allocation call., to configure the initial connections size for internal connection pooling, to configure the minimum connections size for internal connection pooling, to configure the maximum connections size for internal connection pooling, Constant Field Values

JDBC_SEQUENCE_CONNECTION_POOL_DATASOURCE

public static final java.lang.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.

See Also:

JDBC_SEQUENCE_CONNECTION_POOL, Constant Field Values

JDBC_BIND_PARAMETERS

public static final java.lang.String JDBC_BIND_PARAMETERS

Property "eclipselink.jdbc.bind-parameters configures whether parameter binding will be used in the creation of JDBC prepared statements. Usage of parameter binding is generally a performance optimization allowing for SQL and prepared statement caching as well as usage of batch writing.

Values:

• "true" (DEFAULT): binding will be used
• "false": values will be written literally into the generated SQL

See Also:

Constant Field Values

EXCLUSIVE_CONNECTION_MODE

public static final java.lang.String EXCLUSIVE_CONNECTION_MODE

The "eclipselink.jdbc.exclusive-connection.mode" property specifies when reads are performed through the write connection. You can set this property while creating either an EntityManagerFactory (either in the map passed to the createEntityManagerFactory method, or in the persistence.xml file), or an EntityManager (in the map passed to the createEntityManager method). Note that the latter overrides the former.

Values:

• "Transactional" (DEFAULT): ExclusiveConnectionMode.Transactional
• "Isolated" - ExclusiveConnectionMode.Isolated
• "Always" - ExclusiveConnectionMode.Always

See Also:

ExclusiveConnectionMode, Constant Field Values

EXCLUSIVE_CONNECTION_IS_LAZY

public static final java.lang.String EXCLUSIVE_CONNECTION_IS_LAZY

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

Values:

• "false"
• "true" (DEFAULT)

See Also:

Constant Field Values

CACHE_STATEMENTS_SIZE

public static final java.lang.String CACHE_STATEMENTS_SIZE

The "eclipselink.jdbc.cache-statements.size" property specifies the number of statements held when using internal statement caching. The value must be a string value containing a positive integer or zero.

Default: "50".

See Also:

Constant Field Values

CACHE_STATEMENTS

public static final java.lang.String CACHE_STATEMENTS

The "eclipselink.jdbc.cache-statements" property specifies whether JDBC statements should be cached. This is recommended when using EclipseLink's internal connection pooling.

Valid values:

• true � enable internal statement caching.
• false � disable internal statement caching. (DEFAULT)

Example: persistence.xml file Example: property Map propertiesMap.put(PersistenceUnitProperties.CACHE_STATEMENTS, "false");

See Also:

Constant Field Values

VALIDATOR_FACTORY

public static final java.lang.String VALIDATOR_FACTORY

The "javax.persistence.validation.factory" property specifies an instance of javax.validation.ValidatorFactory used by EclipseLink to perform Automatic Validation upon Lifecycle Events. If the propoerty is not specified, and if Bean Validation API is visible to Eclipselink, it will try to instantiate an insance of javax.validation.ValidationFactory by calling Validation.buildDefaultValidatorFactory()

See Also:

Constant Field Values

VALIDATION_MODE

public static final java.lang.String VALIDATION_MODE

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

Valid values for this property are "AUTO", "CALLBACK" or "NONE".

See Also:

Constant Field Values

VALIDATION_GROUP_PRE_PERSIST

public static final java.lang.String VALIDATION_GROUP_PRE_PERSIST

The "javax.persistence.validation.group.pre-persist" property specifies the name of the validator groups to execute for preUpdate event. The value should be a string with fully qualified classnames separated by a comma (','). If this value is not specified in both persistence.xml or using this property, the default Bean Validation group (the group Default) will be validated

See Also:

Constant Field Values

VALIDATION_GROUP_PRE_UPDATE

public static final java.lang.String VALIDATION_GROUP_PRE_UPDATE

The "javax.persistence.validation.group.pre-update" property specifies the name of the validator groups to execute for preUpdate event. The value should be a string with fully qualified classnames separated by a comma (','). If this value is not specified in both persistence.xml or using this property, the default Bean Validation group (the group Default) will be validated

See Also:

Constant Field Values

VALIDATION_GROUP_PRE_REMOVE

public static final java.lang.String VALIDATION_GROUP_PRE_REMOVE

The "javax.persistence.validation.group.pre-remove" property specifies the name of the validator groups to execute for preRemove event. The value should be a string with fully qualified classnames separated by a comma (','). If this value is not specified in both persistence.xml or using this property, no validation will occur on remove.

See Also:

Constant Field Values

DEFAULT

public static final java.lang.String DEFAULT

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

See Also:

CACHE_SIZE_, CACHE_TYPE_, CACHE_SHARED_, Constant Field Values

CACHE_SIZE_

public static final java.lang.String CACHE_SIZE_

Property prefix "eclipselink.cache.size. used to specify the cache size for a specific entity type. The prefix must be followed by a valid entity type name.

Property names formed out of these prefixes by appending either entity name, or class name (indicating that the property values applies only to a particular entity) or DEFAULT suffix (indicating that the property value applies to all entities). For most cache types, the size is only the initial size, not a fixed or maximum size. For CacheType.SoftCache and CacheType.HardCache the size is the sub-cache size. The default cache size is 100.

See Also:

CACHE_SIZE_DEFAULT, Constant Field Values

CACHE_TYPE_

public static final java.lang.String CACHE_TYPE_

All valid values for CACHE_TYPE_ properties are declared in CacheType class. The default cache type is SoftWeak. This sets the type of cache, if you do not wish to cache entities at all, then set CACHE_SHARED_.

See Also:

CACHE_SHARED_, CacheType, CACHE_TYPE_DEFAULT, Constant Field Values

CACHE_SHARED_

public static final java.lang.String CACHE_SHARED_

Indicates whether entity's cache should be shared (non-isolated). Valid values are case-insensitive "false" and "true"; "true" is default. If you do not wish to cache your entities, set this to "false".

See Also:

CACHE_SHARED_DEFAULT, Constant Field Values

CACHE_SIZE_DEFAULT

public static final java.lang.String CACHE_SIZE_DEFAULT

Default caching properties - apply to all entities. May be overridden by individual entity property with the same prefix. For most cache types, the size is only the initial size, not a fixed or maximum size. For CacheType.SoftCache and CacheType.HardCache the size is the sub-cache size. The default cache size is 100.

See Also:

Constant Field Values

CACHE_TYPE_DEFAULT

public static final java.lang.String CACHE_TYPE_DEFAULT

Default caching properties - apply to all entities. May be overridden by individual entity property with the same prefix. The default cache type is SoftWeak. This sets the type of cache, if you do not wish to cache entities at all, then set CACHE_SHARED_DEFAULT.

See Also:

CACHE_SHARED_DEFAULT, Constant Field Values

CACHE_SHARED_DEFAULT

public static final java.lang.String CACHE_SHARED_DEFAULT

Default caching properties - apply to all entities. May be overridden by individual entity property with the same prefix. If you do not wish to cache your entities, set this to "false".

See Also:

Constant Field Values

LOGGING_LOGGER

public static final java.lang.String LOGGING_LOGGER

The type of logger. By default DefaultSessionLog is used. Valid values are the logger class name which implements org.eclipse.persistence.logging.SessionLog or one of values defined in LoggerType.

See Also:

LoggerType, Constant Field Values

LOGGING_LEVEL

public static final java.lang.String LOGGING_LEVEL

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

Java example: props.put(PersistenceUnitProperties.LOGGING_LEVEL, SessionLog.FINE_LABEL);


XML example: ;


Logging Levels:

See Also:

= "OFF", = "SEVERE", = "WARNING", = "CONFIG", = "INFO" (DEFAULT), = "FINE", = "FINER", = "FINEST", = "ALL", for category specific level configuration, Constant Field Values

CATEGORY_LOGGING_LEVEL_

public static final java.lang.String CATEGORY_LOGGING_LEVEL_

Property prefix "eclipselink.logging.level. allows the category specific logging levels to be specified.

Java example: props.put(PersistenceUnitProperties.CATEGORY_LOGGING_LEVEL_ + SessionLog.EJB_OR_METADATA, SessionLog.WARNING_LABEL);


XML example: ;
specific Valid values are names of levels defined in java.util.logging.Level, default value is INFO.

Categories:

See Also:

SessionLog.SQL, SessionLog.TRANSACTION, SessionLog.EVENT, SessionLog.CONNECTION, SessionLog.QUERY, SessionLog.CACHE, SessionLog.PROPAGATION, SessionLog.SEQUENCING, SessionLog.EJB_OR_METADATA, SessionLog.METAMODEL, SessionLog.WEAVER, SessionLog.PROPERTIES, SessionLog.SERVER, Constant Field Values

LOGGING_TIMESTAMP

public static final java.lang.String LOGGING_TIMESTAMP

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

Values:

• "true" (Default)
• "false"

See Also:

Constant Field Values

LOGGING_THREAD

public static final java.lang.String LOGGING_THREAD

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

By default ("true") the thread is logged at FINE or less level. This can be turned off ("false") or on ("true"). Values:

• "true" (Default)
• "false"

See Also:

Constant Field Values

LOGGING_SESSION

public static final java.lang.String LOGGING_SESSION

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

Values:

• "true" (Default)
• "false"

See Also:

Constant Field Values

LOGGING_CONNECTION

public static final java.lang.String LOGGING_CONNECTION

Property: "eclipselink.logging.connection"

Values:

• "true" (Default)
• "false"

See Also:

Constant Field Values

LOGGING_EXCEPTIONS

public static final java.lang.String LOGGING_EXCEPTIONS

Values:

• "true" (Default)
• "false"

See Also:

Constant Field Values

LOGGING_FILE

public static final java.lang.String LOGGING_FILE

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

See Also:

Constant Field Values

TARGET_DATABASE

public static final java.lang.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.

Values: Either a short string values as defined in TargetDatabase or a fully qualified class name for a class that extends DatabasePlatform. The default value is TargetDatabase.Auto which means EclipseLink will try to automatically determine the correct database platform type.

See Also:

TargetDatabase, DatabasePlatform, Constant Field Values

EXCLUDE_ECLIPSELINK_ORM_FILE

public static final java.lang.String EXCLUDE_ECLIPSELINK_ORM_FILE

The "eclipselink.exclude-eclipselink-orm" property configures the exclusion of an EclipseLink ORM mapping file for a specific persistence unit. By default the first file found at the resource name: "META-INF/eclipselink-orm.xml" is processed and overrides configurations specified in annotations, and standard mapping files.

See Also:

Constant Field Values

SESSION_NAME

public static final java.lang.String SESSION_NAME

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

By default a unique session name is generated by EclipseLink, but the user can provide a customary session name - and make sure it's unique. If a sessions-xml file is used this must be the name of the session in the sessions-xml file.

See Also:

Constant Field Values

WEAVING

public static final java.lang.String WEAVING

The "eclipselink.weaving" property configures whether weaving should be performed. Weaving is requires for lazy OneToOne, ManyToOne, Basic, attribute change tracking, fetch groups, and other optimizations.

Values (case insensitive):

• Not Set - defaults to "true" in Java SE using javaagent and within EJB 3+ compliant containers
• "true" - requires that weaving be done. Will throw an exception if entities are not woven
• "false" - forces weaving not to be done
• "static" - requires that the static weaving utility was used to weave the entities

Note: Any value specified that is not in the above list is treated as "static".

See Also:

Constant Field Values

WEAVING_INTERNAL

public static final java.lang.String WEAVING_INTERNAL

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

This property will only be considered if weaving is enabled.

Values (case insensitive):

• "true" (DEFAULT)
• "false"

See Also:

WEAVING, Constant Field Values

WEAVING_LAZY

public static final java.lang.String WEAVING_LAZY

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

This property will only be considered if weaving is enabled.

Values (case insensitive):

• "true" (DEFAULT)
• "false"

See Also:

WEAVING, Constant Field Values

WEAVING_EAGER

public static final java.lang.String WEAVING_EAGER

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

This property will only be considered if weaving is enabled.

Values (case insensitive):

• "true"
• "false" (DEFAULT)

See Also:

WEAVING, Constant Field Values

WEAVING_CHANGE_TRACKING

public static final java.lang.String WEAVING_CHANGE_TRACKING

The "eclipselink.weaving.changetracking" property configures whether AttributeLevelChangeTracking should be enabled through weaving. When this is enabled, only classes with all mappings allowing change tracking will have change tracking enabled. Mutable basic attributes will prevent this.

This property will only be considered if weaving is enabled.

Values (case insensitive):

• "true" (DEFAULT)
• "false"

See Also:

WEAVING, Constant Field Values

WEAVING_FETCHGROUPS

public static final java.lang.String WEAVING_FETCHGROUPS

The "eclipselink.weaving.fetchgroups" property configures whether FetchGroup support should be enabled through weaving. When this is enabled, lazy direct mappings will be supported as well as descriptor and query level FetchGroups. FetchGroups allow partial objects to be read and written, access to un-fetched attributes will cause the object to be refreshed/fully-fetched.

This property will only be considered if weaving is enabled.

Values (case insensitive):

• "true" (DEFAULT)
• "false"

See Also:

WEAVING, FetchGroupManager, FetchGroup, Constant Field Values

TARGET_SERVER

public static final java.lang.String TARGET_SERVER

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

Valid values are defined in TargetServer class - they correspond to server platforms currently supported. Also a custom server platform may be specified by supplying a full class name. Specifying a name of the class implementing ExternalTransactionController sets CustomServerPlatform with this controller. Default is TargetServer.None.

See Also:

TargetServer, Constant Field Values

SESSION_CUSTOMIZER

public static final java.lang.String SESSION_CUSTOMIZER

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

The value is a full name for a class which implements SessionCustomizer. Session customizer called after all other properties have been processed.

See Also:

SessionCustomizer, Constant Field Values

DESCRIPTOR_CUSTOMIZER_

public static final java.lang.String DESCRIPTOR_CUSTOMIZER_

The "eclipselink.descriptor.customizer." is a prefix for a property used to configure a DescriptorCustomizer. Customization Prefix Property names formed out of this prefix by appending either entity name, or class name (indicating that the property values applies only to a particular entity) Allows descriptor customization.

The value is a full name for a class which implements DescriptorCustomizer. Only session customizer is called after processing these properties.

See Also:

DescriptorCustomizer, Constant Field Values

NATIVE_QUERY_UPPERCASE_COLUMNS

public static final java.lang.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. If the column names are upper-case in the mappings (default) then they will not match. This setting allows for forcing the column names from the meta-data to upper-case.

See Also:

Constant Field Values

BATCH_WRITING

public static final java.lang.String BATCH_WRITING

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

Values (case insensitive):

• "JDBC": use JDBC batch writing.
• "Buffered": do not use either JDBC batch writing nor native platform batch writing.
• "Oracle-JDBC": use Oracle's native batch writing. This requires the use of an Oracle JDBC driver.
• "None" (DEFAULT): do not use batch writing (turn it off).

See Also:

BatchWriting, Constant Field Values

BATCH_WRITING_SIZE

public static final java.lang.String BATCH_WRITING_SIZE

The "eclipselink.jdbc.batch-writing.size" property configures the batch size used for batch writing. For parameterized batch writing this is the number of statements to batch, default 100. For dynamic batch writing, this is the size of the batched SQL buffer, default 32k.

See Also:

BATCH_WRITING, Constant Field Values

ECLIPSELINK_PERSISTENCE_XML

public static final java.lang.String ECLIPSELINK_PERSISTENCE_XML

The "eclipselink.persistencexml" property specifies the full resource name to look for the persistence XML files in. If not specified the default value defined by ECLIPSELINK_PERSISTENCE_XML_DEFAULT will be used.

IMPORTANT: For now this property is used for the canonical model generator but it can later be used as a system property for customizing weaving and application bootstrap usage.

This property is only used by EclipseLink when it is locating the configuration file. When used within an EJB/Spring container in container managed mode the locating and reading of this file is done by the container and will not use this configuration.

See Also:

Constant Field Values

ECLIPSELINK_PERSISTENCE_XML_DEFAULT

public static final java.lang.String ECLIPSELINK_PERSISTENCE_XML_DEFAULT

The default resource location used to locate the persistence.xml configuration files. Default: "META-INF/persistence.xml"

See Also:

Constant Field Values

ECLIPSELINK_PERSISTENCE_UNITS

public static final java.lang.String ECLIPSELINK_PERSISTENCE_UNITS

This "eclipselink.persistenceunits" property specifies the set of persistence unit names that will be processed when generating the canonical model. By default all persistence units available in all persistence XML files will be used. The value of this property is a comma separated list. When specifying multiple persistence units it is not possible to have persistence units with a comma in their name.

Note: In the future this property can also be used to limit the persistence units that will be processed by the static or dynamic weaving.

See Also:

Constant Field Values

EXCEPTION_HANDLER_CLASS

public static final java.lang.String EXCEPTION_HANDLER_CLASS

The "eclipselink.exception-handler" property allows an ExceptionHandler to be specified. An ExceptionHandler handles exceptions when they are thrown so that an application might address address expected failures and continue.

See Also:

ExceptionHandler, Constant Field Values

INCLUDE_DESCRIPTOR_QUERIES

public static final java.lang.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.

Default: "true".

See Also:

Constant Field Values

SESSION_EVENT_LISTENER_CLASS

public static final java.lang.String SESSION_EVENT_LISTENER_CLASS

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

See Also:

SessionEventListener, as a means to configure multiple listeners using API, Constant Field Values

SESSIONS_XML

public static final java.lang.String SESSIONS_XML

The "eclipselink.sessions-xml" property configures the use of the specified native sessions.xml configuration file. When specified this file will load all of the session configuration and mapping information from the native XML. No JPA annotations or XML will be used.

See Also:

Constant Field Values

TEMPORAL_MUTABLE

public static final java.lang.String TEMPORAL_MUTABLE

The "eclipselink.temporal.mutable" property configures the default for detecting changes to temporal field (Date, Calendar). Default "false" (changes to date object itself are not detected). By default it is assumed that temporal fields are replaced, and the temporal object not changed directly. Enabling mutable temporal fields will cause weaving of attribute change tracking to be disabled.

See Also:

Constant Field Values

ALLOW_ZERO_ID

public static final java.lang.String ALLOW_ZERO_ID

The "eclipselink.allow-zero-id" property configures if zero is considered a valid id on a new entity. If the id is not considered valid and sequencing is enabled for the entity a new value will be assigned when it is persisted to the database (INSERT)By default an id value of 0 is assumed to be null/unassigned. This allows 0 to be a valid id value. This can also be set per class using the @PrimaryKey annotation and IdValidation.

See Also:

PrimaryKey, IdValidation, Constant Field Values

FLUSH_CLEAR_CACHE

public static final java.lang.String FLUSH_CLEAR_CACHE

Defines EntityManager cache behavior after a call to flush method followed by a call to clear method. This property could be specified while creating either EntityManagerFactory (either in the map passed to createEntityManagerFactory method or in persistence.xml) or EntityManager (in the map passed to createEntityManager method); the latter overrides the former.

See Also:

FlushClearCache, Constant Field Values

CLASSLOADER

public static final java.lang.String CLASSLOADER

Specify the classloader to use to create an EntityManagerFactory in the property map passed to Persistence.createEntityManagerFactory.

See Also:

Constant Field Values

THROW_EXCEPTIONS

public static final java.lang.String THROW_EXCEPTIONS

Configures 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. "true" by default.

See Also:

Constant Field Values

ORM_SCHEMA_VALIDATION

public static final java.lang.String ORM_SCHEMA_VALIDATION

This property set on the session is used to override orm.xml schema validation from its default of false.

See Also:

Constant Field Values

VALIDATION_ONLY_PROPERTY

public static final java.lang.String VALIDATION_ONLY_PROPERTY

Validate deployment, but do not connect.

See Also:

Constant Field Values

DDL_GENERATION

public static final java.lang.String DDL_GENERATION

Allows the database schema to be generated on deployment. Valid values, CREATE_ONLY, DROP_AND_CREATE, NONE ("create-tables", "drop-and-create-tables", "none"). Default is NONE.

See Also:

Constant Field Values

CREATE_ONLY

public static final java.lang.String CREATE_ONLY

See Also:

Constant Field Values

DROP_AND_CREATE

public static final java.lang.String DROP_AND_CREATE

See Also:

Constant Field Values

NONE

public static final java.lang.String NONE

See Also:

Constant Field Values

APP_LOCATION

public static final java.lang.String APP_LOCATION

See Also:

Constant Field Values

CREATE_JDBC_DDL_FILE

public static final java.lang.String CREATE_JDBC_DDL_FILE

See Also:

Constant Field Values

DROP_JDBC_DDL_FILE

public static final java.lang.String DROP_JDBC_DDL_FILE

See Also:

Constant Field Values

DEFAULT_APP_LOCATION

public static final java.lang.String DEFAULT_APP_LOCATION

DEFAULT_CREATE_JDBC_FILE_NAME

public static final java.lang.String DEFAULT_CREATE_JDBC_FILE_NAME

See Also:

Constant Field Values

DEFAULT_DROP_JDBC_FILE_NAME

public static final java.lang.String DEFAULT_DROP_JDBC_FILE_NAME

See Also:

Constant Field Values

JAVASE_DB_INTERACTION

public static final java.lang.String JAVASE_DB_INTERACTION

See Also:

Constant Field Values

DDL_GENERATION_MODE

public static final java.lang.String DDL_GENERATION_MODE

Configures if database schema should be generated on the database, to a file, or both. Valid values, DDL_SQL_SCRIPT_GENERATION, DDL_DATABASE_GENERATION, DDL_BOTH_GENERATION ("sql-script", "database", "both") DDL_GENERATION must also be set, for this to have an effect. Default is DDL_DATABASE_GENERATION.

See Also:

Constant Field Values

DDL_SQL_SCRIPT_GENERATION

public static final java.lang.String DDL_SQL_SCRIPT_GENERATION

See Also:

Constant Field Values

DDL_DATABASE_GENERATION

public static final java.lang.String DDL_DATABASE_GENERATION

See Also:

Constant Field Values

DDL_BOTH_GENERATION

public static final java.lang.String DDL_BOTH_GENERATION

See Also:

Constant Field Values

DEFAULT_DDL_GENERATION_MODE

public static final java.lang.String DEFAULT_DDL_GENERATION_MODE

See Also:

Constant Field Values

VALIDATE_EXISTENCE

public static final java.lang.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. If checked and existing and not in the persistence context and error will be thrown. "false" by default.

See Also:

Constant Field Values

PROFILER

public static final java.lang.String PROFILER

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

Values (case insensitive):

• "NoProfiler" (DEFAULT)
• "PerformanceProfiler": Use PerformanceProfiler
• "QueryMonitor": Use QueryMonitor
• Custom profiler � Specify a custom profiler class name which implements SessionProfiler

See Also:

ProfilerType, Constant Field Values

JOIN_EXISTING_TRANSACTION

public static final java.lang.String JOIN_EXISTING_TRANSACTION

The "eclipselink.transaction.join-existing" property Set to "true" this property forces persistence context to read through JTA-managed ("write") connection in case there is an active transaction.The property set in persistence.xml or passed to createEntityManagerFactory affects all EntityManagers created by the factory. Note that if the property set to "true" then objects read during transaction won't be placed into the shared cache unless they have been updated. Alternatively, to apply the property only to some SessionManagers pass it to createEntityManager method.

Values (caseinsensitive):

• "false" (DEFAULT):
• "true":

See Also:

Constant Field Values

PERSISTENCE_CONTEXT_REFERENCE_MODE

public static final java.lang.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. Default is "HARD". With soft references entities no longer referenced by the application may be garbage collected freeing resources. Any changes that have not been flushed in these entities will be lost. The property set in persistence.xml or passed to createEntityManagerFactory affects all EntityManagers created by the factory. Alternatively, to apply the property only to some SessionManagers pass it to createEntityManager method.

Values:

• "HARD" (DEFAULT) - {@link ReferenceMode#HARD
• "WEAK" - {@link ReferenceMode#WEAK
• "FORCE_WEAK" - {@link ReferenceMode#FORCE_WEAK

See Also:

ReferenceMode, Constant Field Values

PESSIMISTIC_LOCK_TIMEOUT

public static final java.lang.String PESSIMISTIC_LOCK_TIMEOUT

The "javax.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.

Valid values are Strings containing integers zero or greater.

See Also:

Constant Field Values

QUERY_TIMEOUT

public static final java.lang.String QUERY_TIMEOUT

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

Valid values are strings containing integers zero or greater.

See Also:

Constant Field Values

PERSISTENCE_CONTEXT_CLOSE_ON_COMMIT

public static final java.lang.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). In general this is normally always the case for a container managed EntityManager, and common for application managed. This can be used to avoid additional performance overhead of resuming the persistence context after a commit(). The property set in persistence.xml or passed to createEntityManagerFactory affects all EntityManagers created by the factory. Alternatively, to apply the property only to some EntityManagers pass it to createEntityManager method.

Values (case insensitive):

• "false" (DEFAULT)
• "true"

See Also:

Constant Field Values

PERSISTENCE_CONTEXT_PERSIST_ON_COMMIT

public static final java.lang.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. This can be used to avoid the cost of performing this search if persist is always used for new objects. The property set in persistence.xml or passed to createEntityManagerFactory affects all EntityManagers created by the factory. Alternatively, to apply the property only to some EntityManagers pass it to createEntityManager method.

Values (case insensitive):

• "true" (DEFAULT)
• "false"

See Also:

Constant Field Values

PERSISTENCE_CONTEXT_COMMIT_WITHOUT_PERSIST_RULES

public static final java.lang.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. Also the Entity life-cycle Persist operation will not be cascaded to related entities. This setting replicates the traditional EclipseLink native functionality.

Values (case insensitive):

• "false" (DEFAULT)
• "true"

See Also:

Constant Field Values

PERSISTENCE_CONTEXT_FLUSH_MODE

public static final java.lang.String PERSISTENCE_CONTEXT_FLUSH_MODE

The "eclipselink.persistence-context.flush-mode property configures the EntityManager FlushMode to be set as a persistence property. This can be set to either "AUTO" or "COMMIT". By default the flush mode is AUTO, which requires an automatic flush before all query execution. This can be used to avoid any flushing until commit. The property set in persistence.xml or passed to createEntityManagerFactory affects all EntityManagers created by the factory. Alternatively, to apply the property only to some EntityManagers pass it to createEntityManager method.

See Also:

EntityManager.setFlushMode(javax.persistence.FlushModeType), FlushModeType, Constant Field Values

ORACLE_PROXY_TYPE

public static final java.lang.String ORACLE_PROXY_TYPE

The "eclipselink.oracle.proxy-type" property is used to specify proxy type that should be passed to OracleConnection.openProxySession method. Requires Oracle JDBC version 10.1.0.2 or later. Requires Oracle9Platform or later as a database platform (TARGET_DATABASE property value should be TargetDatabase.Oracle9 or later).

Values:

• oracle.jdbc.OracleConnection.PROXYTYPE_USER_NAME,
• oracle.jdbc.OracleConnection.PROXYTYPE_DISTINGUISHED_NAME,
• oracle.jdbc.OracleConnection.PROXYTYPE_CERTIFICATE.

Property values corresponding to the specified type should be also provided:

• oracle.jdbc.OracleConnection.PROXY_USER_NAME,
• oracle.jdbc.OracleConnection.PROXY_DISTINGUISHED_NAME,
• oracle.jdbc.OracleConnection.PROXY_CERTIFICATE.

  Typically these properties should be set into EntityManager (either through createEntityManager method or using proprietary setProperties method on EntityManagerImpl) - that causes EntityManager to use proxy connection for writing and reading inside transaction. If proxy-type and the corresponding proxy property set into EntityManagerFactory then all connections created by the factory will be proxy connections.

  See Also:

  Constant Field Values

COORDINATION_PROTOCOL

public static final java.lang.String COORDINATION_PROTOCOL

The "eclipselink.cache.coordination.protocol" property configures cache coordination for a clustered environment. This needs to be set on every persistence unit/session in the cluster. Depending on the cache configuration for each descriptor, this will broadcast cache updates or inserts to the cluster to update or invalidate each session's cache.

Values:

• "jms"
• "rmi"

by default the cache is not coordinated.

See Also:

Cache.coordinationType(), CacheCoordinationType, RemoteCommandManager.setTransportManager(TransportManager), Constant Field Values

COORDINATION_JMS_HOST

public static final java.lang.String COORDINATION_JMS_HOST

The "eclipselink.cache.coordination.jms.host" property configures cache coordination for a clustered environment. Only used for JMS coordination. Sets the URL for the JMS server hosting the topic.

See Also:

COORDINATION_PROTOCOL, JMSTopicTransportManager.setTopicHostUrl(String), Constant Field Values

COORDINATION_JMS_TOPIC

public static final java.lang.String COORDINATION_JMS_TOPIC

The "eclipselink.cache.coordination.jms.topic" property configures cache coordination for a clustered environment. Only used for JMS coordination. Sets the JMS topic name.

See Also:

COORDINATION_PROTOCOL, BroadcastTransportManager.setTopicName(String), Constant Field Values

COORDINATION_JMS_FACTORY

public static final java.lang.String COORDINATION_JMS_FACTORY

The "eclipselink.cache.coordination.jms.factory" property configures cache coordination for a clustered environment. Only used for JMS coordination. Sets the JMS topic connection factory name.

See Also:

COORDINATION_PROTOCOL, org.eclipse.persistence.sessions.coordination.broadcast.BroadcastTransportManager#setTopicConnectionFactoryName(String), Constant Field Values

COORDINATION_RMI_ANNOUNCEMENT_DELAY

public static final java.lang.String COORDINATION_RMI_ANNOUNCEMENT_DELAY

The "eclipselink.cache.coordination.rmi.announcement-delay" property configures cache coordination for a clustered environment. Only used for RMI coordination. Sets the number of milliseconds to wait for announcements from other cluster members on startup.

See Also:

COORDINATION_PROTOCOL, DiscoveryManager.setAnnouncementDelay(int), Constant Field Values

COORDINATION_RMI_MULTICAST_GROUP

public static final java.lang.String COORDINATION_RMI_MULTICAST_GROUP

The "eclipselink.cache.coordination.rmi.multicast-group" property configures cache coordination for a clustered environment. Only used for RMI coordination. Sets the multicast socket group address. The multicast group is used to find other members of the cluster.

See Also:

COORDINATION_PROTOCOL, DiscoveryManager.setMulticastGroupAddress(String), Constant Field Values

COORDINATION_RMI_MULTICAST_GROUP_PORT

public static final java.lang.String COORDINATION_RMI_MULTICAST_GROUP_PORT

The "eclipselink.cache.coordination.rmi.multicast-group.port" property configures cache coordination for a clustered environment. Only used for RMI coordination. Sets the multicast socket group port. The multicast group port is used to find other members of the cluster.

See Also:

COORDINATION_PROTOCOL, DiscoveryManager.setMulticastPort(int), Constant Field Values

COORDINATION_RMI_PACKET_TIME_TO_LIVE

public static final java.lang.String COORDINATION_RMI_PACKET_TIME_TO_LIVE

The "eclipselink.cache.coordination.rmi.packet-time-to-live" property configures cache coordination for a clustered environment. Only used for RMI coordination. Sets the multicast socket packet time to live. The multicast group is used to find other members of the cluster. Set the number of hops the data packets of the session announcement will take before expiring. The default is 2, a hub and an interface card to prevent the data packets from leaving the local network. Note that if sessions are hosted on different LANs that are part of WAN, the announcement sending by one session may not reach other sessions. In this case, consult your network administrator for the right time-to-live value or test your network by increase the value until sessions receive announcement sent by others.

See Also:

COORDINATION_PROTOCOL, DiscoveryManager.setPacketTimeToLive(int), Constant Field Values

COORDINATION_RMI_URL

public static final java.lang.String COORDINATION_RMI_URL

The "eclipselink.cache.coordination.rmi.url" property configures cache coordination for a clustered environment. Only used for RMI coordination. Sets the URL of the host server. This is the URL that other cluster member should use to connect to this host.

See Also:

COORDINATION_PROTOCOL, RemoteCommandManager.setUrl(String), Constant Field Values

COORDINATION_NAMING_SERVICE

public static final java.lang.String COORDINATION_NAMING_SERVICE

The "eclipselink.cache.coordination.naming-service" property configures cache coordination for a clustered environment. Set the naming service to use, either "jndi" or "rmi".

See Also:

COORDINATION_PROTOCOL, TransportManager.setNamingServiceType(int), Constant Field Values

COORDINATION_JNDI_USER

public static final java.lang.String COORDINATION_JNDI_USER

the "eclipselink.cache.coordination.jndi.user" property configures cache coordination for a clustered environment. Set the JNDI naming service user name.

See Also:

COORDINATION_PROTOCOL, TransportManager.setUserName(String), Constant Field Values

COORDINATION_JNDI_PASSWORD

public static final java.lang.String COORDINATION_JNDI_PASSWORD

The "eclipselink.cache.coordination.jndi.password" property configures cache coordination for a clustered environment. Set the JNDI naming service user name.

See Also:

COORDINATION_PROTOCOL, TransportManager.setPassword(String), Constant Field Values

COORDINATION_JNDI_CONTEXT

public static final java.lang.String COORDINATION_JNDI_CONTEXT

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

See Also:

COORDINATION_PROTOCOL, TransportManager.setInitialContextFactoryName(String), Constant Field Values

COORDINATION_REMOVE_CONNECTION

public static final java.lang.String COORDINATION_REMOVE_CONNECTION

The "eclipselink.cache.coordination.remove-connection-on-error" property configures cache coordination for a clustered environment. Set if the connection should be removed if a communication error occurs when coordinating with it. This is normally used for RMI coordination in case a server goes down (it will reconnect when it comes back up).

See Also:

COORDINATION_PROTOCOL, TransportManager.setShouldRemoveConnectionOnError(boolean), Constant Field Values

COORDINATION_ASYNCH

public static final java.lang.String COORDINATION_ASYNCH

the "eclipselink.cache.coordination.propagate-asynchronously" property configures cache coordination for a clustered environment. Set if the coordination broadcast should occur asynchronously with the committing thread. This means the coordination will be complete before the thread returns from the commit of the transaction. Note that JMS is always asynchronous. By default RMI is asynchronous.

See Also:

COORDINATION_PROTOCOL, RemoteCommandManager.setShouldPropagateAsynchronously(boolean), Constant Field Values

COORDINATION_CHANNEL

public static final java.lang.String COORDINATION_CHANNEL

the "eclipselink.cache.coordination.channel" property configures cache coordination for a clustered environment. Set if the channel for this cluster. All server's in the same channel will be coordinated.

See Also:

COORDINATION_PROTOCOL, RemoteCommandManager.setChannel(String), Constant Field Values

PROPERTY_LOG_OVERRIDES

public static final java.util.Map<java.lang.String,java.lang.String> PROPERTY_LOG_OVERRIDES

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

Constructor Detail

PersistenceUnitProperties

public PersistenceUnitProperties()

Method Detail

getOverriddenLogStringForProperty

public static java.lang.String getOverriddenLogStringForProperty(java.lang.String propertyName)

INTERNAL: Return the overridden log string.

getSupportedNonServerSessionProperties

public static java.util.Set<java.lang.String> getSupportedNonServerSessionProperties()