Jump to: navigation, search

EclipseLink/Examples/JPA/OC4J Web Tutorial

< EclipseLink‎ | Examples‎ | JPA
Revision as of 09:47, 19 February 2009 by Michael.obrien.oracle.com (Talk | contribs) (Verify OC4J Installation)

EclipseLink JPA Deployed on OC4J using Eclipse WTP

Document History

Date Author Version Description & Notes
20080601 Michael O'Brien Initial version covering Oracle OC4J 10.1.3.4 and 11.1.1.0
20090217 Michael O'Brien Update for version 10.1.3.5 or 10.1.4

If you want to get a small web application running quickly on OC4J use the services provided by the Web Tools Project plugin in the Eclipse IDE to take care of deployment details for you.

This basic example details how to use Eclipse to run/debug a minimum J2EE web application servlet using EclipseLink JPA as the persistence provider. The goal of this example is to detail the minimum steps needed to run EclipseLink inside OC4J using the Eclipse IDE - at this point no presentation/controller layer such as JSF, Spring or Struts will be used beyond a basic HttpServlet so we can concentrate on the the integration layer JPA setup.

The DALI project was used to generate Entities from a schema with sequences already populated.

Development Environment

Hardware: Windows Vista SP1, Core2Duo E8400 45nm, 3.0Ghz, 3Gb Ram

Software: Eclipse IDE for Java EE 3.4 Ganymede (SR1 Oct 2008), Oracle 11g DB 11.1.0.6.0, Java JDK 1.6.0_07, OC4J 10.1.3.4.0 20080709

This example will run fine with any DB that EclipseLink supports via the eclipselink.target-database tag.

Prerequisites

  • Install Eclipse
    • I installed a clean version of Eclipse Ganymede M5 with all of WTP 3.0
  • Install a Database
    • In this example I am using Oracle 11g, the table schemas have already been created manually and all entity java classes have been generated using the Eclipse DALI tool.
C:\opt\oc4j1014
Where 
OC4J_HOME=C:/opt/oc4j1014/j2ee/home
ORACLE_HOME=c:/opt/oc4j1014

Verify OC4J Installation

  • Before we add EclipseLink and our own JTA datasource to OC4J, lets verify the installation outside of eclipse before adding the server to the IDE. Note: Do not start the server for the first time in Eclipse - you need to set the admin password interactively the first time you launch the server.
  • Launch server via CMD prompt - and create your admin password.
C:\opt\oc4j1014\bin>oc4j -start
Starting OC4J from c:\opt\oc4j1014\j2ee\home ...
2009-02-18 14:15:03.406 NOTIFICATION Auto-unpacking C:\opt\oc4j1014\j2ee\home\applications\dms.war...
...
Feb 18, 2009 2:15:09 PM com.evermind.server.XMLApplicationServerConfig randomizeJtaAdminPassword
INFO: Updating JtaAdmin account
09/02/18 14:15:09 Set OC4J administrator's password (password text will not be displayed as it is entered)
Enter password:
Confirm password:
The password for OC4J administrator "oc4jadmin" has been set.
09/02/18 14:15:21 The OC4J administrator "oc4jadmin" account is activated.
09/02/18 14:15:27 Oracle Containers for J2EE 10g (10.1.3.5.0)  initialized
  • Verify HTTP 8888 and ORMI 23791 ports are running.
C:\opt\oc4j1014\bin>netstat -a
  TCP    0.0.0.0:8888           mfobrien-PC3:0         LISTENING
  TCP    0.0.0.0:23791          mfobrien-PC3:0         LISTENING
  • Verify that shutdown works fine
    • Open a separate cmd prompt and shutdown the server.
C:\opt\oc4j1014\bin>oc4j -shutdown -port 23791 -password password
Shutdown OC4J instance...
C:\opt\oc4j1014\bin>
  • Observe that oc4j is shutdown in the original CMD prompt.
09/02/18 14:38:22 Shutting down...
C:\opt\oc4j1014\bin>

