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 properties' names. JPA persistence properties could be specified either in PersistenceUnit or passes to createEntityManagerFactory / createContainerEntityManagerFactory methods of EntityManagerFactoryProvider. Property values are usually case-insensitive with some common sense exceptions, for instance class names.

See Also:

CacheType, TargetDatabase, TargetServer

Field Summary

static java.lang.String	ALLOW_ZERO_ID By default an id value of 0 is assumed to be null/unassigned.
static java.lang.String	APP_LOCATION
static java.lang.String	BATCH_WRITING Specify the use of batch writing to optimize transactions with multiple writes, by default batch writing is not used.
static java.lang.String	BATCH_WRITING_SIZE Specify 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_ Caching Prefixes.
static java.lang.String	CACHE_SIZE_DEFAULT Default caching properties - apply to all entities.
static java.lang.String	CACHE_STATEMENTS Specify enable/disable cache statements.
static java.lang.String	CACHE_STATEMENTS_SIZE Specify number of statements held when using internal statement caching, default "50".
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_ Category-specific logging level prefix Property names formed out of this prefix by appending a category name e.g.) eclipselink.logging.level.sql Valid categories are defined in SessionLog
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	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_ 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.
static java.lang.String	DROP_AND_CREATE
static java.lang.String	DROP_JDBC_DDL_FILE
static java.lang.String	EXCEPTION_HANDLER_CLASS Specify ExceptionHandler implementing class.
static java.lang.String	EXCLUDE_ECLIPSELINK_ORM_FILE A persistence unit may opt to exclude an EclipseLink orm file for a specific persistence unit.
static java.lang.String	EXCLUSIVE_CONNECTION_IS_LAZY Determines when write connection is acquired lazily.
static java.lang.String	EXCLUSIVE_CONNECTION_MODE Determines 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 Specify 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 Bind all parameters property.
static java.lang.String	JDBC_DRIVER JDBC DriverManager class name.
static java.lang.String	JDBC_PASSWORD DataSource or JDBC DriverManager password.
static java.lang.String	JDBC_READ_CONNECTIONS_MAX EclipseLink JDBC (internal) connection pools properties.
static java.lang.String	JDBC_READ_CONNECTIONS_MIN EclipseLink JDBC (internal) connection pools properties.
static java.lang.String	JDBC_READ_CONNECTIONS_SHARED EclipseLink JDBC (internal) connection pools properties.
static java.lang.String	JDBC_URL JDBC DriverManager driver URL.
static java.lang.String	JDBC_USER DataSource or JDBC DriverManager user name.
static java.lang.String	JDBC_WRITE_CONNECTIONS_MAX EclipseLink JDBC (internal) connection pools properties.
static java.lang.String	JDBC_WRITE_CONNECTIONS_MIN EclipseLink JDBC (internal) connection pools properties.
static java.lang.String	JOIN_EXISTING_TRANSACTION Set to "true" this property forces persistence context to read through JTA-managed ("write") connection in case there is an active transaction.
static java.lang.String	JTA_DATASOURCE Standard JPA JTA DataSource name.
static java.lang.String	LOGGING_EXCEPTIONS By default ("true") stack trace is logged for SEVERE all the time and at FINER level for WARNING or less.
static java.lang.String	LOGGING_FILE Specify a file location where the log will be output to instead of standard out.
static java.lang.String	LOGGING_LEVEL Valid values are names of levels defined in java.util.logging.Level, default value is INFO.
static java.lang.String	LOGGING_LOGGER The type of logger.
static java.lang.String	LOGGING_SESSION By default ("true") the Session is always printed whenever available.
static java.lang.String	LOGGING_THREAD By default ("true") the thread is logged at FINE or less level.
static java.lang.String	LOGGING_TIMESTAMP By default ("true") the timestamp is always logged.
static java.lang.String	NATIVE_QUERY_UPPERCASE_COLUMNS When 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 Indicate whether to enable EclipseLink to generate DB platform specific SQL versus generic SQL.
static java.lang.String	NON_JTA_DATASOURCE Standard JPA non-JTA DataSource name.
static java.lang.String	NONE
static java.lang.String	ORACLE_PROXY_TYPE This 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 Specifies that the EntityManager will be closed or not used after commit (not extended).
static java.lang.String	PERSISTENCE_CONTEXT_COMMIT_WITHOUT_PERSIST_RULES 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 Allows the EntityManager FlushMode to be set as a persistence property.
static java.lang.String	PERSISTENCE_CONTEXT_PERSIST_ON_COMMIT 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 Specifies whether there should be hard or soft references used within the Persistence Context.
static java.lang.String	PESSIMISTIC_LOCK_TIMEOUT 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 type of performance profiler.
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	SESSION_CUSTOMIZER Allows session customization.
static java.lang.String	SESSION_EVENT_LISTENER_CLASS Specify a session event listener class.
static java.lang.String	SESSION_NAME 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.
static java.lang.String	SESSIONS_XML Specify persistence info to be loaded from a sessions-xml file.
static java.lang.String	TARGET_DATABASE Valid values are defined in TargetDatabase class - they correspond to database platforms currently supported by TopLink.
static java.lang.String	TARGET_SERVER Valid values are defined in TargetServer class - they correspond to server platforms currently supported by EclipseLink.
static java.lang.String	TEMPORAL_MUTABLE Specify 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 Standard JPA PersistenceUnitTransactionType property, JTA or RESOURCE_LOCAL.
static java.lang.String	VALIDATE_EXISTENCE 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_ONLY_PROPERTY Validate deployment, but do not connect.
static java.lang.String	WEAVING Indicates whether weaving should be performed.
static java.lang.String	WEAVING_CHANGE_TRACKING Indicates whether AttributeLevelChangeTracking should be enabled through weaving - "true" by default.
static java.lang.String	WEAVING_EAGER Indicates whether EAGER mappings should be enabled to use indirection - "false" by default.
static java.lang.String	WEAVING_FETCHGROUPS Indicates whether FetchGroup support should be enabled through weaving - "true" by default.
static java.lang.String	WEAVING_INTERNAL Indicates whether internal optimizations should be enabled through weaving - "true" by default.
static java.lang.String	WEAVING_LAZY Indicates whether LAZY OneToOne mappings should be enabled through weaving - "true" by default.

