|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) E28847-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
org.eclipse.persistence.config.PersistenceUnitProperties
public class PersistenceUnitProperties
The class defines EclipseLink persistence unit property names. These values are used to assist in the configuration of properties passed to Persistence.createEntityManagerFactory(String, Map)
which override the values specified in the persistence.xml file.
Usage Example: Map<String, Object> props = new HashMap<String, Object>();
props.put(PersistenceUnitProperties.JDBC_USER, "user-name");
props.put(PersistenceUnitProperties.JDBC_PASSWORD, "password");
EntityManagerFactory emf = Persistence.createEntityManagerFactory("pu-name", props);
Property values are usually case-insensitive with some common sense exceptions, for instance class names.
Persistence.createEntityManagerFactory(String, Map)
Field Summary | |
---|---|
static java.lang.String |
ALLOW_NATIVE_SQL_QUERIES The "eclipselink.jdbc.allow-native-sql-queries" property specifies whether any user defined SQL is allowed within a persistence unit. |
static java.lang.String |
ALLOW_ZERO_ID Deprecated. replaced by ID_VALIDATION property with value "NULL". |
static java.lang.String |
APP_LOCATION The property "eclipselink.application-location" Specifies the file system directory location where DDL files are written (output) to. |
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 |
COMPOSITE_UNIT Indicates if it's a composite persistence unit ("true"). |
static java.lang.String |
COMPOSITE_UNIT_MEMBER Indicates if the persistence unit must be a member of a composite persistence unit ("true"), can't be used as an independent persistence unit. |
static java.lang.String |
COMPOSITE_UNIT_PROPERTIES The property may be passed to createEntityManagerFactory method of a composite persistence unit to pass properties to member persistence units. |
static java.lang.String |
CONNECTION_POOL Allow configuring a "eclipselink.connection-pool." |
static java.lang.String |
CONNECTION_POOL_FAILOVER The "failover" property. |
static java.lang.String |
CONNECTION_POOL_INITIAL The "initial" property. |
static java.lang.String |
CONNECTION_POOL_JTA_DATA_SOURCE The "jtaDataSource" property. |
static java.lang.String |
CONNECTION_POOL_MAX The "max" property. |
static java.lang.String |
CONNECTION_POOL_MIN The "min" property. |
static java.lang.String |
CONNECTION_POOL_NON_JTA_DATA_SOURCE The "nonJtaDataSource" property. |
static java.lang.String |
CONNECTION_POOL_PASSWORD The "password" property. |
static java.lang.String |
CONNECTION_POOL_READ Allow configuring the "eclipselink.connection-pool.read." |
static java.lang.String |
CONNECTION_POOL_SEQUENCE Allow configuring the "eclipselink.connection-pool.sequence." |
static java.lang.String |
CONNECTION_POOL_SHARED The "shared" property. |
static java.lang.String |
CONNECTION_POOL_URL The "url" property. |
static java.lang.String |
CONNECTION_POOL_USER The "user" property. |
static java.lang.String |
CONNECTION_POOL_WAIT The "wait" property. |
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_REUSE_PUBLISHER The "eclipselink.cache.coordination.jms.reuse-topic-publisher" 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 The property "eclipselink.create-ddl-jdbc-file-name" Specifies the name of the DDL file which is used to create database tables. |
static java.lang.String |
CREATE_ONLY The parameter value "create-tables" For use with the "eclipselink.ddl-generation" property. |
static java.lang.String |
DDL_BOTH_GENERATION The parameter value "both" For use with the "eclipselink.ddl-generation.output-mode" property. |
static java.lang.String |
DDL_DATABASE_GENERATION The parameter value "database" For use with the "eclipselink.ddl-generation.output-mode" property, and is the default parameter value Specifies that DDL will be written to the database. |
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 The parameter value "sql-script" For use with the "eclipselink.ddl-generation.output-mode" property. |
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 The default location in the file system to output DDL files. |
static java.lang.String |
DEFAULT_CREATE_JDBC_FILE_NAME The default name of the DDL file which is used to create database tables. |
static java.lang.String |
DEFAULT_DDL_GENERATION_MODE The eclipselink.ddl-generation.output-mode parameter is configured to the default value of database . |
static java.lang.String |
DEFAULT_DROP_JDBC_FILE_NAME The default name of the DDL file which is used to drop database tables. |
static java.lang.String |
DEPLOY_ON_STARTUP The "eclipselink.deploy-on-startup" property allows deployment to be configured to occur on startup (creation of the EntityManagerFactory), instead of occurring the first time an EntityManager is created. |
static java.lang.String |
DESCRIPTOR_CUSTOMIZER_ The "eclipselink.descriptor.customizer." |
static java.lang.String |
DROP_AND_CREATE The parameter value "drop-and-create-tables" For use with the "eclipselink.ddl-generation" property. |
static java.lang.String |
DROP_JDBC_DDL_FILE The property "eclipselink.drop-ddl-jdbc-file-name" Specifies the name of the DDL file which is used to drop database tables. |
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 |
ID_VALIDATION The "eclipselink.id-validation" property defines which primary key components values are considered invalid. |
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 The system property INTERACT_WITH_DB Specified to enable or disable the execution of DDL (configured with the eclipselink.ddl-generation property) against a database. |
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 Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_INITIAL |
static java.lang.String |
JDBC_CONNECTIONS_MAX Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_MAX |
static java.lang.String |
JDBC_CONNECTIONS_MIN Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_MIN |
static java.lang.String |
JDBC_CONNECTIONS_WAIT Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_WAIT |
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 Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_INITIAL |
static java.lang.String |
JDBC_READ_CONNECTIONS_MAX Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_MAX |
static java.lang.String |
JDBC_READ_CONNECTIONS_MIN Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_MIN |
static java.lang.String |
JDBC_READ_CONNECTIONS_SHARED Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_SHARED |
static java.lang.String |
JDBC_SEQUENCE_CONNECTION_POOL Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_SEQUENCE |
static java.lang.String |
JDBC_SEQUENCE_CONNECTION_POOL_DATASOURCE Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_NON_JTA_DATA_SOURCE |
static java.lang.String |
JDBC_SEQUENCE_CONNECTION_POOL_INITIAL Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_INITIAL |
static java.lang.String |
JDBC_SEQUENCE_CONNECTION_POOL_MAX Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_MAX |
static java.lang.String |
JDBC_SEQUENCE_CONNECTION_POOL_MIN Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_MIN |
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 Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_INITIAL |
static java.lang.String |
JDBC_WRITE_CONNECTIONS_MAX Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_MAX |
static java.lang.String |
JDBC_WRITE_CONNECTIONS_MIN Deprecated. as of EclipseLink 2.2 replaced by CONNECTION_POOL_MIN |
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_PARAMETERS By default sql bind paramters are displayed in exceptions and logs when the log level is FINE or greater. |
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 |
METADATA_SOURCE The "eclipselink.metadata-source" property configures the type of MetadataSource implementation to use to read Metadata Values (case insensitive): "XML": Use XMLMetadataSource Custom MetadataSource - Specify a custom class name which implements MetadataSource |
static java.lang.String |
METADATA_SOURCE_XML_FILE The property "eclipselink.metadata-repository.xml.file" Specifies the name of the metadata repository xml file to read from using classloader to find the resource This property should be used in conjunction with the "eclipselink.metadata-repository" when an XML repository is being used. |
static java.lang.String |
METADATA_SOURCE_XML_URL The property "eclipselink.metadata-repository.xml.URL" Specifies the name of the metadata repository xml URL to read from. |
static java.lang.String |
MULTITENANT_PROPERTY_DEFAULT The "eclipselink.tenant-id" property specifies the default context property used to populate multitenant entities. |
static java.lang.String |
MULTITENANT_SHARED_CACHE Property "eclipselink.multitenant.tenants-share-cache specifies that multitenant entities will share the L2 cache. |
static java.lang.String |
MULTITENANT_SHARED_EMF Property "eclipselink.multitenant.shared-emf is used to indicate that multitenant entities will be used within a shared entity manager factory. |
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 The parameter value "none" For use with the "eclipselink.ddl-generation" property, and is the default parameter value. |
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 |
ORDER_UPDATES Configures if updates should be ordered by primary key. |
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 |
PARTITIONING "eclipselink.partitioning" Used to set the default PartitioningPolicy for a persistence unit. |
static java.lang.String |
PARTITIONING_CALLBACK "eclipselink.partitioning.callback" Used to integrate with an external DataSource's data affinity support, such as UCP. |
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. |
private static java.util.Set<java.lang.String> |
supportedNonServerSessionProperties INTERNAL: The following properties passed to Persistence.createEntityManagerFactory(String, Map) cached and processed on the EntityManagerFactory directly. |
static java.lang.String |
TABLE_CREATION_SUFFIX The "eclipselink.ddl.table-creation-suffix" property is used in conjunction with DDL generation options to append a string to the end of generated CREATE Table statements This value is applied to all Table creation statements through the DDL generation feature ie <property name="eclipselink_ddl_table_creation_suffix" value="engine=InnoDB"/> |
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 |
UPPERCASE_COLUMN_NAMES The "eclipselink.jpa.uppercase-column-names" property configures JPA processing to uppercase all column name definitions. |
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 The "eclipselink.validation-only" property validates deployment which includes initializing descriptors but does not connect (no login to the database). |
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 |
---|
public static final java.lang.String TRANSACTION_TYPE
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"
public static final java.lang.String JTA_DATASOURCE
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
public static final java.lang.String NON_JTA_DATASOURCE
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
public static final java.lang.String JDBC_DRIVER
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: <property name="javax_persistence_jdbc_driver" value="com.mysql.jdbc.Driver" />
The previous value for this property "eclipselink.jdbc.driver
is now deprecated and should be replaced with this new name.
public static final java.lang.String JDBC_URL
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: <property name="javax_persistence_jdbc_url" value="jdbc:mysql://localhost/mysql" />
The previous value for this property "eclipselink.jdbc.url
is now deprecated and should be replaced with this new name.
public static final java.lang.String JDBC_USER
javax.persistence.jdbc.user"
property specifies the data source or JDBC user name.
Persistence XML example: <property name="javax_persistence_jdbc_user" value="user-name" />
The previous value for this property "eclipselink.jdbc.user
is now deprecated and should be replaced with this new name.
public static final java.lang.String JDBC_PASSWORD
javax.persistence.jdbc.password"
property specifies the data source or JDBC password.
Persistence XML example: <property name="javax_persistence_jdbc_password" value="password" />
The previous value for this property "eclipselink.jdbc.password
is now deprecated and should be replaced with this new name.
public static final java.lang.String NATIVE_SQL
"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):
DatabaseLogin.setUsesNativeSQL(boolean)
, Constant Field Valuespublic static final java.lang.String SQL_CAST
"eclipselink.jdbc.sql-cast"
property specifies is platform specific CAST SQL operations should be used. Casting is normally not required, and can cause issues when used. Allowed Values (String):
DatabasePlatform.setIsCastRequired(boolean)
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL_WAIT
"wait"
property. This can be append to any connection pool property, i.e. "eclipselink.jdbc.connection_pool.default.wait"
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.
CONNECTION_POOL
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL_MAX
"max"
property. This can be append to any connection pool property, i.e. "eclipselink.jdbc.connection_pool.default.max"
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.
CONNECTION_POOL
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL_MIN
"min"
property. This can be append to any connection pool property, i.e. "eclipselink.jdbc.connection_pool.default.min"
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.
CONNECTION_POOL
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL_INITIAL
"initial"
property. This can be append to any connection pool property, i.e. "eclipselink.jdbc.connection_pool.default.initial"
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.
CONNECTION_POOL
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL_SHARED
"shared"
property. This can be append to the read connection pool, i.e. "eclipselink.jdbc.connection_pool.read.shared"
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.
Values (case insensitive):
CONNECTION_POOL_READ
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL_URL
"url"
property. This can be append to a connection pool property, i.e. "eclipselink.jdbc.connection_pool.node1.url"
Configures the JDBC url to use for the connection pool. Only required if different than the default.
CONNECTION_POOL
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL_JTA_DATA_SOURCE
"jtaDataSource"
property. This can be append to a connection pool property, i.e. "eclipselink.jdbc.connection_pool.node1.jtaDataSource"
Configures the JTA DataSource name to use for the connection pool. Only required if different than the default.
CONNECTION_POOL
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL_NON_JTA_DATA_SOURCE
"nonJtaDataSource"
property. This can be append to a connection pool property, i.e. "eclipselink.jdbc.connection_pool.node1.nonJtaDataSource"
Configures the non JTA DataSource name to use for the connection pool. Only required if different than the default.
CONNECTION_POOL
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL_USER
"user"
property. This can be append to a connection pool property, i.e. "eclipselink.jdbc.connection_pool.node1.user"
Configures the user name to use for the connection pool. Only required if different than the default.
CONNECTION_POOL
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL_PASSWORD
"password"
property. This can be append to a connection pool property, i.e. "eclipselink.jdbc.connection_pool.node1.password"
Configures the password to use for the connection pool. Only required if different than the default.
CONNECTION_POOL
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL_FAILOVER
"failover"
property. This can be append to a connection pool property, i.e. "eclipselink.jdbc.connection_pool.node1.failover"
Configures the connection pool(s) to fail-over to if this connection pool fails. A comma separate list is allowed if multiple failover pools are required.
CONNECTION_POOL
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL
"eclipselink.connection-pool."
properties. The name of the connection pool must be appended to configure the pool, if no name is appended the default (write) pool is configured. The name of the property to configure must also be appended.
A user defined connection pool can be configured or one of the following system pools:
The following connection pool properties can be configured:
Example:
<property name="eclipselink_connection_pool_node2_min" value="16"/> <property name="eclipselink_connection_pool_node2_max" value="16"/> <property name="eclipselink_connection_pool_node2_url" value="jdbc:oracle:thin:@node2:1521:orcl"/>
CONNECTION_POOL_READ
, CONNECTION_POOL_SEQUENCE
, CONNECTION_POOL_INITIAL
, CONNECTION_POOL_MIN
, CONNECTION_POOL_MAX
, CONNECTION_POOL_WAIT
, CONNECTION_POOL_USER
, CONNECTION_POOL_PASSWORD
, CONNECTION_POOL_URL
, CONNECTION_POOL_JTA_DATA_SOURCE
, CONNECTION_POOL_NON_JTA_DATA_SOURCE
, CONNECTION_POOL_SHARED
, ConnectionPool
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL_READ
"eclipselink.connection-pool.read."
properties. The read connection pool is used for non-transaction read queries. By default a separate read connection pool is not used, and the default pool is used for read queries.
One of the following connection pool properties must be appended.
CONNECTION_POOL_INITIAL
, CONNECTION_POOL_MIN
, CONNECTION_POOL_MAX
, CONNECTION_POOL_WAIT
, CONNECTION_POOL_USER
, CONNECTION_POOL_PASSWORD
, CONNECTION_POOL_URL
, CONNECTION_POOL_JTA_DATA_SOURCE
, CONNECTION_POOL_NON_JTA_DATA_SOURCE
, ReadConnectionPool
, Constant Field Valuespublic static final java.lang.String CONNECTION_POOL_SEQUENCE
"eclipselink.connection-pool.sequence."
properties. The sequence connection pool is used to allocate generated Ids. This is only required for TABLE sequencing. By default a separate sequence connection pool is not used, and the default pool is used for sequencing.
One of the following connection pool properties must be appended.
CONNECTION_POOL_INITIAL
, CONNECTION_POOL_MIN
, CONNECTION_POOL_MAX
, CONNECTION_POOL_WAIT
, CONNECTION_POOL_USER
, CONNECTION_POOL_PASSWORD
, CONNECTION_POOL_URL
, CONNECTION_POOL_JTA_DATA_SOURCE
, CONNECTION_POOL_NON_JTA_DATA_SOURCE
, ReadConnectionPool
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_CONNECTIONS_WAIT
"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.
CONNECTION_POOL_WAIT
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_CONNECTIONS_MAX
"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.
CONNECTION_POOL_MAX
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_CONNECTIONS_MIN
"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.
CONNECTION_POOL_MIN
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_CONNECTIONS_INITIAL
"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.
CONNECTION_POOL_INITIAL
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_WRITE_CONNECTIONS_MAX
"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.
CONNECTION_POOL_MAX
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_WRITE_CONNECTIONS_MIN
"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.
CONNECTION_POOL_MIN
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_WRITE_CONNECTIONS_INITIAL
"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.
The value must be a string containing a zero or greater integer value.
CONNECTION_POOL_INITIAL
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_READ_CONNECTIONS_MAX
"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.
The value specified should be a string containing a zero or greater integer value.
to configure the timeout waiting on a connection.
, CONNECTION_POOL_MAX
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_READ_CONNECTIONS_MIN
"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.
The value specified should be a string containing a zero or greater integer value.
CONNECTION_POOL_MIN
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_READ_CONNECTIONS_INITIAL
"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.
The value must be a string containing a zero or greater integer value.
CONNECTION_POOL_INITIAL
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_READ_CONNECTIONS_SHARED
"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.
Values (case insensitive):
CONNECTION_POOL_SHARED
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_SEQUENCE_CONNECTION_POOL_MAX
"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.
The value must be a string containing a zero or greater integer value. The default value is two (2).
Required to configure the use of a sequence pool/data-source
, to configure the timeout
, CONNECTION_POOL_MAX
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_SEQUENCE_CONNECTION_POOL_MIN
"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.
The value must be a string containing a zero or greater integer value. The default value is two (2).
Required to configure the use of a sequence pool/data-source
, CONNECTION_POOL_MIN
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_SEQUENCE_CONNECTION_POOL_INITIAL
"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.
The value must be a string containing a zero or greater integer value. The default value is two (2).
Required to configure the use of a sequence pool/data-source
, CONNECTION_POOL_INITIAL
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_SEQUENCE_CONNECTION_POOL
"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):
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
, CONNECTION_POOL_SEQUENCE
, Constant Field Values
@Deprecated
public static final java.lang.String JDBC_SEQUENCE_CONNECTION_POOL_DATASOURCE
"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.
JDBC_SEQUENCE_CONNECTION_POOL
, CONNECTION_POOL_NON_JTA_DATA_SOURCE
, Constant Field Valuespublic static final java.lang.String PARTITIONING
Used to set the default PartitioningPolicy for a persistence unit. A PartitioningPolicy is used to partition the data for a class across multiple difference databases or across a database cluster such as Oracle RAC. Partitioning can provide improved scalability by allowing multiple database machines to service requests.
If multiple partitions are used to process a single transaction, JTA should be used for proper XA transaction support.
The value must be set to the name of an existing defined PartitioningPolicy.
Partitioning
, PartitioningPolicy
, Constant Field Valuespublic static final java.lang.String PARTITIONING_CALLBACK
Used to integrate with an external DataSource's data affinity support, such as UCP.
The value must be set to the full class name of the implementor of the DataPartitioningCallback interface.
i.e. "org.eclipse.persistence.platform.database.oracle.ucp.UCPDataPartitioningCallback".
DataPartitioningCallback
, Partitioning
, PartitioningPolicy
, Constant Field Valuespublic static final java.lang.String JDBC_BIND_PARAMETERS
"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:
public static final java.lang.String EXCLUSIVE_CONNECTION_MODE
"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:
ExclusiveConnectionMode.Transactional
ExclusiveConnectionMode.Isolated
ExclusiveConnectionMode.Always
ExclusiveConnectionMode
, Constant Field Valuespublic static final java.lang.String EXCLUSIVE_CONNECTION_IS_LAZY
"eclipselink.jdbc.exclusive-connection.is-lazy"
property specifies when write connection is acquired lazily.
Values:
public static final java.lang.String CACHE_STATEMENTS_SIZE
"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".
public static final java.lang.String CACHE_STATEMENTS
"eclipselink.jdbc.cache-statements"
property specifies whether JDBC statements should be cached. This is recommended when using EclipseLink's internal connection pooling.
Valid values:
Example: persistence.xml file <property name="eclipselink_jdbc_cache_statements" value="false"/>
Example: property Map propertiesMap.put(PersistenceUnitProperties.CACHE_STATEMENTS, "false");
public static final java.lang.String VALIDATOR_FACTORY
"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()
public static final java.lang.String VALIDATION_MODE
"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".
public static final java.lang.String VALIDATION_GROUP_PRE_PERSIST
"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
public static final java.lang.String VALIDATION_GROUP_PRE_UPDATE
"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
public static final java.lang.String VALIDATION_GROUP_PRE_REMOVE
"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.
public static final java.lang.String DEFAULT
CACHE_SIZE_
, CACHE_TYPE_
, CACHE_SHARED_
, Constant Field Valuespublic static final java.lang.String CACHE_SIZE_
"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.
CACHE_SIZE_DEFAULT
, Constant Field Valuespublic static final java.lang.String CACHE_TYPE_
CACHE_SHARED_
, CacheType
, CACHE_TYPE_DEFAULT
, Constant Field Valuespublic static final java.lang.String CACHE_SHARED_
CACHE_SHARED_DEFAULT
, Constant Field Valuespublic static final java.lang.String CACHE_SIZE_DEFAULT
public static final java.lang.String CACHE_TYPE_DEFAULT
CACHE_SHARED_DEFAULT
, Constant Field Valuespublic static final java.lang.String CACHE_SHARED_DEFAULT
public static final java.lang.String LOGGING_LOGGER
LoggerType
, Constant Field Valuespublic static final java.lang.String LOGGING_LEVEL
"eclipselink.logging.level
allows the default logging levels to be specified.
Java example: props.put(PersistenceUnitProperties.LOGGING_LEVEL, SessionLog.FINE_LABEL);
XML example:
<property name="eclipselink_logging_level" value="FINE" />;
Logging Levels:
= "OFF"
, = "SEVERE"
, = "WARNING"
, = "CONFIG"
, = "INFO" (DEFAULT)
, = "FINE"
, = "FINER"
, = "FINEST"
, = "ALL"
, for category specific level configuration
, Constant Field Valuespublic static final java.lang.String CATEGORY_LOGGING_LEVEL_
"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:
<property name="eclipselink_logging_level_ejb_or_metadata" value="WARNING" />;
specific Valid values are names of levels defined in java.util.logging.Level, default value is INFO.
Categories:
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 Valuespublic static final java.lang.String LOGGING_PARAMETERS
JDBC_BIND_PARAMETERS
, Constant Field Valuespublic static final java.lang.String LOGGING_TIMESTAMP
"eclipselink.logging.timestamp"
property configures if the current timestamp should be included in each log message.
Values:
public static final java.lang.String MULTITENANT_PROPERTY_DEFAULT
"eclipselink.tenant-id"
property specifies the default context property used to populate multitenant entities. NOTE: This is merely a default multitenant property than can be used on its own or with other properties defined by the user. Users are not obligated to use this property and are free to specify their own.
Multitenant
, Example: persistence.xml file <property name="eclipselink_tenant_id" value="Oracle"/>
Example: property Map propertiesMap.put(PersistenceUnitProperties.MULTITENANT_PROPERTY_DEFAULT, "Oracle");
, Constant Field Valuespublic static final java.lang.String MULTITENANT_SHARED_CACHE
"eclipselink.multitenant.tenants-share-cache
specifies that multitenant entities will share the L2 cache. By default this property is false meaning multitenant entities will have an ISOLATED setting. When setting it to true a PROTECTED cache setting will be used. WARNING: Queries that use the cache may return data from other tenants when using the PROTECTED setting.
Java example:
props.put(PersistenceUnitProperties.MULTITENANT_SHARED_CACHE, true);
XML example:
, Constant Field Values<property name="eclipselink_multitenant_tenants_share_cache" value="true" />;
public static final java.lang.String MULTITENANT_SHARED_EMF
"eclipselink.multitenant.shared-emf
is used to indicate that multitenant entities will be used within a shared entity manager factory. This property defaults to true (and applies to multitenant entities only). When setting it to false, users are required to provide a unique session name.
eclipselink.session-name
,
Java example:
props.put(PersistenceUnitProperties.MULTITENANT_SHARED_EMF, true);
XML example:
, Constant Field Values<property name="eclipselink_multitenant_tenants_share_emf" value="true" />;
public static final java.lang.String LOGGING_THREAD
"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:
public static final java.lang.String LOGGING_SESSION
"eclipselink.logging.session"
indicating if the session in use should have its identity included in each log message.
Values:
public static final java.lang.String LOGGING_CONNECTION
"eclipselink.logging.connection"
Values:
public static final java.lang.String LOGGING_EXCEPTIONS
public static final java.lang.String LOGGING_FILE
"eclipselink.logging.file"
property configures a file location where the log will be output to instead of standard out.
public static final java.lang.String TABLE_CREATION_SUFFIX
"eclipselink.ddl.table-creation-suffix"
property is used in conjunction with DDL generation options to append a string to the end of generated CREATE Table statements This value is applied to all Table creation statements through the DDL generation feature ie <property />
public static final java.lang.String TARGET_DATABASE
"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.
"eclipselink.target-database"
must be specified with a non-"Auto" class name or short name when "eclipselink.validation-only"
is set to "True"
.
TargetDatabase
, DatabasePlatform
, Constant Field Valuespublic static final java.lang.String EXCLUDE_ECLIPSELINK_ORM_FILE
"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.
public static final java.lang.String SESSION_NAME
"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.
public static final java.lang.String WEAVING
"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):
public static final java.lang.String WEAVING_INTERNAL
"eclipselink.weaving.internal"
property indicates whether internal optimizations should be enabled through weaving. Internal optimizations include caching of primary key and session, addition of a serialVersionUID if none exists, optimization of EclipseLink's cloning strategy and optimization of the way EclipseLink gets and sets values from fields mapped as Basic.
This property will only be considered if weaving is enabled.
Values (case insensitive):
WEAVING
, Constant Field Valuespublic static final java.lang.String WEAVING_LAZY
"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):
WEAVING
, Constant Field Valuespublic static final java.lang.String WEAVING_EAGER
"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):
WEAVING
, Constant Field Valuespublic static final java.lang.String WEAVING_CHANGE_TRACKING
"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):
WEAVING
, Constant Field Valuespublic static final java.lang.String WEAVING_FETCHGROUPS
"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):
WEAVING
, FetchGroupManager
, FetchGroup
, Constant Field Valuespublic static final java.lang.String TARGET_SERVER
"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.
TargetServer
, Constant Field Valuespublic static final java.lang.String SESSION_CUSTOMIZER
"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.
SessionCustomizer
, Constant Field Valuespublic static final java.lang.String DESCRIPTOR_CUSTOMIZER_
"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.
DescriptorCustomizer
, Constant Field Valuespublic static final java.lang.String NATIVE_QUERY_UPPERCASE_COLUMNS
"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.
public static final java.lang.String UPPERCASE_COLUMN_NAMES
"eclipselink.jpa.uppercase-column-names"
property configures JPA processing to uppercase all column name definitions. A value of true also sets the "eclipselink.jdbc.uppercase-columns"
property to true, so that JDBC meta-data returned from the database is also returned in uppercase, ensuring fields are the same case. This gets around situations where user defined fields do not match the case returned by the database for native queries, simulating case insensitivity.
Values (case insensitive):
public static final java.lang.String BATCH_WRITING
"eclipselink.jdbc.batch-writing"
property configures the use of batch writing to optimize transactions with multiple writes.
Values (case insensitive):
BatchWriting
, Constant Field Valuespublic static final java.lang.String BATCH_WRITING_SIZE
"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.
BATCH_WRITING
, Constant Field Valuespublic static final java.lang.String ECLIPSELINK_PERSISTENCE_XML
"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.
public static final java.lang.String ECLIPSELINK_PERSISTENCE_XML_DEFAULT
public static final java.lang.String ECLIPSELINK_PERSISTENCE_UNITS
"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.
public static final java.lang.String EXCEPTION_HANDLER_CLASS
"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.
ExceptionHandler
, Constant Field Valuespublic static final java.lang.String INCLUDE_DESCRIPTOR_QUERIES
"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".
public static final java.lang.String SESSION_EVENT_LISTENER_CLASS
"eclipselink.session-event-listener"
property configures a session event listener class.
SessionEventListener
, as a means to configure multiple listeners using API
, Constant Field Valuespublic static final java.lang.String SESSIONS_XML
"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.
public static final java.lang.String TEMPORAL_MUTABLE
"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.
public static final java.lang.String ALLOW_NATIVE_SQL_QUERIES
"eclipselink.jdbc.allow-native-sql-queries"
property specifies whether any user defined SQL is allowed within a persistence unit. This is of particular importance within a multitenant to minimize the potential impact of revealing multi tenant information. By default any persistence unit containing at least one multitenant entity will cause this flag to be set to 'false'.
Allowed Values (String):
Project#setAllowNativeSQLQueries(boolean)
, Constant Field Valuespublic static final java.lang.String ALLOW_ZERO_ID
"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.
Caution: This property configures the static singleton on Helper#isZeroValidPrimaryKey
which will be shared by all concurrent uses of EclipseLink.
PrimaryKey
, IdValidation
, Constant Field Valuespublic static final java.lang.String ID_VALIDATION
"eclipselink.id-validation"
property defines which primary key components values are considered invalid. These values will be also overridden by sequencing. Note that Identity always overrides any existing id value and so does any sequence with shouldAlwaysOverrideExistingValue flag set to true.
PrimaryKey
, IdValidation
, Constant Field Valuespublic static final java.lang.String FLUSH_CLEAR_CACHE
FlushClearCache
, Constant Field Valuespublic static final java.lang.String CLASSLOADER
public static final java.lang.String THROW_EXCEPTIONS
public static final java.lang.String ORM_SCHEMA_VALIDATION
public static final java.lang.String DEPLOY_ON_STARTUP
"eclipselink.deploy-on-startup"
property allows deployment to be configured to occur on startup (creation of the EntityManagerFactory), instead of occurring the first time an EntityManager is created. This may increase startup time of a JavaEE server, but will avoid the first request from hanging as the persistence unit is deployed.
Values: A boolean value of "True" or (default "False").
public static final java.lang.String VALIDATION_ONLY_PROPERTY
"eclipselink.validation-only"
property validates deployment which includes initializing descriptors but does not connect (no login to the database).
Values: A boolean value of "True" or (default "False").
Note:"eclipselink.target-database"
must be specified with a non-"Auto" class name or short name when "eclipselink.validation-only"
is set to "True"
.
TargetDatabase
, Constant Field Valuespublic static final java.lang.String DDL_GENERATION
public static final java.lang.String CREATE_ONLY
"create-tables"
For use with the "eclipselink.ddl-generation"
property.
Specifies that database tables should be created.
DDL_GENERATION
, Constant Field Valuespublic static final java.lang.String DROP_AND_CREATE
"drop-and-create-tables"
For use with the "eclipselink.ddl-generation"
property.
Specifies that database tables should be dropped, then created.
DDL_GENERATION
, Constant Field Valuespublic static final java.lang.String NONE
"none"
For use with the "eclipselink.ddl-generation"
property, and is the default parameter value.
Specifies that database tables should not be created or dropped.
DDL_GENERATION
, Constant Field Valuespublic static final java.lang.String METADATA_SOURCE
"eclipselink.metadata-source"
property configures the type of MetadataSource implementation to use to read Metadata
Values (case insensitive):
XMLMetadataSource
MetadataSource
MetadataSource
, Constant Field Valuespublic static final java.lang.String METADATA_SOURCE_XML_FILE
"eclipselink.metadata-repository.xml.file"
Specifies the name of the metadata repository xml file to read from using classloader to find the resource
This property should be used in conjunction with the "eclipselink.metadata-repository"
when an XML repository is being used.
METADATA_SOURCE
, Constant Field Valuespublic static final java.lang.String METADATA_SOURCE_XML_URL
"eclipselink.metadata-repository.xml.URL"
Specifies the name of the metadata repository xml URL to read from.
This property should be used in conjunction with the "eclipselink.metadata-repository"
when an XML repository is being used.
METADATA_SOURCE
, Constant Field Valuespublic static final java.lang.String APP_LOCATION
"eclipselink.application-location"
Specifies the file system directory location where DDL files are written (output) to.
This property should be used in conjunction with the "eclipselink.ddl-generation.output-mode"
property, with a setting of "sql-script"
(or "both"
) for DDL file(s) to be written.
DEFAULT_APP_LOCATION
, DDL_GENERATION_MODE
, DDL_SQL_SCRIPT_GENERATION
, DDL_BOTH_GENERATION
, Constant Field Valuespublic static final java.lang.String CREATE_JDBC_DDL_FILE
"eclipselink.create-ddl-jdbc-file-name"
Specifies the name of the DDL file which is used to create database tables.
This property should be used in conjunction with the "eclipselink.application-location"
property to specify a location on the file system for DDL file(s) to be written.
APP_LOCATION
, DEFAULT_CREATE_JDBC_FILE_NAME
, Constant Field Valuespublic static final java.lang.String DROP_JDBC_DDL_FILE
"eclipselink.drop-ddl-jdbc-file-name"
Specifies the name of the DDL file which is used to drop database tables.
This property should be used in conjunction with the "eclipselink.application-location"
property to specify a location on the file system for DDL file(s) to be written.
APP_LOCATION
, DEFAULT_DROP_JDBC_FILE_NAME
, Constant Field Valuespublic static final java.lang.String DEFAULT_APP_LOCATION
APP_LOCATION
public static final java.lang.String DEFAULT_CREATE_JDBC_FILE_NAME
createDDL.jdbc
CREATE_JDBC_DDL_FILE
, Constant Field Valuespublic static final java.lang.String DEFAULT_DROP_JDBC_FILE_NAME
dropDDL.jdbc
DROP_JDBC_DDL_FILE
, Constant Field Valuespublic static final java.lang.String JAVASE_DB_INTERACTION
INTERACT_WITH_DB
Specified to enable or disable the execution of DDL (configured with the eclipselink.ddl-generation
property) against a database.
e.g. a command line setting of -DINTERACT_WITH_DB=false
will not output DDL to the database.
Valid values:
true
- output DDL to the databasefalse
- do not output DDL to the database
DDL_GENERATION
, Constant Field Valuespublic static final java.lang.String DDL_GENERATION_MODE
DEFAULT_DDL_GENERATION_MODE
, DDL_DATABASE_GENERATION
, DDL_SQL_SCRIPT_GENERATION
, DDL_BOTH_GENERATION
, Constant Field Valuespublic static final java.lang.String DDL_SQL_SCRIPT_GENERATION
"sql-script"
For use with the "eclipselink.ddl-generation.output-mode"
property.
Specifies that DDL will be written to file(s).
DDL_GENERATION_MODE
, CREATE_JDBC_DDL_FILE
, DROP_JDBC_DDL_FILE
, Constant Field Valuespublic static final java.lang.String DDL_DATABASE_GENERATION
"database"
For use with the "eclipselink.ddl-generation.output-mode"
property, and is the default parameter value
Specifies that DDL will be written to the database.
DDL_GENERATION_MODE
, CREATE_JDBC_DDL_FILE
, DROP_JDBC_DDL_FILE
, Constant Field Valuespublic static final java.lang.String DDL_BOTH_GENERATION
"both"
For use with the "eclipselink.ddl-generation.output-mode"
property.
Specifies that DDL will be written to file(s) and the database.
DDL_GENERATION_MODE
, CREATE_JDBC_DDL_FILE
, DROP_JDBC_DDL_FILE
, Constant Field Valuespublic static final java.lang.String DEFAULT_DDL_GENERATION_MODE
eclipselink.ddl-generation.output-mode
parameter is configured to the default value of database
.
DDL_GENERATION_MODE
, DDL_DATABASE_GENERATION
, Constant Field Valuespublic static final java.lang.String VALIDATE_EXISTENCE
"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.
public static final java.lang.String ORDER_UPDATES
public static final java.lang.String PROFILER
"eclipselink.profiler"
property configures the type of profiler used to capture runtime statistics.
Values (case insensitive):
PerformanceMonitor
PerformanceProfiler
QueryMonitor
SessionProfiler
ProfilerType
, Constant Field Valuespublic static final java.lang.String JOIN_EXISTING_TRANSACTION
"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 EntityManagers pass it to createEntityManager method.
Values (caseinsensitive):
public static final java.lang.String PERSISTENCE_CONTEXT_REFERENCE_MODE
"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:
ReferenceMode
, Constant Field Valuespublic static final java.lang.String PESSIMISTIC_LOCK_TIMEOUT
"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.
public static final java.lang.String QUERY_TIMEOUT
"javax.persistence.query.timeout"
property configures the default query timeout value.
Valid values are strings containing integers zero or greater.
public static final java.lang.String PERSISTENCE_CONTEXT_CLOSE_ON_COMMIT
"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):
public static final java.lang.String PERSISTENCE_CONTEXT_PERSIST_ON_COMMIT
"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):
public static final java.lang.String PERSISTENCE_CONTEXT_COMMIT_WITHOUT_PERSIST_RULES
"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):
public static final java.lang.String PERSISTENCE_CONTEXT_FLUSH_MODE
"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.
EntityManager.setFlushMode(javax.persistence.FlushModeType)
, FlushModeType
, Constant Field Valuespublic static final java.lang.String ORACLE_PROXY_TYPE
"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:
Property values corresponding to the specified type should be also provided:
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.
public static final java.lang.String COORDINATION_PROTOCOL
"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:
CacheCoordinationProtocol
, Cache.coordinationType()
, RemoteCommandManager.setTransportManager(TransportManager)
, Constant Field Valuespublic static final java.lang.String COORDINATION_JMS_HOST
"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. This is not required in the topic is distributed across the cluster (can be looked up in local JNDI).
COORDINATION_PROTOCOL
, JMSPublishingTransportManager.setTopicHostUrl(String)
, Constant Field Valuespublic static final java.lang.String COORDINATION_JMS_TOPIC
"eclipselink.cache.coordination.jms.topic"
property configures cache coordination for a clustered environment. Only used for JMS coordination. Sets the JMS topic name. The default topic JNDI name is "jms/EclipseLinkTopic".
COORDINATION_PROTOCOL
, BroadcastTransportManager.setTopicName(String)
, Constant Field Valuespublic static final java.lang.String COORDINATION_JMS_FACTORY
"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. The default topic connection factory JNDI name is "jms/EclipseLinkTopicConnectionFactory".
COORDINATION_PROTOCOL
, org.eclipse.persistence.sessions.coordination.broadcast.BroadcastTransportManager#setTopicConnectionFactoryName(String)
, Constant Field Valuespublic static final java.lang.String COORDINATION_JMS_REUSE_PUBLISHER
"eclipselink.cache.coordination.jms.reuse-topic-publisher"
property configures cache coordination for a clustered environment. Only used for JMS coordination. Sets the JSM transport manager to cache a TopicPubliser and reuse it for all cache coordination publishing. Default value if unset is false.
COORDINATION_PROTOCOL
, JMSPublishingTransportManager.setShouldReuseJMSTopicPublisher(boolean)
, Constant Field Valuespublic static final java.lang.String COORDINATION_RMI_ANNOUNCEMENT_DELAY
"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. Default is 1000 milliseconds.
COORDINATION_PROTOCOL
, DiscoveryManager.setAnnouncementDelay(int)
, Constant Field Valuespublic static final java.lang.String COORDINATION_RMI_MULTICAST_GROUP
"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. The default address is 239.192.0.0.
COORDINATION_PROTOCOL
, DiscoveryManager.setMulticastGroupAddress(String)
, Constant Field Valuespublic static final java.lang.String COORDINATION_RMI_MULTICAST_GROUP_PORT
"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. The default port is 3121.
COORDINATION_PROTOCOL
, DiscoveryManager.setMulticastPort(int)
, Constant Field Valuespublic static final java.lang.String COORDINATION_RMI_PACKET_TIME_TO_LIVE
"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.
COORDINATION_PROTOCOL
, DiscoveryManager.setPacketTimeToLive(int)
, Constant Field Valuespublic static final java.lang.String COORDINATION_RMI_URL
"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. This may not be required in a clustered enviroment where JNDI is replicated. This can also be set as a System property or using a SessionCustomizer to avoid a seperate persistence.xml per server.
COORDINATION_PROTOCOL
, RemoteCommandManager.setUrl(String)
, Constant Field Valuespublic static final java.lang.String COORDINATION_NAMING_SERVICE
"eclipselink.cache.coordination.naming-service"
property configures cache coordination for a clustered environment. Set the naming service to use, either "jndi" or "rmi".
COORDINATION_PROTOCOL
, TransportManager.setNamingServiceType(int)
, Constant Field Valuespublic static final java.lang.String COORDINATION_JNDI_USER
"eclipselink.cache.coordination.jndi.user"
property configures cache coordination for a clustered environment. Set the JNDI naming service user name. This is not normally require if connecting to the local server.
COORDINATION_PROTOCOL
, TransportManager.setUserName(String)
, Constant Field Valuespublic static final java.lang.String COORDINATION_JNDI_PASSWORD
"eclipselink.cache.coordination.jndi.password"
property configures cache coordination for a clustered environment. Set the JNDI naming service user name. This is not normally require if connecting to the local server.
COORDINATION_PROTOCOL
, TransportManager.setPassword(String)
, Constant Field Valuespublic static final java.lang.String COORDINATION_JNDI_CONTEXT
"eclipselink.cache.coordination.jndi.initial-context-factory"
property configures cache coordination for a clustered environment. Set the JNDI InitialContext factory. This is not normally require if connecting to the local server.
COORDINATION_PROTOCOL
, TransportManager.setInitialContextFactoryName(String)
, Constant Field Valuespublic static final java.lang.String COORDINATION_REMOVE_CONNECTION
"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).
COORDINATION_PROTOCOL
, TransportManager.setShouldRemoveConnectionOnError(boolean)
, Constant Field Valuespublic static final java.lang.String COORDINATION_ASYNCH
"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.
COORDINATION_PROTOCOL
, RemoteCommandManager.setShouldPropagateAsynchronously(boolean)
, Constant Field Valuespublic static final java.lang.String COORDINATION_CHANNEL
"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. The default channel name is "EclipseLinkCommandChannel".
COORDINATION_PROTOCOL
, RemoteCommandManager.setChannel(String)
, Constant Field Valuespublic static final java.lang.String COMPOSITE_UNIT
COMPOSITE_UNIT_MEMBER
, COMPOSITE_UNIT_PROPERTIES
, Constant Field Valuespublic static final java.lang.String COMPOSITE_UNIT_MEMBER
COMPOSITE_UNIT
, COMPOSITE_UNIT_PROPERTIES
, Constant Field Valuespublic static final java.lang.String COMPOSITE_UNIT_PROPERTIES
COMPOSITE_UNIT
, Constant Field Valuespublic static final java.util.Map<java.lang.String,java.lang.String> PROPERTY_LOG_OVERRIDES
private static final java.util.Set<java.lang.String> supportedNonServerSessionProperties
Persistence.createEntityManagerFactory(String, Map)
cached and processed on the EntityManagerFactory
directly. None of these properties processed during pre-deploy or deploy.Constructor Detail |
---|
public PersistenceUnitProperties()
Method Detail |
---|
public static java.lang.String getOverriddenLogStringForProperty(java.lang.String propertyName)
public static java.util.Set<java.lang.String> getSupportedNonServerSessionProperties()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |