| Oracle Fusion Middleware Developer's Guide for Oracle TopLink 11g Release 1 (11.1.1) Part Number B32441-02 |
|
|
View PDF |
| Oracle Fusion Middleware Developer's Guide for Oracle TopLink 11g Release 1 (11.1.1) Part Number B32441-02 |
|
|
View PDF |
This chapter describes how to configure Oracle TopLink for use with Java EE containers and application servers. Although you can use Oracle TopLink with any Java EE container or application server (by using the TopLink API), TopLink provides specific integration and support for the application servers listed in this chapter.
This chapter includes the following sections:
For more information, see the following:
You can use TopLink with any Java EE application server (by using the TopLink API) that meets the requirements shown in "What Are the Software Requirements".
Table 8-1 lists the application servers for which TopLink provides specific JPA, CMP 2.n, and session EJB/BMP integration.
Table 8-1 TopLink Integration Support by Application Server Type
| Application Server Type | Application Server Version | JPA | CMP 2.n | (Session BeanFoot 1 and BMP |
|---|---|---|---|---|
|
Oracle WebLogic Server |
10.3 |
 |
 |
|
|
9.n |
|
|
|
|
|
OC4J |
10.1.3.n |
|
|
|
|
10.1.3 |
|
|
|
|
|
9.0.4 |
|
|
|
|
|
9.0.3 |
|
|
|
|
|
IBM WebSphere |
6.1 |
|
|
|
|
SunAS |
9 |
|
|
|
|
JBoss |
4.2.0 |
|
|
|
Footnote 1 This applies to EJB 1.n, 2.n and 3.0 session beans.
For more information, see the following:
Section 8.3, "Integrating TopLink with Oracle WebLogic Server"
Section 8.4, "Integrating TopLink with Oracle Containers for Java EE (OC4J)"
Section 8.5, "Integrating TopLink with IBM WebSphere Application Server"
Section 8.6, "Integrating TopLink with Sun Application Server"
Section 8.7, "Integrating TopLink with JBoss Application Server"
This section describes concepts unique to TopLink application server integration, including the following:
To run a TopLink application within a Java EE container, your system must meet the following software requirements:
An application server or Java EE container (see Table 8-1);
XML parser (see Section 8.2.2, "How to Configure the XML Parser Platform");
A JDBC driver configured to connect with your local database system (for more information, see your database administrator);
A Java development environment, such as the following:
Oracle JDeveloper;
IBM WebSphere Studio Application Developer (WSAD);
Sun Java Development Kit (JDK) 1.5 or later;
Any other Java environment that is compatible with the Sun JDK 1.5 or later;
A command-line JVM executable (such as java.exe or jre.exe).
The TopLink run-time environment uses an XML parser to do the following:
Read and write XML configuration files (see Section 9.1.1, "project.xml File" and Section 9.1.2, "sessions.xml File");
Read and write TopLink Workbench project files (see Section 5.1, "Introduction to TopLink Workbench");
Perform object-to-XML transformations in EIS projects using XML records (see Chapter 77, "Introduction to EIS Mappings");
Perform object-to-XML transformations in XML projects (see Chapter 53, "Introduction to XML Mappings");
Application servers use an XML parser to read deployment files, such as ejb-jar.xml and <Java EE container>-ejb-jar.xml files (see Chapter 9, "Creating TopLink Files for Deployment").
To avoid XML parser conflicts, you must configure your TopLink application to use the same XML parser as that used by the application server on which you deploy your application.
Internally, TopLink accesses its XML parser using an instance of oracle.toplink.platform.xml.XMLPlatform class.
You can configure TopLink to use any XML parser for which an XMLPlatform class exists (see Section 8.2.2.1, "Configuring XML Parser Platform").
You can also create your own XMLPlatform to provide access to an XML parser not currently supported by TopLink (see Section 8.2.2.2, "Creating an XML Parser Platform").
TopLink provides the XMLPlatform instances shown in Table 8-2.
Table 8-2 Supported XML Platforms
| XMLPlatform... | Provides Access to... | Use with... |
|---|---|---|
|
|
|
See Section 8.4, "Integrating TopLink with Oracle Containers for Java EE (OC4J)" |
|
|
|
See the following: |
Footnote 1 Default.
Note:
To use an XML parser not listed in Table 8-2, create your own
XMLPlatform (see Section 8.2.2.2, "Creating an XML Parser Platform").To configure your TopLink application to use a particular instance of the XMLPlatform class, set system property toplink.xml.platform to the fully qualified name of your XMLPlatform class, as Example 8-1 shows.
Using the oracle.toplink.platform.xml classes included in the public source files shipped with TopLink (see Section 13.3, "Using Public Source"), you can create your own instance of the oracle.toplink.platform.xml.XMLPlatform class to specify an XML parser not listed in Table 8-2.
After creating your XMLPlatform, configure TopLink to use it (see Section 8.2.2.1, "Configuring XML Parser Platform").
Crimson (http://xml.apache.org/crimson/) is the XML parser supplied in the Java Platform, Standard Edition (Java SE) and in some JAXP reference implementations.
If you use Crimson with the JAXP API to parse XML files whose system identifier is not a fully qualified URL, then XML parsing will fail with a not valid URL exception.
Other XML parsers defer validation of the system identifier URL until it is specifically referenced.
If you are experiencing this problem, consider one of the following alternatives:
Ensure that your XML files use a fully qualified system identifier URL.
Use another XML parser (such as the OracleAS XML Parser for Java v2).
By default, when you run a TopLink-enabled application in a JVM configured with a nondefault java.lang.SecurityManager, the TopLink run-time environment executes certain internal functions by executing a PrivilegedAction with java.security.AccessController method doPrivileged. This ensures that you do not need to grant many permissions to TopLink for it to perform its most common operations. You need only grant certain permissions depending on the types of optional TopLink features you use.
For more information, see Section 8.8, "Defining Security Permissions".
If you run a TopLink-enabled application in a JVM without a nondefault SecurityManager, you do not need to set any permissions.
You can configure an application server to use TopLink as the persistence manager.
You can only use one persistence manager for all the entity beans with container-managed persistence in a JAR file.
TopLink provides automated support for migrating an existing Java EE application to use TopLink as the persistence manager. For more information, see Section 8.4.2, "How to Migrate OC4J Orion CMP Persistence to OC4J TopLink Persistence".
Most application servers include a clustering service that you can use with your TopLink application.
To use TopLink with an application server cluster, use this general procedure:
Install the toplink.jar file (and include it in the classpath) on each application server in the cluster to which you deploy TopLink applications.
Configure TopLink cache consistency options appropriate for your application.
For more information, see Chapter 102, "Introduction to Cache".
If you are deploying a CMP application, see also Section 9.9.1.2, "Configuring cache-synchronization Properties".
Configure TopLink coordinated cache support for your application server, if available.
Configure clustering on each application server.
For more information, see your application server documentation.
To integrate a TopLink application with Oracle WebLogic Server, you must consider the following:
In addition to configuring these Oracle WebLogic Server-specific options, you must also consider the general application server integration issues in Section 8.2, "Integrating TopLink with an Application Server".
To configure TopLink support for Oracle WebLogic Server, do the following:
Add the following JAR files to the application server classpath:
<TOPLINK_HOME>/jlib/toplink.jar
Ensure that your TopLink application defines an XML parser platform (see Section 8.2.2, "How to Configure the XML Parser Platform").
For applications that require JTA integration, specify the external transaction controller when you configure the server platform in your session (see Section 89.9, "Configuring the Server Platform").
For more information, see Section 115.13, "Integrating the Unit of Work with an External Transaction Service".
By default, when you deploy a TopLink application to Oracle WebLogic Server, the TopLink runtime deploys the following Java Management Extensions (JMX) MBean to the Oracle WebLogic Server JMX service for each TopLink session:
oracle.toplink.services.DevelopmentServices–This class is meant to provide facilities for managing an EclipseLink session internal to TopLink over JMX.
oracle.toplink.services.RuntimeServices–This class is meant to provide facilities for managing an TopLink session external to EclipseLink over JMX.
Use the API that this JMX MBean exposes to access and configure your TopLink sessions at run time using JMX code that you write, or to integrate your TopLink application with a third-party JMX management application, such as JConsole, or others.
Perform the following steps:
Set breakpoints: the eclipselink.jar deployed in the weblogic domain/lib needs a source attachment. You set a breakpoint on the undeploy method of the org.eclipse.persistence.internal.jpa.EntityManagerSetupImpl pointing to the source JAR file or your workspace projects, and then redeploy. This will result in any breakpoints set in the predeploy method or prior to the first login to be hit.
Enable remote access on the Oracle WebLogic Server JVM by adding the following JVM option to your WebLogic startup script:
C:\opt\wls103\user_projects\domains\base_domain\bin\startWebLogic.cmd set JAVA_OPTIONS=%JAVA_OPTIONS% -Dcom.sun.management.jmxremote
Enable MBean registration (deployment) by adding one or both of the two MBean system properties, as follows:
rem set JAVA_OPTIONS=%JAVA_OPTIONS% -Dtoplink.register.dev.mbean=true rem set JAVA_OPTIONS=%JAVA_OPTIONS% -Dtoplink.register.run.mbean=true
By default, TopLink does not register MBeans for Oracle WebLogic Server. If you enable the registration, it will occur as a post step during the first login to the session (see Section 89.3, "Configuring a Session Login").
Note:
For a CMP application, TopLink session instantiation and login occurs during deployment; for a JPA application–atEntityManager instantiation time.If both toplink.register.dev.mbean and toplink.register.run.mbean properties are missing, MBean registration will not proceed for that bean.
Configure Oracle WebLogic Server domain security.
For more information, see the following:
EclipseLink JMX MBean Support in Oracle WebLogic Server tutorial at http://wiki.eclipse.org/EclipseLink/Examples/JMX/MBeans_WebLogic#Configuring_WebLogic_Server_Domain_Security|EclipseLink
Examine Oracle WebLogic Server logs and look for the appropriate log messages.
After you deploy your TopLink application, you can use any JMX-compliant management application to access and use the full public API that TopLink MBeans provide.
To access TopLink JMX MBeans using a third-party JMX management application:
Package and deploy your TopLink application to Oracle WebLogic Server.
For more information, see Part III, "TopLink Application Deployment".
Optionally, examine Oracle WebLogic Server logs and look for the appropriate log messages. Note that for a JPA application, TopLink session instantiation and login occurs at EntityManager instantiation time.
Launch your third-party JMX management application.
For example, launch JConsole (JDK_HOME\bin\jconsole.exe) using the command prompt, and then select the running weblogic.Server local process, as Figure 8-1 shows.
Use your third-party JMX management application to examine TopLink MBean attributes, operations, and notifications.
Using JConsole or JMX code you write, you can access the full public API of the RuntimeServices MBeans.
Figure 8-2 shows the JConsole display for a TopLink application.
There are a number of ways to disable TopLink JMX support:
To disable deployment of MBeans to Oracle WebLogic Server for your TopLink application using system properties,
remove, disable, or do not add in the first place toplink.register.dev.mbean and toplink.register.run.mbean MBean system properties. The following example shows how to disable these properties:
rem set JAVA_OPTIONS=%JAVA_OPTIONS% -Dtoplink.register.dev.mbean=false rem set JAVA_OPTIONS=%JAVA_OPTIONS% -Dtoplink.register.run.mbean=false
To disable deployment of MBeans to Oracle WebLogic Server for your TopLink application using deployment XML,
use a TopLink sessions.xml file (assuming your application has one):
Undeploy your TopLink application on Oracle WebLogic Server.
Edit your TopLink application's Oracle WebLogic Server platform to disable run-time services.
For more information, see Section 89.9, "Configuring the Server Platform".
Package your TopLink application and redeploy on Oracle WebLogic Server.
For more information, see Part III, "TopLink Application Deployment"
Confirm that TopLink JMX MBean instances for your application no longer exist.
If your application does not include a TopLink sessions.xml file, you can use a preLogin event handler to disable this feature (see the following section).
To disable deployment of MBeans to Oracle WebLogic Server for your TopLink application using the TopLink session preLogin event handler:
Undeploy your TopLink application on Oracle WebLogic Server.
Create a TopLink session customizer.
For more information, see Section 89.8, "Configuring a Session Customizer Class".
In your session customizer, create a session event listener for the preLogin session event and register the listener with the session event manager, as Example 8-2 shows.
Example 8-2 TopLink Session Customizer with Session Event Listener
import oracle.toplink.tools.sessionconfiguration.SessionCustomizer;
import oracle.toplink.sessions.Session;
import oracle.toplink.sessions.SessionEvent;
import oracle.toplink.sessions.SessionEventAdapter;
import oracle.toplink.platform.server.ServerPlatform;
public class EmployeeSessionCustomizer implements SessionCustomizer {
public void customize(Sesssion session) {
SessionEventAdapter myEventListener = new SessionEventAdapter() {
// Listen for preLogin event
public void preLogin(SessionEvent event) {
// Disable runtime services
Session session event.getSession();
ServerPlatform serverPlatform = session.getServerPlatform();
serverPlatform.disableRuntimeServices();
}
};
// Register session event listener
session.getEventManager().addListener(myEventListener);
}
}
For more information, see Section 89.10, "Configuring Session Event Listeners".
Package your TopLink application, including your session customizer, and redeploy on Oracle WebLogic Server.
For more information, see Part III, "TopLink Application Deployment"
Confirm that TopLink JMX MBean instances for your application are not deployed.
Note:
Follow the preceding procedure if you TopLink application does not include an Oracle WebLogic Serversessions.xml file (such as a TopLink JPA application).For more information on TopLink and Oracle WebLogic Server JMX support, see the following Oracle WebLogic Server documentation:
Oracle WebLogic Server: Developing Manageable Applications with JMX
Oracle WebLogic Server: Developing Custom Management Utilities with JMX
For more information on JMX in general, see http://java.sun.com/docs/books/tutorial/jmx/index.html.
If you use a security manager, specify a security policy file in the weblogic.policy file (usually located in the WebLogic install directory), as follows:
-Djava.security.manager -Djava.security.policy==c:\weblogic\weblogic.policy
The Oracle WebLogic Server installation procedure includes a sample security policy file. You need to edit the weblogic.policy file to grant permission for TopLink to use reflection.
The following example illustrates only the permissions that TopLink requires, but most weblogic.policy files contain more permissions than are shown in this example.
Example 8-3 A Subset of a "Grant" Section from a WebLogic.policy File
grant {
// "enableSubstitution" required to run the WebLogic console
permission java.io.SerializablePermission "enableSubstitution";
// "modifyThreadGroup" required to run the WebLogic Server
permission java.lang.RuntimePermission "modifyThreadGroup";
// grant permission for TopLink to use reflection
permission java.lang.reflect.ReflectPermission "suppressAccessChecks";
};
To integrate a TopLink application with OC4J, you must consider the following:
How to Migrate OC4J Orion CMP Persistence to OC4J TopLink Persistence
How to Integrate with Oracle Application Server Manageability and Diagnosability
In addition to configuring these OC4J-specific options, you must also consider the general application server integration issues in Section 8.2, "Integrating TopLink with an Application Server".
To enable TopLink CMP integration in OC4J, use the following procedure (this procedure assumes you have already installed TopLink):
If necessary, migrate your CMP application using the TopLink migration tool (see Section 8.4.2, "How to Migrate OC4J Orion CMP Persistence to OC4J TopLink Persistence").
Evaluate your choice of UnitOfWork change policy (see Section 113.2.3, "Unit of Work and Change Policy").
Ensure that all necessary deployment descriptor files are in place (see Chapter 9, "Creating TopLink Files for Deployment" and Section 10, "Packaging a TopLink Application").
Optionally, consider the EJB customization options that TopLink provides (see Section 8.9, "Configuring Miscellaneous EJB CMP Options").
If you upgrade OC4J 9.0.4 or earlier to 11g Release 1 (11.1.1), you must migrate persistence configuration from your original orion-ejb-jar.xml file to the toplink-ejb-jar.xml file.
In 11g Release 1 (11.1.1), Oracle provides a TopLink migration tool that you can use to automate this migration for Release 2 (9.0.4) or later OC4J installations.
After using the TopLink migration tool, you may need to make some additional changes as described in Section 8.4.2.5, "Performing Post-Migration Changes".
If you encounter problems during migration, see Section 8.4.2.6, "Troubleshooting Your Migration".
This section explains how to use the TopLink migration tool, including the following:
Before using the TopLink migration tool, review this section to understand how the TopLink migration tool works and to determine what OC4J persistence manager metadata is, and is not, migrated.
Input and Output
The TopLink migration tool takes the following files as input:
ejb-jar.xml
orion-ejb-jar.xml
It migrates as much OC4J-specific persistence configuration as possible to a new toplink-ejb-jar.xml file and creates the following new files in a target directory you specify:
orion-ejb-jar.xml
toplink-ejb-jar.xml
TopLink Workbench project file TLCmpProject.mwp
The ejb-jar.xml and orion-ejb-jar.xml files may be in an EAR, JAR, or just standalone XML files. If you migrate from standalone XML files (rather than an EAR or JAR file), ensure that the domain classes are accessible and included in your classpath.
The TopLink migration tool creates a new orion-ejb-jar.xml and toplink-ejb-jar.xml file to the target directory you specify in the same format as it reads the original files. For example, if you specify an EAR file as input, then the TopLink migration tool stages and creates a new EAR file that contains both the new orion-ejb-jar.xml and the new toplink-ejb-jar.xml file, but is otherwise identical to the original.
The TopLink Workbench project file is always created as a separate file.
Note:
Oracle recommends that you make a backup copy of yourorion-ejb-jar.xml file before using the TopLink migration tool.Migration
As it operates, the TopLink migration tool logs all errors and diagnostic output to a log file named oc4j_migration.log in the output directory. If you use the TopLink migration tool from TopLink Workbench, see also the TopLink Workbench log file oracle.toplink.workbench.log located in your user home directory (for example, C:\Documents and Settings\<user-name>).
The TopLink migration tool processes descriptor, mapping, and query information from the input files as follows:
It builds a TopLink descriptor object for each entity bean and migrates native persistence metadata like mapped tables, primary keys, and mappings for CMP and CMR fields.
It builds a TopLink mapping object for every CMP and CMR field of an entity bean and migrates native persistence metadata like foreign key references.
It builds a TopLink query object for each finder or ejbSelect of an entity bean and migrates persistence metadata like customized query statements.
Table 8-3 lists OC4J <entity-deployment> attributes and subelements from the orion-ejb-jar.xml file and for each, indicates whether or not the TopLink migration tool:
Retains it in the new orion-ejb-jar.xml file
Migrates it to the new toplink-ejb-jar.xml file
In Table 8-3, elements are identified with angle brackets. Note that in some cases an attribute is migrated when set to one value, but discarded if set to another value (for example, exclusive-write-access).
Table 8-3 OC4J orion-ejb-jar.xml Feature Migration
| orion-ejb-jar.xml Feature | Retained in New orion-ejb-jar.xml | Migrated to New toplink-ejb-jar.xml |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
||
|
Any value greater than 1 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Footnote 1 You can enable force-update after migration. For more information, see Section 119.18, "Configuring a Descriptor with EJB CMP and BMP Information".
Footnote 2 TopLink supports both outer and inner joins at run time.You can manually configure EJB descriptors with these options. For more information, see Section 108.7.1.5, "Join Reading and Object-Level Read Queries".
Footnote 3 The persistence-type attribute's table column size, if present, is discarded. For more information, see Section 8.4.2.5, "Recovering persistence-type Table Column Size"..
Table 8-4 lists OC4J features and their TopLink equivalents configured by the TopLink migration tool.
Table 8-4 OC4J and TopLink Feature Comparison
| Feature | orion-ejb-jar.xml | toplink-ejb-jar.xml |
|---|---|---|
|
CMP field mapping |
Direct Serialized object |
Direct-to-field Serialized object |
|
CMR field mapping |
One-to-one One-to-many Many-to-many |
One-to-one One-to-many Many-to-many |
|
Partial query |
Full SQL statement |
SQL Call |
|
Finder |
Oracle specific syntax |
SQL Call or EJB QL |
|
Lazy loading (fetch group) |
Lazy loading of primary key and CMP fields |
Not supported Alternatively, you can manually configure the TopLink equivalent, if appropriate (see Section 16.2.4, "Fetch Groups"). |
|
SQL statement caching |
Cache static SQL |
Not supported at the bean level. TopLink supports parameterized SQL and statement caching at the session and query level (see Chapter 108, "Introduction to TopLink Queries"). |
|
Locking |
Optimistic: database-level Pessimistic: bean instance-level |
Optimistic: object-level Pessimistic: query lock at database-level |
|
Read-only |
Attempt to change throws |
Attempt to change throws |
|
Validity timeout |
Read-only bean validity timeout before reloaded. |
Cache timeout |
|
Isolation level |
Committed Serializable |
Committed Serializable Not Committed Not Repeatable |
|
Delay update until commit |
Supported |
Supported (see Section 119.18, "Configuring a Descriptor with EJB CMP and BMP Information"). |
|
Exclusive write access on bean |
Default value is |
Assume |
|
Insert without existence check |
Supported |
Supported |
|
Update changed fields only |
Supported |
Supported (see Section 113.2.3.3, "Attribute Change Tracking Policy"). |
|
Force update |
Invoke bean life cycle |
Supported |
For more information, see "Migrating from OC4J Persistence to TopLink" in the "Developing TopLink Mappings" section of the Oracle JDeveloper online help.
From TopLink Workbench, select File > Migrate > From OC4J 9.0.x.
Figure 8-3 Create TopLink Workbench Projects from OC4J Migration Dialog Box
Use the following information to enter data in each field of the Create TopLink Workbench Projects from OC4J Migration dialog box:
| Field | Description |
|---|---|
| From | Use these fields to specify the location of the existing OC4J files. These files may be included as part of a JAR, EAR, or individual files. |
| Individual Files | Select to convert from individual ejb-jar.xml and orion-ejb-jar.xml files in the Input Directory. Click Browse and select the directory location that contains the XML files to convert from. |
| Archive File | Select to use a specific archive file. Click Browse and select the archive file to convert from. |
| To | Use these fields to specify the location to which migrated files are written. |
| Output Directory | Click Browse and select a directory location in which to create the new XML files and TopLink Workbench project. |
| Classpath | If you are migrating from individual files, ensure that the domain classes are accessible and included in your classpath. |
| Show Migration Log | Select to have migration log output displayed in a separate window. |
To use the TopLink migration tool from the command line, you must perform the following steps:
Ensure that the following is in your classpath:
<TOPLINK_HOME>/modules/oracle.toplink_11.1.1/jlib/antlr.jar
<TOPLINK_HOME>/jlib/toplink.jar
<TOPLINK_HOME>/utils/workbench/jlib/cmpmigrator.jar
<TOPLINK_HOME>/utils/workbench/jlib/toplinkmw.jar
<TOPLINK_HOME>/utils/workbench/jlib/tlmwcore.jar
<TOPLINK_HOME>/jlib
<TOPLINK_HOME>/modules/xmlparserv2.jar
If you intend to migrate from plain XML files (rather than an EAR or JAR file), ensure that the domain classes are accessible and included in your classpath.
Make a backup copy of your original XML files.
Execute the TopLink migration tool, as Example 8-4 illustrates, using the appropriate arguments listed in Table 8-5.
The usage information for the TopLink migration tool is as follows:
java -Dtoplink.ejbjar.schemavalidation=<true|false> -Dtoplink.migrationtool.generateWorkbenchProject=<true|false> -Dhttp.proxyHost=<proxyHost> -Dhttp.proxyPort=<proxyPort> oracle.toplink.tools.migration.TopLinkCMPMigrator -s<nativePM> -i<inputDir> -a<ear>|<jar> -x -o<outputDir> -v
To identify the input files, you must specify one of -a or -x.
For troubleshooting information, see Section 8.4.2.6, "Troubleshooting Your Migration".
Example 8-4 Using the TopLink Migration Tool from the Command Line
java -Dhttp.proxyHost=www-proxy.us.oracle.com -Dhttp.proxyPort=80 oracle.toplink.tools.migration.TopLinkCMPMigrator -sOc4j-native -iC:/mywork/in -aEmployee.ear -oC:/mywork/out -v
Table 8-5 TopLink Migration Tool Arguments
| Argument | Description |
|---|---|
|
|
The system property used to turn on schema validation if |
|
|
The system property used enable generation of the TopLink Workbench project. The default value is |
|
|
The address of your local HTTP proxy host |
|
|
The port number on which your local HTTP proxy host receives HTTP requests. |
|
|
The name of the native persistence manager from which you are migrating. For OC4J, use the name |
|
|
Fully qualified path to the input directory that contains both the OC4J |
|
|
Fully qualified path to the archive file (either an EAR or JAR) that contains both the OC4J |
|
|
Tells the TopLink migration tool that the OC4J files in the input directory to migrate from are plain XML files (not in an archive file). If you use this option, ensure that the domain classes are accessible and included in your classpath. |
|
|
Ensure that permissions are set on this directory to allow the TopLink migration tool to create files and subdirectories. |
|
|
Verbose mode. Tells the TopLink migration tool to log errors and diagnostic information to the console. |
After you migrate the orion-ejb-jar.xml file persistence configuration to your toplink-ejb-jar.xml file, consider the following post-migration changes:
Recovering persistence-type Table Column Size
In the orion-ejb-jar.xml file, you can specify this mapping, cmp-field-mapping, with a persistence-type attribute that provides both the type and column size, as shown in Example 8-5.
Example 8-5 A cmp-field-mapping with persistence-type Specifying a Column Size
<cmp-field-mapping ejb-reference-home="MyOtherEntity" name="myField" persistence-name="myField" persistence-type="VARCHAR2(30)">
The TopLink migration tool migrates the persistence type but not the column size because a TopLink project does not normally contain this size information.
To recover the persistence-type column size, do the following:
Perform the migration as described in Section 8.4.2.4, "Using the TopLink Migration Tool from the Command Line".
Launch the generated TopLink Workbench project file TLCmpProject.mwp.
Log in to your database (see Section 5.5.1.1, "Logging In and Out of a Database").
TopLink Workbench retrieves all column sizes.
Updating the Unknown Primary Key Class Mapping Sequence Table
TopLink supports the use of an unknown primary key class (see Section 8.9.2, "How to Configure EJB CMP Unknown Primary Key Class Support") and so the TopLink migration tool also supports this feature.
OC4J uses a native run-time key generator to generate unique keys for auto-id key fields. In contrast, TopLink uses a sequencing table.
If your OC4J persistence configuration includes the use of an unknown primary key class, then the TopLink migration tool will create a sequencing table for this purpose.
Before deploying your application after migration, you must do the following:
Determine the largest key value generated prior to migration.
Manually update the counter of the TopLink migration tool-generated sequence table to a number that must be one larger than the largest key value generated prior to migration.
Customizing a Project
You can customize the following components of your project:
For an EJB 2.1 CMP application deployed to OC4J, you customize the TopLink persistence manager by configuring properties in the orion-ejb-jar.xml file. These properties are used to configure the TopLink session that the TopLink runtime uses internally for CMP projects. For more information, see Section 9.9.1, "How to Configure persistence-manager Entries".
After you applied the default settings to your project at deployment time, you may wish to customize the TopLink session by configuring the session event listener. The pre-login event that the session raises is particularly useful. It lets you define the custom (nondefault) specifics for the session just before the session initializes and acquires connections.
For more information, see the following:
This section describes solutions for problems you may encounter during migration, including the following:
Log Messages
As it operates, the TopLink migration tool logs all errors and diagnostic output to a log file named oc4j_migration.log in the output directory. If you use the TopLink migration tool from TopLink Workbench, see also the TopLink Workbench log file oracle.toplink.workbench.log located in your user home directory (for example, C:\Documents and Settings\<user-name>)
In addition to these warnings, the TopLink migration tool logs an error if it encounters a problem that prevents it from completing the migration. Table 8-6 lists these problems and suggests possible solutions.
Table 8-6 TopLink Migration Tool Error Messages
| Error Message | Description |
|---|---|
|
There is no |
The Verify that the |
|
There is not an |
The Verify that the |
|
|
A Remove the |
|
The entity (ENTITY_NAME) in |
An entity is not mapped to database table. Before migration, confirm that you map all CMP entities in your application to one or more database tables in the |
Unexpected Relational Multiplicity
The TopLink migration tool retrieves relationship multiplicity from the orion-ejb-jar.xml file and not from the OC4J ejb-jar.xml file.
Thus, even though the OC4J ejb-jar.xml file defines a relationship to be one-to-many, if the orion-ejb-jar.xml file defines the same relationship as many-to-many, then the TopLink migration tool will migrate the relationship as many-to-many.
For applications that require JTA integration, specify the external transaction controller when you configure the server platform in your session (see Section 89.9, "Configuring the Server Platform").
For more information, see Section 115.13, "Integrating the Unit of Work with an External Transaction Service".
Oracle recommends that you consider TopLink support for Oracle Application Server Manageability and Diagnosability to simplify application management and problem diagnosis.
For more information, see Section A.1, "TopLink Support for Oracle Application Server Manageability and Diagnosability".
To integrate a TopLink application with IBM WebSphere Application Server, you must consider the following:
In addition to configuring these IBM WebSphere application server-specific options, you must also consider the general application server integration issues in Section 8.2, "Integrating TopLink with an Application Server".
You configure the IBM WebSphere application server classpath differently depending on what version of this server you are using:
TopLink provides JTA and general integration support for IBM WebSphere application server 6.1 and later. To configure the classpath for this version, do the following:
Create a shared library that contains the following Toplink JAR files and associate the shared library with the application:
<TOPLINK_HOME>\jlib\toplink.jar
Ensure that your TopLink application defines an XML parser platform (see Section 8.2.2, "How to Configure the XML Parser Platform").
If you are deploying a TopLink enabled application that uses TopLink sessions.xml or XML project deployment, you must use the WebSphere Application Server Administrative Console to set Class loader order to Class loaded with application class loader first.
For applications that require JTA integration, specify the external transaction controller when you configure the server platform in your session (see Section 89.9, "Configuring the Server Platform").
For more information, see Section 115.13, "Integrating the Unit of Work with an External Transaction Service".
For information on integrating a TopLink application with an application server cluster, see Section 8.2.5, "How to Integrate Clustering".
To integrate a TopLink application with Sun Application Server (SunAS), you must consider the following:
In addition to configuring these SunAS-specific options, you must also consider the general application server integration issues in Section 8.2, "Integrating TopLink with an Application Server".
To configure TopLink support for SunAS, do the following:
Add the following JAR files to the application server classpath:
<TOPLINK_HOME>\jlib\toplink.jar
Ensure that your TopLink application defines an XML parser platform (see Section 8.2.2, "How to Configure the XML Parser Platform").
For applications that require JTA integration, specify the external transaction controller when you configure the server platform in your session (see Section 89.9, "Configuring the Server Platform").
For more information, see Section 115.13, "Integrating the Unit of Work with an External Transaction Service".
To integrate a TopLink application with JBoss Application Server, you must consider the following:
In addition to configuring these JBoss-specific options, you must also consider the general application server integration issues in Section 8.2, "Integrating TopLink with an Application Server".
To configure TopLink support for JBoss, do the following:
Add the following JAR files to the application server classpath:
<TOPLINK_HOME>\jlib\toplink.jar
Ensure that your TopLink application defines an XML parser platform (see Section 8.2.2, "How to Configure the XML Parser Platform").
For applications that require JTA integration, specify the external transaction controller when you configure the server platform in your session (see Section 89.9, "Configuring the Server Platform").
For more information, see Section 115.13, "Integrating the Unit of Work with an External Transaction Service".
For JPA applications, to enable the container to manage entities, statically weave the entities and reference JBoss as the target server in the persistence.xml file.Perform the following deployment changes:
If weaving is required, statically weave the entities before EAR packaging. Use either the command-line weaver or the weaving Ant task (see "How to Configure Static Weaving for JPA Entities" section of EclipseLink Developer's Guide at http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_%28ELUG%29#How_to_Configure_Static_Weaving_for_JPA_Entities).
Ensure that the eclipselink.target-server property (see "Using EclipseLink JPA Extensions for Session, Target Database and Target Application Server" section of EclipseLink Developer's Guide at http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_%28ELUG%29#Using_EclipseLink_JPA_Extensions_for_Session.2C_Target_Database_and_Target_Application_Server) is set in the persistence.xml file of all persistence units deployed to the JBoss container:
<property name="eclipselink.target-server" value="JBoss"/>
Otherwise, even though the container-managed entities are predeployed, they will not be managed at run time.
For more information, see "How to Deploy an Application to Generic Java EE 5 Application Servers" section of EclipseLink Developer's Guide at http://wiki.eclipse.org/Packaging_and_Deploying_EclipseLink_JPA_Applications_%28ELUG%29#How_to_Deploy_an_Application_to_Generic_Java_EE_5_Application_Servers.
By default, when you run a TopLink-enabled application in a JVM configured with a nondefault java.lang.SecurityManager, the TopLink run time executes certain internal functions by executing a PrivilegedAction with java.security.AccessController method doPrivileged. This ensures that you do not need to grant many permissions to TopLink for it to perform its most common operations. You need only grant certain permissions depending on the types of optional TopLink features you use (see Section 8.8.1, "How to Define Permissions Required by TopLink Features").
While using doPrivileged method provides enhanced security, it will severely impact overall performance. Alternatively, you can configure TopLink to disable the use of doPrivileged method even when a nondefault SecurityManager is present (see Section 8.8.3, "How to Disable doPrivileged Operation"). In this case, you must grant TopLink all required permissions (see Section 8.8.1, "How to Define Permissions Required by TopLink Features" and Section 8.8.2, "How to Define Permissions Required when doPrivileged Is Disabled").
Note:
While enabling the use ofdoPriviledged method enhances TopLink application security, it does not guarantee that secure code cannot be called by application code in ways that the system did not intend. You must consider the use of doPriviledged method within the context of your overall application security strategy. For more information, see http://java.sun.com/security/index.jsp.If you run a TopLink-enabled application in a JVM without a nondefault SecurityManager, you do not need to grant any permissions.
When you run a TopLink-enabled application in a JVM configured with a nondefault java.lang.SecurityManager and doPrivileged operation is enabled, you may need to grant additional permissions if your application requires any of the following:
By default, a TopLink-enabled application requires access to the system properties granted in the default <JAVA_HOME>/lib/security/java.policy file. If your application requires access to other platform-specific, environment, or custom properties, then grant further PropertyPermission permissions, as Example 8-6 shows.
Most TopLink-enabled applications read in project.xml and sessions.xml files directly. Grant permissions to the specific files or file locations, as Example 8-7 shows. This example assumes that both project.xml and sessions.xml files are located in the same directory (given by application-specific system property deployment.xml.home). Alternatively, you can specify a separate FilePermission for each file.
Example 8-7 Permissions for Loading Deployment XML Files
permission java.io.FilePermission "${deployment.xml.home}/*.xml", "read";
For information on FilePermission settings for Java EE applications, see Section 8.8.1.6, "Granting Permissions for Java EE Application Deployment".
If your application uses cache coordination (see Section 102.3, "Cache Coordination"), then grant accept, connect, listen, and resolve permissions to the specific sockets used by your coordinated cache, as Example 8-8 shows. This example assumes that the coordinated cache multicast port (see Section 103.5, "Configuring a Multicast Port") is 1024.
If your TopLink-enabled application accesses a data source using a socket, then grant connect and resolve permissions for that socket, as Example 8-9 shows. This example assumes that the host name (or IP address) of the remote host that provides the data source (such as a relational database server host) is given by application-specific system property remote.data.source.host and that this host accepts data source connections on port 1025.
Example 8-9 Permissions for non-Java EE Data Source Connections
permission java.net.SocketPermission "${remote.data.source.host}:1025-", "connect, resolve";
For Java EE applications, data source socket permissions are usually handled by the application server.
If you configure your TopLink-enabled application to use java.util.logging package (see Section 89.4, "Configuring Logging"), then grant your application control permissions, as Example 8-10 shows.
If you are deploying a TopLink-enabled Java EE application, you must grant permissions for the following:
The toplink.jar file. For example:
grant codeBase "file:<TOPLINK_HOME>/jlib/toplink.jar" {
permission java.security.AllPermission;
};
If you are using an XML platform, you must also grant the following permissions:
The toplink.xml.platform system property. For Example:
permission java.util.PropertyPermission "toplink.xml.platform", "read"
If you disable doPrivileged operation when you run a TopLink-enabled application in a JVM configured with a nondefault java.lang.SecurityManager, you must grant the following permissions:
java.lang.reflect.RelectPermission "suppressAccessChecks"
java.lang.RuntimePermission "accessDeclaredMembers"
java.lang.RuntimePermission "getClassLoader"
You may also have to grant additional permissions depending on the TopLink features your application uses. For more information, see Section 8.8.1, "How to Define Permissions Required by TopLink Features".
To disable doPrivileged operation when you run a TopLink-enabled application in a JVM configured with a nondefault java.lang.SecurityManager, set system property oracle.j2ee.toplink.security.usedoprivileged to false. If you are using OC4J, set system property oracle.j2ee.security.usedoprivileged to false.
To enable doPrivileged operation, set these system properties to true.
TopLink provides system properties that you can use to customize the following EJB CMP options:
Setter Parameter Type Checking (see Section 8.9.1, "How to Configure EJB CMP Setter Parameter Type Checking")
Unknown Primary Key Class Support (see Section 8.9.2, "How to Configure EJB CMP Unknown Primary Key Class Support")
Single-Object Finder Return Type Checking (see Section 8.9.3, "How to Configure EJB CMP Single-Object Finder Return Type Checking")
To make TopLink verify that the parameters to one-to-one and one-to-many relationship setters are of the same type as the corresponding CMR field, set system property toplink.cts.collection.checkParameters to a value of true (not case sensitive). If the setters are not the same type, then TopLink throws a java.lang.IllegalArgumentException.
Note:
Setting this property totrue will affect performance. Use this setting only if necessary.If you set the property to false (the default value), TopLink does not make this verification. In this case, it is up to your application to make sure the parameters are of the correct type.
For more information, see Section 10.3.6 of the EJB 2.1 specification.
In special situations, you may choose not to specify the primary key class or the primary key fields for an entity bean with container-managed persistence. For example, if the entity bean does not have a natural primary key or you want the deployer to select the primary key fields at deployment time, you may choose to defer primary key type specification.
If this is the case, you must declare the type of the argument of the findByPrimaryKey method as java.lang.Object and you must also specify the primary key class (prim-key-class) in the deployment descriptor (ejb-jar.xml) as java.lang.Object.
TopLink provides run-time support for such deferred primary key type specification.
For more information, see Section 10.8.3 of the EJB 2.1 specification.
By setting system property toplink.cts.checkMultipleRows to true, you can configure TopLink to throw a javax.ejb.FinderException if multiple beans are returned from a single-object finder method.For more information, see Section 10.5.6.1 of the EJB 2.1 specification.
|
 Copyright © 1997, 2008, Oracle. All rights reserved. Legal Notices |
|