Constructor Summary

PersistenceUnitProperties()

Method Summary

static java.lang.String

getOverriddenLogStringForProperty(java.lang.String propertyName) INTERNAL: Return the overridden log string.

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

Standard JPA PersistenceUnitTransactionType property, JTA or RESOURCE_LOCAL.

See Also:

Constant Field Values

JTA_DATASOURCE

public static final java.lang.String JTA_DATASOURCE

Standard JPA JTA DataSource name.

See Also:

Constant Field Values

NON_JTA_DATASOURCE

public static final java.lang.String NON_JTA_DATASOURCE

Standard JPA non-JTA DataSource name.

See Also:

Constant Field Values

JDBC_DRIVER

public static final java.lang.String JDBC_DRIVER

JDBC DriverManager class name.

See Also:

Constant Field Values

JDBC_URL

public static final java.lang.String JDBC_URL

JDBC DriverManager driver URL.

See Also:

Constant Field Values

JDBC_USER

public static final java.lang.String JDBC_USER

DataSource or JDBC DriverManager user name.

See Also:

Constant Field Values

JDBC_PASSWORD

public static final java.lang.String JDBC_PASSWORD

DataSource or JDBC DriverManager password.

See Also:

Constant Field Values

JDBC_WRITE_CONNECTIONS_MAX

public static final java.lang.String JDBC_WRITE_CONNECTIONS_MAX

EclipseLink JDBC (internal) connection pools properties. Ignored in case external connection pools are used. Maximum number of connections in TopLink write connection pool by default is 10.

See Also:

Constant Field Values

JDBC_WRITE_CONNECTIONS_MIN

public static final java.lang.String JDBC_WRITE_CONNECTIONS_MIN

EclipseLink JDBC (internal) connection pools properties. Ignored in case external connection pools are used. Minimum number of connections in TopLink write connection pool by default is 5.

See Also:

Constant Field Values

JDBC_READ_CONNECTIONS_MAX

public static final java.lang.String JDBC_READ_CONNECTIONS_MAX

EclipseLink JDBC (internal) connection pools properties. Ignored in case external connection pools are used. Maximum number of connections in TopLink read connection pool by default is 2.

See Also:

Constant Field Values

JDBC_READ_CONNECTIONS_MIN

public static final java.lang.String JDBC_READ_CONNECTIONS_MIN

EclipseLink JDBC (internal) connection pools properties. Ignored in case external connection pools are used. Minimum number of connections in TopLink read connection pool by default is 2.

See Also:

Constant Field Values

JDBC_READ_CONNECTIONS_SHARED

public static final java.lang.String JDBC_READ_CONNECTIONS_SHARED

EclipseLink JDBC (internal) connection pools properties. Ignored in case external connection pools are used. Indicates whether connections in TopLink read connection pool should be shared. Valid values are case-insensitive "false" and "true"; "false" is default.

See Also:

Constant Field Values

JDBC_BIND_PARAMETERS

public static final java.lang.String JDBC_BIND_PARAMETERS

Bind all parameters property. Valid values are case-insensitive "true" and "false"; "true" is default.

See Also:

Constant Field Values

CACHE_SIZE_

public static final java.lang.String CACHE_SIZE_

Caching Prefixes.

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:

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, 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:

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:

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

EXCLUSIVE_CONNECTION_MODE

public static final java.lang.String EXCLUSIVE_CONNECTION_MODE

Determines when reads are performed through the write connection.

See Also:

ExclusiveConnectionMode, Constant Field Values

EXCLUSIVE_CONNECTION_IS_LAZY

public static final java.lang.String EXCLUSIVE_CONNECTION_IS_LAZY

Determines when write connection is acquired lazily. Valid values are case-insensitive "false" and "true"; "true" is default.

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

Valid values are names of levels defined in java.util.logging.Level, default value is INFO.

See Also:

Constant Field Values

CATEGORY_LOGGING_LEVEL_

public static final java.lang.String CATEGORY_LOGGING_LEVEL_

Category-specific logging level prefix Property names formed out of this prefix by appending a category name e.g.) eclipselink.logging.level.sql Valid categories are defined in SessionLog

See Also:

Constant Field Values

LOGGING_TIMESTAMP

public static final java.lang.String LOGGING_TIMESTAMP

By default ("true") the timestamp is always logged. This can be turned off ("false").

See Also:

Constant Field Values

LOGGING_THREAD

public static final java.lang.String LOGGING_THREAD

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

See Also:

Constant Field Values

LOGGING_SESSION

public static final java.lang.String LOGGING_SESSION

By default ("true") the Session is always printed whenever available. This can be turned off ("false").

See Also:

Constant Field Values

LOGGING_EXCEPTIONS

public static final java.lang.String LOGGING_EXCEPTIONS

By default ("true") stack trace is logged for SEVERE all the time and at FINER level for WARNING or less. This can be turned off ("false") or on ("true").

See Also:

Constant Field Values

TARGET_DATABASE

public static final java.lang.String TARGET_DATABASE

Valid values are defined in TargetDatabase class - they correspond to database platforms currently supported by TopLink. Also a custom database platform may be specified by supplying a full class name. Default value is TargetDatabase.Auto which means EclipseLink will try to automatically determine the correct database platform type.

See Also:

TargetDatabase, Constant Field Values

EXCLUDE_ECLIPSELINK_ORM_FILE

public static final java.lang.String EXCLUDE_ECLIPSELINK_ORM_FILE

A persistence unit may opt to exclude an EclipseLink orm file for a specific persistence unit.

See Also:

Constant Field Values

SESSION_NAME

public static final java.lang.String SESSION_NAME

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

Indicates whether weaving should be performed. Weaving is requires for lazy OneToOne, ManyToOne, Basic, attribute change tracking, fetch groups, and other optimizations.

• "true" by default in JEE (EJB3 compliant).
• "true" by default in JSE if an agent is used, (JVM option: "-javaagent:eclipselink.jar").
• "false" by default in JSE if an agent is not used.
• "static" should be used if the static weaver was run on the persistence unit (must run static weaver ant task).

See Also:

Constant Field Values

WEAVING_INTERNAL

public static final java.lang.String WEAVING_INTERNAL

Indicates whether internal optimizations should be enabled through weaving - "true" by default.

See Also:

Constant Field Values

WEAVING_LAZY

public static final java.lang.String WEAVING_LAZY

Indicates whether LAZY OneToOne mappings should be enabled through weaving - "true" by default.

See Also:

Constant Field Values

WEAVING_EAGER

public static final java.lang.String WEAVING_EAGER

Indicates whether EAGER mappings should be enabled to use indirection - "false" by default.

See Also:

Constant Field Values

WEAVING_CHANGE_TRACKING

public static final java.lang.String WEAVING_CHANGE_TRACKING

Indicates whether AttributeLevelChangeTracking should be enabled through weaving - "true" by default. When this is enabled, only classes with all mappings allowing change tracking will have change tracking enabled.

See Also:

Constant Field Values

WEAVING_FETCHGROUPS

public static final java.lang.String WEAVING_FETCHGROUPS

Indicates whether FetchGroup support should be enabled through weaving - "true" by default. 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 unfetched attributes will cause the object to be refreshed/fully-fetched.

See Also:

FetchGroupManager, FetchGroup, Constant Field Values

TARGET_SERVER

public static final java.lang.String TARGET_SERVER

Valid values are defined in TargetServer class - they correspond to server platforms currently supported by EclipseLink. 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 - JSE case.

See Also:

TargetServer, Constant Field Values

SESSION_CUSTOMIZER

public static final java.lang.String SESSION_CUSTOMIZER

Allows session customization. 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_

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:

Constant Field Values

NATIVE_SQL

public static final java.lang.String NATIVE_SQL

Indicate whether to enable EclipseLink to generate DB platform specific SQL versus generic SQL.

See Also:

Constant Field Values

NATIVE_QUERY_UPPERCASE_COLUMNS

public static final java.lang.String NATIVE_QUERY_UPPERCASE_COLUMNS

When native SQL queries are used, the JDBC meta-data may return column names in lower case on some platforms. If the column names are uppercase in the mappings (default) then they will not match. This setting allows for forcing the column names from the meta-data to uppercase.

See Also:

Constant Field Values

BATCH_WRITING

public static final java.lang.String BATCH_WRITING

Specify the use of batch writing to optimize transactions with multiple writes, by default batch writing is not used.

See Also:

BatchWriting, Constant Field Values

BATCH_WRITING_SIZE

public static final java.lang.String BATCH_WRITING_SIZE

Specify 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

EXCEPTION_HANDLER_CLASS

public static final java.lang.String EXCEPTION_HANDLER_CLASS

Specify ExceptionHandler implementing class.

See Also:

Constant Field Values

CACHE_STATEMENTS_SIZE

public static final java.lang.String CACHE_STATEMENTS_SIZE

Specify number of statements held when using internal statement caching, default "50".

See Also:

Constant Field Values

INCLUDE_DESCRIPTOR_QUERIES

public static final java.lang.String INCLUDE_DESCRIPTOR_QUERIES

Specify 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

CACHE_STATEMENTS

public static final java.lang.String CACHE_STATEMENTS

Specify enable/disable cache statements. Default "false".

See Also:

Constant Field Values

SESSION_EVENT_LISTENER_CLASS

public static final java.lang.String SESSION_EVENT_LISTENER_CLASS

Specify a session event listener class.

See Also:

SessionEventListener, Constant Field Values

SESSIONS_XML

public static final java.lang.String SESSIONS_XML

Specify persistence info to be loaded from a sessions-xml file.

See Also:

Constant Field Values

LOGGING_FILE

public static final java.lang.String LOGGING_FILE

Specify a file location where the log will be output to instead of standard out.

See Also:

Constant Field Values

TEMPORAL_MUTABLE

public static final java.lang.String TEMPORAL_MUTABLE

Specify 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

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

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 type of performance profiler. Valid values are names of profiler defined in ProfilerType, default value is NoProfiler.

See Also:

ProfilerType, Constant Field Values

JOIN_EXISTING_TRANSACTION

public static final java.lang.String JOIN_EXISTING_TRANSACTION

Set to "true" this property forces persistence context to read through JTA-managed ("write") connection in case there is an active transaction. Valid values are case-insensitive "false" and "true"; "false" is default. 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.

See Also:

Constant Field Values

PERSISTENCE_CONTEXT_REFERENCE_MODE

public static final java.lang.String PERSISTENCE_CONTEXT_REFERENCE_MODE

Specifies 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.

See Also:

ReferenceMode, Constant Field Values

PESSIMISTIC_LOCK_TIMEOUT

public static final java.lang.String PESSIMISTIC_LOCK_TIMEOUT

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 Integer or Strings that can be parsed to int values.

See Also:

Constant Field Values

PERSISTENCE_CONTEXT_CLOSE_ON_COMMIT

public static final java.lang.String PERSISTENCE_CONTEXT_CLOSE_ON_COMMIT

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. Either "true" or "false. "false" is the default.

See Also:

Constant Field Values

PERSISTENCE_CONTEXT_PERSIST_ON_COMMIT

public static final java.lang.String PERSISTENCE_CONTEXT_PERSIST_ON_COMMIT

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. Either "true" or "false. "true" is the default.

See Also:

Constant Field Values

PERSISTENCE_CONTEXT_COMMIT_WITHOUT_PERSIST_RULES

public static final java.lang.String PERSISTENCE_CONTEXT_COMMIT_WITHOUT_PERSIST_RULES

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 lifecycle Persist operation will not be cascaded to related entities. This setting replicates the traditional EclipseLink native functionality.

See Also:

Constant Field Values

PERSISTENCE_CONTEXT_FLUSH_MODE

public static final java.lang.String PERSISTENCE_CONTEXT_FLUSH_MODE

Allows 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

This 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). The valid values are: OracleConnection.PROXYTYPE_USER_NAME, OracleConnection.PROXYTYPE_DISTINGUISHED_NAME, OracleConnection.PROXYTYPE_CERTIFICATE. Property property corresponding to the specified type should be also provided: OracleConnection.PROXY_USER_NAME, OracleConnection.PROXY_DISTINGUISHED_NAME, 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

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 final java.lang.String getOverriddenLogStringForProperty(java.lang.String propertyName)

INTERNAL: Return the overridden log string.