Oracle® TopLink Release Notes
11g Release 1 (11.1.1.2.0)
 

 

Oracle® TopLink

Release Notes

11g Release 1 (11.1.1.2.0)

 

November 2009

This document provides information on:


Note:

Oracle TopLink Release Notes for 11g (11.1.1.0.1) are available at: http://www.oracle.com/technology/products/ias/toplink/doc/11110/relnotes01/toplink-relnotes.html.

1 New Features

For a detailed overview of the new features that this release provides, see http://www.oracle.com/technology/products/ias/toplink/technical/tl11gR1_fov.htm.

This release includes the following new features:

1.1 TopLink Install Directory and JAR Files

In 11g Release 1, the TopLink install directory structure has changed as Example 1 shows. Table 1 and Table 2 provide details on the JAR files installed in this directory structure.

Example 1 11g Release 1 TopLink Install Directory

TOPLINK_HOME
    toplink-readme.html
    /bin
        sdo-compiler.cmd
        sdo-compiler.sh
        setenv.cmd
        setenv.sh
        tljaxb.cmd
        tljaxb.sh
    /doc
        eclipselink-javadocs.zip 
        toplink-install.html
        toplink-javadoc.jar
        toplink-relnotes.html
        /support
    /jlib
         com.oracle.ws.orawsdl_1.1.0.0.jar
         com.oracle.ws.http_client_1.1.0.0.jar
         eclipse.jar
         eclipselink-src.zip
         toplink.jar
         toplink-src.zip
         toplink-grid-src.zip
         toplink-grid.jar
         toplink-oc4j.jar
    /modules
        com.bea.core.antlr.runtime_2.7.7.jar
        commonj.sdo_2.1.0.jar
        glassfish.jaxb.xjc_1.0.0.0_2-1-7.jar
        glassfish.jaxb_1.0.0.0_2-1-7.jar
        javax.activation_1.1.jar
        javax.ejb_3.0.1.jar
        javax.jms_1.1.1.jar
        javax.mail_1.4.jar
        javax.persistence_1.0.0.0_1-0-2.jar
        javax.resource_1.5.1.jar
        javax.xml.bind_2.1.1.jar
        javax.xml.soap_1.3.0.0.jar
        javax.xml.stream_1.1.1.0.jar
        orawsdl.jar
        oracle.http_client_11.1.1.jar
        xml.jar
        xmlparserv2.jar
    /utils
        /dbws
            dbwsbulder.cmd
            dbwsbuilder.sh
            eclipselink-dwsutils.jar
        /rename
            packageRename.cmd
            package-rename.jar
            package-rename.properties
            packageRename.sh
            packageRenameEclipseLink.cmd
            package-rename-eclipselink.properties
            packageRenameEclipseLink.sh
        /workbench
            workbench.cmd
            workbench.sh
            /config
               workbench.ico
               platforms.dpr
               /platforms
                  attunity.xml
                  cloudscape.xml
                  db2.xml
                  dbase.xml
                  derby.xml
                  hsql.xml
                  informix.xml
                  msaccess.xml
                  mysql4.xml
                  mysql5.xml
                  oracle.xml
                  oracle8i.xml
                  oracle9i.xml
                  other.xml
                  oracle10g.xml
                  oracle11.xml
                  pointbase.xml
                  sqlanywhere.xml
                  sqlserver.xml
                  sybase.xml
                  timesten.xml
            /jlib
                cmpintegrator.jar
                help-share.jar
                jewt.jar
                ohj.jar
                oracle_ice.jar
                share.jar
                tljaxb.jar
                tlmwcore.jar
                toplinkmw.jar
               /help
                    tlmwhelp.jar
                    other language-specific help jars, if installed
    /xsds
        eclipselink_orm_1_2.xsd
        object-persistence_1_0.xsd
        orm_1_0.xsd
        persistence_1_0.xsd
        sessions_10_1_3.xsd
        sessions_11_1_1.xsd
        toplink-object-persistence_10_1_3.xsd
        toplink-object-persistence_11_1_1.xsd

Table 1 and Table 2 provide details on the JAR files.

Table 1 TopLink JAR Files

JAR Description

cmpmigrator.jar

This JAR contains the TopLink migration tool that you can use to easily migrate an existing OC4J application that uses the Orion persistence manager to use the TopLink persistence manager.

The Orion persistence manager was deprecated in OC4J 10.1.3.1 and in 11g Release 1 (11.1.1.1.0), it was removed.

packageRename.jar

This JAR contains the TopLink Package Rename tool for migrating Release 1 (9.0.3) projects to 11g Release 1 (11.1.1.2.0) or EclipseLink. For more information, see "1.1 Renaming Packages for TopLink Workbench Projects Prior to Release 1 (9.0.3)" in the TopLink Migration Instructions.

