Using CA Service Virtualization › Installation and Configuration › DDLs for Major Databases › EclipseLink Properties for a Session

EclipseLink Properties for a Session

You can use the following EclipseLink JPA persistence unit properties in a persistence.xml file to configure EclipseLink extensions for a session, and as the target database and application server.

eclipselink.session-name

Defines the name by which the EclipseLink session is stored in the static session manager. Use this option if you must access the EclipseLink shared session outside of the context of the JPA. Use this option also to use a preexisting EclipseLink session that is configured through an EclipseLink sessions.xml file.

Values: A valid EclipseLink session name that is unique in a server deployment.

Default: EclipseLink-generated unique name.

Example:

persistence.xml file<property value="MySession"/> Example: property Mapimport org.eclipse.persistence.config.PersistenceUnitProperties;propertiesMap.put(PersistenceUnitProperties.SESSION_NAME, "MySession"); 

eclipselink.sessions-xml

Defines the persistence information that is loaded from the EclipseLink session configuration file, sessions.xml.

You can use this option as an alternative to annotations and deployment XML. If you specify this property, EclipseLink overrides all class annotation and the object relational mapping from the persistence.xml, and ORM.xml and other mapping files.

To indicate the session, set the eclipselink.session-name property.

Note: If you do not specify the value for this property, sessions.xml file is not used.

Values: The resource name of the sessions XML file.

Example:

persistence.xml file<property value="mysession.xml"/> Example: property Mapimport org.eclipse.persistence.config.PersistenceUnitProperties;propertiesMap.put(PersistenceUnitProperties.SESSIONS_XML, "mysession.xml");

eclipselink.session-event-listener

Defines a descriptor event listener to be added during bootstrapping.

Values: Qualified class name for a class that implements the org.eclipse.persistence.sessions.SessionEventListener interface.

Example:

Persistence.xml file<property value="mypackage.MyClass.class"/> Example: property Mapimport org.eclipse.persistence.config.PersistenceUnitProperties;propertiesMap.put(PersistenceUnitProperties.SESSION_EVENT_LISTENER_CLASS, "mypackage.MyClass.class");

eclipselink.session.include.descriptor.queries

Specifies whether to copy all named queries from the descriptors to the session by default. These queries include the ones that are defined using EclipseLink API, descriptor amendment methods, and others.

Values:

• true: Enable the default copying of all named queries from the descriptors to the session.
• false: Disable the default copying of all named queries from the descriptors to the session.

Default: true.

Example:

Persistence.xml file<property value="false"/>Example: property Mapimport org.eclipse.persistence.config.PersistenceUnitProperties;propertiesMap.put(PersistenceUnitProperties.INCLUDE_DESCRIPTOR_QUERIES, "false");

eclipselink.target-database

Specifies the type of database that your JPA application uses.

Values:

The following values are valid for use in a persistence.xml file and for the org.eclipse.persistence.config.TargetDatabase:

• Attunity: Configure the persistence provider to use an Attunity database.
• Auto: EclipseLink accesses the database and uses the metadata that JDBC provides to determine the target database. This value applies to the JDBC drivers that support this metadata.
• Cloudscape: Configure the persistence provider to use a Cloudscape database.
• Database: If your target database is not listed here and your JDBC driver does not support the use of metadata that the Auto option requires, configure the persistence provider to use a generic choice.
• DB2: Configure the persistence provider to use a DB2 database.
• DB2Mainframe: Configure the persistence provider to use a DB2 mainframe database.
• DBase: Configure the persistence provider to use a DBase database.
• Derby: Configure the persistence provider to use a Derby database.
• HSQL: Configure the persistence provider to use an HSQL database.
• Informix: Configure the persistence provider to use an Informix database.
• JavaDB: Configure the persistence provider to use a Java DB database.
• MySQL: Configure the persistence provider to use a MySQL database.
• Oracle: Configure the persistence provider to use an Oracle Database.
• PointBase: Configure the persistence provider to use a PointBase database.
• PostgreSQL: Configure the persistence provider to use a PostgreSQL database.
• SQLAnywhere: Configure the persistence provider to use an SQLAnywhere database.
• SQLServer: Configure the persistence provider to use an SQLServer database.
• Sybase: Configure the persistence provider to use a Sybase database.
• TimesTen: Configure the persistence provider to use a TimesTen database. You can also set the value to the fully qualified classname of a subclass of the org.eclipse.persistence.platform.DatabasePlatform class.

Default: Auto

Example:

Persistence.xml file<property value="Oracle"/>Example: property Mapimport org.eclipse.persistence.config.TargetDatabase;import org.eclipse.persistence.config.PersistenceUnitProperties;propertiesMap.put(PersistenceUnitProperties.TARGET_DATABASE, TargetDatabase.Oracle);

eclipselink.target-server

Specifies the type of application server that your JPA application uses.

Values:

The following values are valid for use in the persistence.xml file and the org.eclipse.persistence.config.TargetServer:

• None: Configure the persistence provider to use no application server.
• WebLogic: Configure the persistence provider to use Oracle WebLogic Server. This server sets this property automatically. Set it only if it is disabled.
• WebLogic_9: Configure the persistence provider to use Oracle WebLogic Server version 9.
• WebLogic_10: Configure the persistence provider to use Oracle WebLogic Server version 10.
• OC4J: Configure the persistence provider to use OC4J.
• SunAS9: Configure the persistence provider to use Sun Application Server version 9. This server sets this property automatically. Set it only if it is disabled.
• WebSphere: Configure the persistence provider to use WebSphere Application Server.
• WebSphere_6_1: Configure the persistence provider to use WebSphere Application Server version 6.1.
• JBoss: Configure the persistence provider to use JBoss Application Server.
• The fully qualified class name of a custom server class that implements the org.eclipse.persistence.platform.ServerPlatform interface.

Default: None

Example:

persistence.xml file<property value="OC4J_10_1_3"/>Example: property Mapimport org.eclipse.persistence.config.TargetServer;import org.eclipse.persistence.config.PersistenceUnitProperties;propertiesMap.put(PersistenceUnitProperties.TARGET_SERVER, TargetServer.OC4J_10_1_3);