OC4J configuration Changes

  • OC4J ships with a default JTA datasource called OracleDS that points to an Oracle DB install on the same machine.
  • Use or Edit the OC4J config in $OC4J_HOME/config/data-sources.xml and enter the following DataSource definition for JTA and non-JTA sources and refering to it in the managed-data-source. The only thing you may need to change is the IP address 127.0.0.1 if your database server is on another machine, the user, password and schema name orcl.
  <managed-data-source name="OracleDS" connection-pool-name="local oracle11g" jndi-name="jdbc/OracleDS"/>
  <connection-pool name="local oracle11g">
    <connection-factory factory-class="oracle.jdbc.pool.OracleDataSource"
      user="user"
      password="password"
      url="jdbc:oracle:thin:@//127.0.0.1:1521/orcl">
    </connection-factory>
  </connection-pool>


EclipseLink JAR location

The eclipselink.jar should be placed as noted by config/server.xml in the directory $OC4J_HOME/applib

  <!-- Global application libraries -->
  <shared-library name="global.libraries" version="1.0" library-compatible="true">
    <code-source path="../applib"/>
  </shared-library>

JDBC JAR location

  • There is an existing Oracle jdbc driver in OC4J_HOME/../jdbc/lib/orai18n.jar
  • Or, copy your specific jdbc driver jar to $OC4J_HOME/applib

Create server in Eclipse

Open the servers view New | Server | Oracle | Oracle OC4J Standalone Server 10.1.3.1 (it is ok to use this one for 11.1.1). The only default I had to change was my admin user from oc4jadmin to fmwadmin.

Start OC4J the first time Outside Eclipse

  • If this is the first time you are running your OC4J server, you will want to login from a CMD prompt - to set the password.
  • The ORACLE_HOME environment variable should also be set to a truncated OC4J_HOME or c:\opt\oc4j101340
  • Start the server with $OC4J_HOME/bin/oc4j -start and set the oc4jadmin password
  • shutdown the server C:\opt\oc4j101340\bin>oc4j -shutdown -port 8888 -password password

Create J2EE application

Check out the 3 example projects in the trunk '(TBD) or create your own J2EE Enterprise Application as below. File | new | project | J2EE | Enterprise Application Project Select server, use 5.0 Ear version

Create a new Web and an optional EJB project

Select generate deployment descriptor if you want to change the context-root

  • Path changes
	<classpathentry combineaccessrules="false" kind="src" path="/eclipselink.core"/>
	<classpathentry combineaccessrules="false" kind="src" path="/eclipselink.jpa"/>
  • After EAR project creation - reference eclipselink.core and eclipselink.jpa or include a reference to eclipselink.jar in your WAR project.
  • If you don't reference the eclipselink.* projects then include a classpath reference to persistence.jar and an Oracle JDBC driver jar for your DB - You will need to put this JDBC driver jar in your OC4J applib directory as well.

persistence.xml

  • Put persistence.xml in yourProjectEJB/ejbModule/META-INF
<persistence version="1.0" xmlns="http://java.sun.com/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd">
    <persistence-unit name="statJPAJ2EE" transaction-type="JTA">
       <provider>org.eclipse.persistence.jpa.PersistenceProvider</provider>
        <non-jta-data-source>jdbc/OracleDS</non-jta-data-source>
        <class>org.eclipse.persistence.example.navigation.business.StatClass</class>
… other entity classes
        <properties>
            <property name="eclipselink.target-server" value="OC4J"/>
            <property name="eclipselink.weaving" value="true"/>
            <property name="eclipselink.logging.level" value="FINEST"/>
        </properties>       
    </persistence-unit>
</persistence>

J5EE: Container Managed Persistence

  • Inject the Session Bean (DAO) and the EntityManager via
@Local
@Stateless
public class ApplicationService implements ApplicationServiceLocal {
	@PersistenceContext(unitName="statJPAJ2EE")	
	private EntityManager entityManager;

and...
public class FrontController extends HttpServlet implements Servlet {
	@EJB
	public ApplicationService applicationService;

J2SE: Application Managed Persistence