tljaxb.jar

This JAR is the schema compiler that generates JAXB mapped POJOs (Plain Old Java Objects) from an XML schema.

tlmwhelp.jar

This JAR contains the TopLink Workbench online help used by the TopLink Workbench application classes in toplinkmw.jar. It is not necessary to deploy this JAR with TopLink applications.

When installing non-English versions of TopLink Workbench, additional files (for other languages) will be available.

toplink-grid.jar

This JAR contains the Coherence integration for TopLink. This JAR is required on the classpath if you are using Oracle Coherence with your TopLink JPA application.

toplink.jar

This JAR contains the TopLink classes for backwards compatibility with previous releases. You use this JAR in Java SE deployments.

toplink-oc4j.jar

This JAR contains the Oracle Containers for Java EE integration for TopLink. This JAR file is only used with OC4J 10.1.3.x.

toplinkmw.jar

This JAR contains the TopLink Workbench application classes. It depends on toplink.jar and tlmwhelp.jar.


Table 2 Third-party JAR Files

JAR Description

com.bea.core.antlr.runtime_2.7.7.jar

This jar contains Antlr 2.7.7 (ANother Tool for Language Recognition), and is required on the classpath for using EJB 1.X and 2.X (specifically EJBQL queries).

com.oracle.ws.orawsdl_1.1.0.0.jar and com.oracle.ws.http_client_1.1.0.0.jar

This JAR generates the design-time artifacts that can be used to represent RDBMS data as a web service (DBWS).

Note: Using DBWS requires JDK 1.6 (or higher).

commonj.sdo_2.1.0.jar

This JAR contains the Service Data Object (SDO) APIs.

eclipselink.jar

This JAR contains the EclipseLink persistence framework. EclipseLink supports virtually any type of data source, including relational databases, XML, or EIS systems.

glassfish.jaxb.xjc_2.1.6.jar

This JAR is included to provide JAXB 2.1 schema to java compiler capabilities

glassfish.jaxb_2.1.6.jar

This JAR is included to provide JAXB 2.1 schema to java compiler capabilities

javax.activation_1.1.jar

This JAR is required by the JAXB standard APIs and also for using TopLink OXM/EclipseLink MOXy XML binary data mappings.

javax.ejb_3.0.1.jar

This JAR contains the EJB 3.0 interface and is included in JavaEE 5 containers. It will be required on the classpath if you are using annotations in the JAR and running against JavaSE or Non JavaEE 5 containers.

javax.jms_1.1.1.jar

This JAR contains the Java Messaging Service (JMS) 1.1 interface and is required on the classpath for using Cache Coordination over JMS, in JavaSE or with Non JavaEE 5 containers. This jar is included in JavaEE 5 containers.

javax.mail_1.4.jar

This JAR is required by the JAXB standard APIs and also for using TopLink OXM/EclipseLink MOXy XML binary data mappings.

javax.persistence_1.0.0.0_1-0.jar

This JAR contains the JPA 1.0 interface, and is required on the classpath for using JPA in JavaSE or with Non JavaEE 5 containers. This jar is included in JavaEE 5 containers.

javax.resource_1.5.1.jar

This JAR is required when using TopLink EIS mapping capabilities.

javax.xml.bind_2.1.1.jar

This JAR provides the JAXB 2.1 runtime APIs.

javax.xml.soap_1.3.0.0.jar

This JAR contains Java XML Soap Extensions integration.

javax.xml.stream_1.1.1.0.jar

This JAR provides the StAX parser APIs and is required by the JAXB 2.x public APIs.

xml.jar

This JAR is part of the Oracle XML Development Kit (XDK) and is provided to support XMLType mappings against an Oracle XML Database.

xmlparserv2.jar

This JAR contains the Oracle XML Development Kit (XDK) implementation. The XDK XML parser is primarily required in an Oracle OC4J 10.1.3.x environment.


2 API Modifications

The classes in the oracle.toplink.* packages have been deprecated in this release and replaced with those in org.eclipse.persistence.*. For information on migrating to these new packages, see: http://www.oracle.com/technology/products/ias/toplink/doc/11110/migration/toplink-migrate.html.

For a detailed list of all TopLink API modifications made in this release, see: http://www.oracle.com/technology/products/ias/toplink/doc/11110/api/api_mod_readme.html.

3 Migration

For information on migrating existing TopLink projects to this release, see: http://www.oracle.com/technology/products/ias/toplink/doc/11110/migration/toplink-migrate.html.

4 Known Issues

The following are known issues in Oracle TopLink 11g Release 1 (11.1.1.2.0):

