Skip Headers
Oracle® TopLink Migration Instructions
11g Release 1 (11.1.1.1.0)
 

 

Oracle® TopLink

Migration Instructions

11g Release 1 (11.1.1.1.0)

 

July 2009

This document describes how to migrate a TopLink application to the current release, including:


Note:

This document applies to all supported platforms. All file paths and script names are identical on all platforms (except for file extensions: *.sh for Unix and *.cmd for Windows). By default, this document uses the Unix file path separator ( / ). Substitute the file path separator appropriate for your platform as required.


Note:

If you receive ClassNotFound exceptions after you migrate a project, ensure the  JDBC_CLASSPATH variable does not include any Java classes for your persistent business objects. Paths for persistent business objects are set within an TopLink Workbench project. For more information, see "Configuring Project Classpath" in the Oracle Fusion Middleware Developer's Guide for Oracle TopLink.

Also check your project classes for any references to legacy TopLink classes.


1 Migrating Oracle TopLink Projects

In 11g Release 1 (11.1.1.1.0), the classes in the oracle.toplink.* packages (toplink.jar) have been deprecated and replaced with those in org.eclipse.persistence.* (eclipselink.jar).

To continue using the deprecated toplink.jar classes, no migration is required.


Note:

To migrate from a pre-Release 1 (9.0.3) TopLink project, complete the procedure in Section 1.1, "To Use the Package Rename Tool" first using the packageRename.cmd/sh tool, then repeat the procedure using the packageRenameEclipseLink.cmd/sh tool.

To use the new 11g Release 1 (11.1.1.1.0) packages, you must use the packageRenameEclipseLink application to rename your packages. Use the Package Rename tool on your:

The Package Rename tool works on plain text files and must not be used with binary files (such as .jar).

1.1 To Use the Package Rename Tool

Use this procedure to upgrade your existing application source code and TopLink Workbench projects to version 11g Release 1 (11.1.1.1.0).

If you are upgrading a pre-Release


Note:

You must configure your JAVA_HOME environment setting before using the package rename tool. Refer to the Oracle TopLink Installation Instructions for details.

  1. At the command prompt, execute the packageRenameEclipseLink.cmd/sh program located in the TOPLINK_HOME/utils/rename directory. You need to specify three parameters on the command line:

    • the complete directory path that contains the Java source code of your existing project

    • the complete directory path that will contain the upgraded 11g Release 1 (11.1.1.1.0) project

    For example: packageRenameEclipseLink c:/mySourceCodeLocation c:/myDestinationLocation

  2. Press Enter and the Package Rename tool will upgrade your project. The Package Rename tool requires approximately 15 minutes for a 1MB file. Larger files may require additional time.

  3. Repeat this procedure for your:

    • Source code

    • Configuration files

    • TopLink Workbench project files (*.mwp*.xml)

To migrate your TopLink Workbench project, continue with Section 2, "Migrating TopLink Workbench Projects."

2 Migrating TopLink Workbench Projects

Use Table 1 to upgrade both your TopLink Workbench project ( .mwp) and, if necessary, your sessions.xml and project.xml files from a previous version of TopLink.


Note:

If you are migrating from toplink.jar to eclipselink.jar, (as specified in Section 1, "Migrating Oracle TopLink Projects") you cannot use the Oracle TopLink Workbench. Instead:
  1. Use the packageRenameEclipseLink package renamer to rename your TopLink Workbench project files.

  2. Use the EclipseLink Workbench to open your TopLink Workbench project.


Table 1 Migrating TopLink Workbench Projects

To Upgrade From... To 11g Release 1 (11.1.1.1.0), Use This Procedure...

Release 3 (10.1.3) and Release 2 (10.1.2)

  1. Open the existing project with the 11g Release 1 (11.1.1.1.0) TopLink Workbench.

  2. Save the new TopLink Workbench project to a new location.

  3. Both TopLink Workbench and Oracle JDeveloper 11g Release 1 (11.1.1.1.0) automatically update your 10.1.2.x and higher sessions.xml and project.xml file, as needed.

    Simply open the file in 11g Release 1 (11.1.1.1.0), update your data source information (if needed), and save the file.

Release 2 (9.0.4)

  1. Open the existing project with the 11g Release 1 (11.1.1.1.0) TopLink Workbench.

  2. Save the new TopLink Workbench project to a new location.

  3. Consider migrating your sessions.xml and project.xml files.

    For more information, see Section 2.2, "Migrating Sessions and Project XML Files".

Release 1 (9.0.3)

  1. Open the existing project with the 11g Release 1 (11.1.1.1.0) TopLink Workbench.

  2. Delete the passwords from all configured logins.

  3. Re-enter the passwords as plain (not encrypted) text for all configured logins.

  4. Export the project.xml.

    When you export the project.xml, the TopLink Workbench writes the login passwords using Java Cryptograph Extension (JCE) encryption.

    Use this new project.xml file at runtime.

  5. Save the new TopLink Workbench project to a new location.

  6. Consider migrating your sessions.xml and project.xml files.

    For more information, see Section 2.2, "Migrating Sessions and Project XML Files".