  • Put persistence.xml in yourProjectWeb/src/META-INF
<persistence version="1.0" xmlns="http://java.sun.com/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd">
    <persistence-unit name="statJPAJ2EE" transaction-type="RESOURCE_LOCAL">
       <provider>org.eclipse.persistence.jpa.PersistenceProvider</provider>
        <non-jta-data-source>jdbc/OracleDS</non-jta-data-source>
        <class>org.eclipse.persistence.example.navigation.business.StatClass</class>
… other entity classes
        <properties>
            <property name="eclipselink.target-server" value="OC4J"/>
            <property name="eclipselink.logging.level" value="FINEST"/>
        </properties>       
    </persistence-unit>
</persistence>

Start Server

  • Steps: Select the EAR and [Run on Server].
  • The first "Run on Server" may not start the server, in this case you "Start Server" and then "Run on Server".

Publish EAR

  • Eclipse WTP will take care of dynamically generating all the orion*.xml files required by OC4J when you either [re-publish] or modify any files while the server is running.
  • You may also use any combination of running the OC4J server yourself in run or debug mode and using eclipse to publish EAR changes.
  • In the predeploy EAR Ant task you should see weaving messages for your entities if logs are set to FINEST in persistence.xml
  • Depending on your application you will see the following after running [start server]
    • In your console window you will see two processes - one for the server and the second for the deploy target.
Oracle OC4J SA Server 11.1.1.0.0 localhost [Generic Server]	
	C:\jdk1.5.0\bin\javaw.exe (Apr 9, 2008 9:06:19 AM)	
<terminated>jpaELTestEAR module publisher [Ant Build]	
	<terminated, exit value: 0>C:\jdk1.5.0\bin\javaw.exe (Apr 9, 2008 9:06:36 AM)	
  • If you click on the deploy target console you will see the deploy logs from the WTP oracle*.xml Ant target...
Buildfile: C:\eclipse34\plugins\org.eclipse.jst.server.generic.oc4j_1.5.105.v20071217\buildfiles\oracle.10.1.3.xml
check.skip.ear.deploy:
deploy.j2ee.ear:
package.module.ear:
      [jar] Building jar: C:\opt\oc4j11samba\j2ee\home\applications\jpaELTestEAR.ear
[oracle:deploy] Deploying application jpaELTestEAR.
...
[oracle:deploy] Application deployer for jpaELTestEAR COMPLETES.
  • If you click on the server console you will see the predeploy weaving logs
08/04/09 09:06:29 Oracle Containers for J2EE 11g (11.1.1.0.0)  initialized.
08/04/09 09:06:39 Application Deployer for jpaELTestEAR STARTS.
...
08/04/09 09:06:39 Started application : jpaELTestEAR
08/04/09 09:06:39 Binding jpaELTestWeb web-module for application jpaELTestEAR to site default-web-site under context root jpaELTest
[EPS Finest]: 2008.04.09 09:06:39.893--ServerSession(23543153)--Thread(Thread[DeployerRunnable Thread for jpaELTestEAR,9,SystemThreadGroup])--Begin predeploying Persistence Unit statJPAJ2EE; state Initial; factoryCount 0
...
[EL Finer]: 2008.04.09 09:06:39.940--ServerSession(23543153)--Thread(Thread[DeployerRunnable Thread for jpaELTestEAR,9,SystemThreadGroup])--Found a default mapping file at file:/C:/opt/oc4j11samba/j2ee/home/applications/jpaELTestEAR/jpaELTestWeb/WEB-INF/classes/META-INF/orm.xml for root URL file:/C:/opt/oc4j11samba/j2ee/home/applications/jpaELTestEAR/jpaELTestWeb/WEB-INF/classes/
...
[EL Finer]: 2008.04.09 09:06:40.783--ServerSession(23543153)--Thread(Thread[DeployerRunnable Thread for jpaELTestEAR,9,SystemThreadGroup])--Class [org.eclipse.persistence.example.navigation.business.StatClass] registered to be processed by weaver.
...
[EL Finest]: 2008.04.09 09:06:40.783--ServerSession(23543153)--Thread(Thread[DeployerRunnable Thread for jpaELTestEAR,9,SystemThreadGroup])--End predeploying Persistence Unit statJPAJ2EE; state Predeployed; factoryCount 1
[EL Finest]: 2008.04.09 09:06:41.033--ServerSession(23543153)--Thread(Thread[DeployerRunnable Thread for jpaELTestEAR,9,SystemThreadGroup])--Begin weaver class transformer processing class [org/eclipse/persistence/example/navigation/business/StatClass].
[EL Finest]: 2008.04.09 09:06:41.079--ServerSession(23543153)--Thread(Thread[DeployerRunnable Thread for jpaELTestEAR,9,SystemThreadGroup])--End weaver class transformer processing class [org/eclipse/persistence/example/navigation/business/StatClass].
...
08/04/09 09:06:41 Application Deployer for jpaELTestEAR COMPLETES. Operation time: 2155 msecs

Perform a JPQL query

emf = Persistence.createEntityManagerFactory(puName);
entityManager = emf.createEntityManager();

Console Output

08/04/09 09:19:29 Action: init
[EL Finest]: 2008.04.09 09:19:29.634--ServerSession(2059288)--Thread(Thread[HTTPThreadGroup-1,9,HTTPThreadGroup])--Begin deploying Persistence Unit statJPAJ2EE; state Predeployed; factoryCount 2
[EPS Warning]: 2008.04.09 09:19:29.868--ServerSession(2059288)--Thread(Thread[HTTPThreadGroup-1,9,HTTPThreadGroup])--PersistenceUnitInfo statJPAJ2EE has transactionType RESOURCE_LOCAL and therefore jtaDataSource will be ignored
[EL Info]: 2008.04.09 09:19:29.884--ServerSession(2059288)--Thread(Thread[HTTPThreadGroup-1,9,HTTPThreadGroup])--EclipseLink, version: Eclipse Persistence Services - 1.0 (Build SNAPSHOT - 20080403)
[EL Config]: 2008.04.09 09:19:30.289--ServerSession(2059288)--Connection(17254324)--Thread(Thread[HTTPThreadGroup-1,9,HTTPThreadGroup])--connecting(DatabaseLogin(
	platform=>OraclePlatform
	user name=> "stat"
	connector=>JNDIConnector datasource name=>null
))
[EL Config]: 2008.04.09 09:19:30.289--ServerSession(2059288)--Connection(16022259)--Thread(Thread[HTTPThreadGroup-1,9,HTTPThreadGroup])--Connected: jdbc:oracle:thin:@//127.0.0.1:1521/orcl
	User: STAT
	Database: Oracle  Version: Oracle Database 11g Release 11.1.0.0.0 - Production
	Driver: Oracle JDBC driver  Version: 11.1.0.6.0-Production+
[EL Finest]: 2008.04.09 09:19:30.289--ServerSession(2059288)--Thread(Thread[HTTPThreadGroup-1,9,HTTPThreadGroup])--sequencing connected, state is Preallocation_NoTransaction_State
[EL Finest]: 2008.04.09 09:19:30.289--ServerSession(2059288)--Thread(Thread[HTTPThreadGroup-1,9,HTTPThreadGroup])--sequence STAT_CLASS_SEQ_GENERATOR: preallocation size 25
[EL Info]: 2008.04.09 09:19:30.336--ServerSession(2059288)--Thread(Thread[HTTPThreadGroup-1,9,HTTPThreadGroup])--file:/C:/opt/oc4j11samba/j2ee/home/applications/jpaELTestEAR/jpaELTestWeb/WEB-INF/classes/-statJPAJ2EE login successful
[EL Finest]: 2008.04.09 09:19:30.336--ServerSession(2059288)--Thread(Thread[HTTPThreadGroup-1,9,HTTPThreadGroup])--End deploying Persistence Unit statJPAJ2EE; state Deployed; factoryCount 2
  • Exercise your application in a browser by requesting a JPQL query
    • Launch
      http://127.0.0.1:8888/jpaELTest/FrontController?action=query&jpql=select%20object(e)%20from%20StatLabel%20e%20where%20e.id<100

Browser Output

Eclipselink example jpa oc4j web jpql action cap.jpg

Troubleshooting

References