4.1 TopLink Object-Relational Issues

This section contains information on the following issues:

4.1.1 Incorrect outer join SQL on SQLServer2005

TopLink generates incorrect outer join for SQL Server v2005. The outer join syntax generated is correct for earlier versions of this database. To work around this limitation, configure your SQL Server to emulate a previous version (refer to the SQLServer documentation for details on configuring database compatibility). Alternatively, you can use a custom TopLink database platform.

4.1.2 UnitOfWork.release() not Supported with External Transaction Control

A unit of work synchronized with a Java Transaction API (JTA) will throw an exception if it is released. If the current transaction requires its changes to not be persisted, the JTA transaction must be rolled back.

When in a container-demarcated transaction, call setRollbackOnly() on the EJB/session context:

@Stateless
public class MySessionBean
{    @Resource 
    SessionContext sc;
    
    public void someMethod()
    {
        ...
        sc.setRollbackOnly();
    }
}

When in a bean-demarcated transaction then you call rollback() on the UserTransaction obtained from the EJB/session context:

@Stateless
@TransactionManagement(TransactionManagementType.BEAN)
public class MySessionBean implements SomeInterface 
{
    @Resource
    SessionContext sc;
    
    public void someMethod() 
    {
        sc.getUserTransaction().begin();
        ...
        sc.getUserTransaction().rollback();
    }
} 

4.1.3 Returning Policy for UPDATE with Optimistic Locking

The returning policy, which allows values modified during INSERT and UPDATE to be returned and populated in cached objects, does not work in conjunction with numeric version optimistic locking for UPDATE. The value returned for all UPDATE operations is 1 and does not provide meaningful locking protection.

Do not use a returning policy for UPDATE in conjunction with numeric optimistic locking.

The use of returning policy for INSERT when using optimistic locking works correctly.

4.1.4 JDBC Drivers returning Timestamps as Strings

TopLink assumes that date and time information returned from the server will use Timestamp. If the JDBC driver returns a String for the current date, TopLink will throw an exception. This is the case when using a DB2 JDBC driver.

To work around this issue, consider using a driver that returns Timestamp (such as COM.ibm.db2.jdbc.app.DB2Driver) or change the policy to use local time instead of server time.

Another option is to use a query re-director on the ValueReadQuery used by the platform:

ValueReadQuery vrq = new ValueReadQuery(
    "SELECT to_char(sysdate, 'YYYY-MM-DD HH:MM:SS.SSSSS') FROM DUAL"
);
vrq.setRedirector(new TSQueryRedirector());
...
class TSQueryRedirector implements QueryRedirector 
{
    public Object invokeQuery(DatabaseQuery query, Record arguments, Session session)
    {
        String value = (String)session.executeQuery(query);
        return ConversionManager.getDefaultManager().convertObject(
            value, java.sql.Timestamp.class
        );
    }
}

4.1.5 Proxy Authentication with Oracle Containers for Java EE (OC4J) Managed Data Sources

Proxy authentication does not work with OC4J managed data sources. Instead of using the data source provided by the application server, you must create a data source yourself.

Refer to the "Configuring Oracle Database Proxy Authentication" in the Oracle Fusion Middleware Developer's Guide for Oracle TopLink for more information.

For example, replace this code:

login.setConnector(
    new OracleJDBC10_1_0_2ProxyConnector(
        ((JNDIConnectorlogin.getConnector()).getName()
    )
);

with the following:

oracle.jdbc.pool.OracleDataSource ds = new oracle.jdbc.pool.OracleDataSource();
ds.setUser("MyMainUser");
ds.setPassword("MyPassword");
ds.setUrl("jdbc:oracle:thin:@MyServer:1521:MyDb");
login.setConnector(new OracleJDBC10_1_0_2ProxyConnector(ds));

4.1.6 Unit of Work does not add Deleted Objects to Change Set

When accessing the change set of a Unit of Work to determine what has changed, objects that are pending deletion (such as uow.deleteObject( ) and uow.deleteAllObjects( )) will not be returned from the result set.

The objects pending deletion are only available through the Unit of Work getDeletedObjects call.

4.2 TopLink Workbench Issues

This section contains information on the following issues:

4.2.1 Accessibility

Due to an issue with Sun JDK 1.6, if NullPointException error dialog is generated when saving a file, the error dialog window is not in focus.

4.2.2 Running the TopLink Workbench on Windows OS

Due to an issue with certain configurations and versions of Windows operating systems, users that launch the TopLink Workbench with the workbench.cmd file may receive a dialog that states: Could not find the main class. This occurs because the classpath specified contains a directory path which has periods in it. The workaround is to rename the offending directory or change the classpath to use directory paths which do not contain periods.

4.3 Oracle Database Extensions with TopLink

This section contains information on the following issue:

4.3.1 Template JAR for Spatial and XDB Support in Oracle WebLogic Server

To fully support Oracle Spatial and Oracle XDB mapping capabilities (in both standalone Oracle WebLogic Server and the Oracle JDeveloper integrated WebLogic Server), you must use the toplink-spatial-template.jar and toplink-xdb-template.jar to extend the WebLogic Server domain to support Oracle Spatial and XDB, respectively.

To extend your WebLogic Server domain:

  1. Download the toplink-spatial-template.jar (to support Oracle Spatial) and toplink-xdb-template.jar (to support Oracle XDB) files from:

  2. Copy the following files:

    File From...Foot 1  To...Foot 2 
    To support Oracle Spatial:
      sdoapi.jar <ORACLE_DATABASE_HOME>/md/jlib <WEBLOGIC_HOME>/server/lib
    To support Oracle XDB:
      xdb.jar <ORACLE_DATABASE_HOME>/rdbms/jlib <WEBLOGIC_HOME>/server/lib
      xml.jar <ORACLE_DATABASE_HOME>/lib <WEBLOGIC_HOME>/server/lib
      xmlparserv2.jar <ORACLE_DATABASE_HOME>/lib <WEBLOGIC_HOME>/server/lib

    Footnote 1 These are the default locations. Your actual location may vary depending on your specific environment, installed options, and version.

    Footnote 2 When using Oracle JDeveloper integrated WebLogic Server, the <WEBLOGIC_HOME> is located within the <JDEVELOPER_HOME> directory.


    Note:

    Although the actual JAR file may be named differently in your From directory, the file must be named as shown, when copied to the To directory.

  3. Launch the Config Wizard (<WEBLOGIC_HOME>/common/bin/config.sh (or .bat).

  4. Select Extend an existing WebLogic domain.

  5. Browse and select your WebLogic Server domain.

    When using Oracle JDeveloper with integrated WebLogic Server, the typical WebLogic Server domain location may be similar to:

    • In Windows environments: %APPDATA%\JDeveloper\systemXX.XX.XX.XX\DefaultDomain

      where XX.XX.XX.XX is the unique number of the product build.

      For Windows platforms, you must enable the Show hidden files and folders folder option.

    • In non-Windows environments, the default location is under the current user's default home directory: <$Home>/DefaultDomain

    Refer to the Oracle JDeveloper documentation for details.

  6. Select Extend my domain using an existing extension template.

  7. Browse and select the required template JAR (toplink-spatial-template.jar for Oracle Spatial, toplink-xdb-template.jar for Oracle XDB).

  8. Complete the remaining pages of the wizard.

4.4 Allowing Zero Value Primary Keys

By default, EclipseLink interprets zero as null for primitive types that cannot be null (such as int and long) causing zero to be an invalid value for primary keys. You can modify this setting by using the allow-zero-id property in the persistence.xml file. Valid values are:

  • true – EclipseLink interprets zero values as zero. This permits primary keys to use a value of zero.

  • false (default) – EclipseLink interprets zero as null.

Refer the EclipseLink User's Guide at http://wiki.eclipse.org/EclipseLink/UserGuide for more information.

4.5 Managed Servers on Sybase with JCA Oracle Database Service

When using a JCA service with the Oracle Database adapter in a cluster to perform database operations on a Sybase database, the managed nodes in the cluster process the messages and may attempt to perform duplicate operations.

Because supported versions of Sybase do not support Oracle TopLink record locking, Sybase allows the duplicate operation attempts.

5 Documentation

This section contains information on the following issues:

5.1 oracle.toplink.* packages

Because the classes in the oracle.toplink.* packages have been deprecated in 11g Release 1 (11.1.1.1.0), see Section 2, "API Modifications", Oracle Fusion Middleware Developer's Guide for Oracle TopLink is provided for backwards compatibility with earlier releases.

Refer to the EclipseLink User Documentation (http://wiki.eclipse.org/EclipseLink/UserGuide) for information on the new org.eclipse.persistence.* packages.

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

Deaf/Hard of Hearing Access to Oracle Support Services

To reach Oracle Support Services, use a telecommunications relay service (TRS) to call Oracle Support at 1.800.223.1711. An Oracle Support Services engineer will handle technical issues and provide customer support according to the Oracle service request process. Information about TRS is available at http://www.fcc.gov/cgb/consumerfacts/trs.html, and a list of phone numbers is available at http://www.fcc.gov/cgb/dro/trsphonebk.html.


Oracle TopLink Release Notes, 11g Release 1 (11.1.1.1.0/11.1.1.2.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.