Skip Headers

# Configuring pm-properties

Previous

Next

When you select TopLink as the persistence manager (see `name` in Table: orion-ejb-jar.xml File persistence-manager Entries), use the `persistence-manager` subentries for `pm-properties` (see Table: orion-ejb-jar.xml File persistence-manager Subentries for pm-properties) to configure the TopLink session that the TopLink run time creates and uses internally for CMP projects. The `persistence-manager` subentries take the place of a `sessions.xml` file in a CMP project.

Note: You can only configure a subset of session features using these properties and in most cases, default configuration applies. To configure all session features and to override defaults, you must use a customization class (see `customization-class` in Table: orion-ejb-jar.xml File persistence-manager Subentries for pm-properties).

orion-ejb-jar.xml File persistence-manager Subentries for pm-properties

Entry | Description
--- | ---

`session-name`

Unique name for this TopLink-persisted EJB deployment JAR file. Must be unique among all TopLink-persisted deployed JAR files in this application server instance.

When the TopLink run time internally creates a TopLink session for this TopLink-persisted deployed JAR file, the TopLink session manager stores the session instance under this `session-name`. For more information about the session manager, see Acquiring and Using Sessions at Run Time).

If you do not specify a name, the TopLink runtime will generate a unique name.

`project-class`

If you export your TopLink mapping metadata to a Java class (that extends `oracle.toplink.sessions.Project`), set this property to the name of the class, fully qualified by its package name. Be sure to include the class file in the deployable JAR file.

Do not set this property if you are using a mapping metadata file (see `descriptor` in Table: orion-ejb-jar.xml File persistence-manager Entries).

`customization-class`

Optional Java class (that implements `oracle.toplink.ejb.cmp.DeploymentCustomization`) used to allow deployment customization of TopLink mapping and run-time configuration. At deployment time, the TopLink run time creates a new instance of this class and invokes its methods `beforeLoginCustomization` (before the TopLink run time logs into the session) and `afterLoginCustomization` (after the TopLink runtime logs into the session), passing in the TopLink session as a parameter.

Use your implementation of the `beforeLoginCustomization` method to configure session attributes not supported by the `pm-properties` including: cache coordination (see also "Configuring cache-synchronization Properties"), parameterized SQL, native SQL, batch writing/batch size, byte-array/string binding, EIS login, event listeners, table qualifier, and sequencing. For more information about session configuration, see Configuring a Session.

The class must be fully qualified by its package name and included in the deployment JAR file.

`db-platform-class` | Optional TopLink database platform class (instance of `oracle.toplink.platform.database` or `oracle.toplink.platform.database.oracle`) containing TopLink support specific to a particular database. Set this value to the database platform class that corresponds to the database that your application uses. The class must be fully qualified by its package name.

`remote-relationships`

Optional flag to allow relationships between remote objects. Valid values are:

- `true`: All relationships will be maintained through the remote interfaces of the entity beans

- `false`: Disables this feature.

`cache-synchronization` | See "Configuring cache-synchronization Properties".
`default-mapping` | See "Configuring default-mapping Properties".