Prior to Release 1 (9.0.3)

  1. Execute the Package Rename tool.

    For more information, see Section 2.1, "Renaming Packages for TopLink Workbench Projects Prior to Release 1 (9.0.3)".

  2. Open the existing project with the 11g Release 1 (11.1.1.1.0) TopLink Workbench.

  3. Delete the passwords from all configured logins.

  4. Re-enter the passwords as plain (not encrypted) text for all configured logins.

  5. Export the project.xml.

    When you export the project.xml, the TopLink Workbench writes the login passwords using Java Cryptograph Extension (JCE) encryption.

    Use this new project.xml file at runtime.

  6. Save the new TopLink Workbench project to a new location.

  7. Consider migrating your sessions.xml and project.xml files.

    For more information, see Section 2.2, "Migrating Sessions and Project XML Files".


2.1 Renaming Packages for TopLink Workbench Projects Prior to Release 1 (9.0.3)

Beginning with Release 1 (9.0.3), the base package for the entire TopLink product changed to oracle.toplink. To upgrade existing application source code which refers to TopLink API packages and existing TopLink Workbench projects previous to Release 1 (9.0.3), you must use the Package Rename tool.

You cannot use the TopLink Workbench's Rename Package function when migrating projects from earlier versions – you must use the Package Rename tool.


Note:

If you are upgrading from a version prior to Release 1 (9.0.3), you must convert the package names before you open your TopLink project(s) in 11g Release 1 (11.1.1.1.0).

Use the Package Rename tool on your:

  • Source code

  • Configuration files

  • TopLink Workbench project files ( .mwp) that contain references to pre-Release 1 (9.0.3) API packages

The Package Rename tool works on plain text files and must not be used with binary files (such as .jar).

2.1.1 To Use the Package Rename Tool

Use this procedure to upgrade your existing pre-Release 1 (9.0.3) application source code and TopLink Workbench projects to version 11g Release 1 (11.1.1.1.0).

  1. At the command prompt, execute the packageRename.cmd/sh program located in the TOPLINK_HOME/utils/rename directory. You need to specify three parameters on the command line:

    • the complete directory path that contains the Java source code of your existing project

    • the complete directory path that will contain the upgraded 11g Release 1 (11.1.1.1.0) project

  2. Press Enter and the Package Rename tool will upgrade your project. The Package Rename tool requires approximately 15 minutes for a 1MB file. Larger files may require additional time.

  3. Repeat this procedure for your:

    • Source code

    • Configuration files

    • TopLink Workbench project files (*.mwp*.xml)


Note:

In 11g Release 1 (11.1.1.1.0), the classes in the oracle.toplink.* packages have been deprecated and replaced with those in org.eclipse.persistence.*. To fully migrate your project, see Section 1, "Migrating Oracle TopLink Projects" to rename your packages to use the new eclipselink.jar.

2.2 Migrating Sessions and Project XML Files

Both TopLink Workbench and Oracle JDeveloper 11g Release 1 (11.1.1.1.0) automatically update your 10.1.2.x and higher sessions.xml and project.xml file, as needed. Simply open the file in 11g Release 1 (11.1.1.1.0), update your data source information (if needed), and save the file.

In 11g Release 1 (11.1.1.1.0), the sessions.xml file includes a <login> element that will override any login information included in your project.xml. Use one of the following approaches to correctly configure the session login:

  • Use the 11g Release 1 (11.1.1.1.0) sessions.xml (XSD) with the <login> element. You should include all login information in the sessions.xml.

  • Use the 11g Release 1 (11.1.1.1.0) seesions.xml (XSD) without the <login> element. Include all login information in the project.xml (or project class).

  • Use the project.xml (or project class) without sessions.xml. Include all login information in the project.xml (or project class).

  • Use the 9.0.4 sessions.xml file (DTD). The login information included in the sessions.xml will override any login information in the project.xml (or project class).

3 Migrating From TopLink Essentials to EclipseLink

In 11g Release 1 (11.1.1.1.0), TopLink's JPA implementation is provided through the inclusion of EclipseLink. For details on migrating from TopLink Essentials to EclipseLink see http://wiki.eclipse.org/EclipseLink/Examples/JPA/Migration/TopLinkEssentials.

4 Migrating From TopLink native ORM to EclipseLink native ORM

In 11g Release 1 (11.1.1.1.0), the classes in the oracle.toplink.* packages have been deprecated and replaced with those in org.eclipse.persistence.*. Use the packageRenameEclipseLink application to rename your package. See Section 1.1, "To Use the Package Rename Tool" for more information.

To migrate your project from Oracle TopLink native ORM to the EclipseLink native ORM included with Oracle TopLink11g Release 1 (11.1.1.1.0), see http://wiki.eclipse.org/EclipseLink/Examples/MigratingFromOracleTopLink.

5 Migrating Access to XSDs

For 11g Release 1 (11.1.1.1.0), the XSD files for use with Oracle TopLink are available:

6 Oracle TopLink Coherence Grid

In 11g Release 1 (11.1.1.1.0), the names of the coherence-eclipselink.jar and coherence-eclipselink-src.zip files have been changed to toplink-grid.jar and toplink-grid-src.zip, respectively.

7 Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/.

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

TTY Access to Oracle Support Services

To reach AT&T Customer Assistants, dial 711 or 1.800.855.2880. An AT&T Customer Assistant will relay information between the customer and Oracle Support Services at 1.800.223.1711. Complete instructions for using the AT&T relay services are available at http://www.consumer.att.com/relay/tty/standard2.html. After the AT&T Customer Assistant contacts Oracle Support Services, an Oracle Support Services engineer will handle technical issues and provide customer support according to the Oracle service request process.


Oracle TopLink Release Notes, 11g Release 1 (11.1.1.1.0)

Copyright © 1997, 2009, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.