Difference between revisions of "EclipseLink/Examples/JPA/OutsideContainer"

From Eclipsepedia

Jump to: navigation, search
(Customizing Persistence Unit using Java)
m
 
(7 intermediate revisions by one user not shown)
Line 1: Line 1:
Users may also use the EntityManager API outside the container by creating a EntityManagerFactory for a given persistence unit name and properties map (includes database information etc.)
+
Users may also use the EntityManager API outside the container, either through configuring a <code>persistence.xml</code>, or by creating a EntityManagerFactory for a given persistence unit name and properties map (includes database information etc.)
  
<code><pre>
+
<source lang="java">
 
EntityManagerFactory emf = Persistence.createEntityManagerFactory(persistenceUnitName, propertiesMap);
 
EntityManagerFactory emf = Persistence.createEntityManagerFactory(persistenceUnitName, propertiesMap);
 
EntityManager em = emf.createEntityManager();
 
EntityManager em = emf.createEntityManager();
</pre></code>
+
</source>
 +
 
 +
 
 +
== JavaSE Configuration using persistence.xml ==
 +
 
 +
<source lang="xml">
 +
<persistence 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 persistence_1_0.xsd"
 +
        version="1.0">
 +
  <persistence-unit name="my-app" transaction-type="RESOURCE_LOCAL">
 +
    <provider>org.eclipse.persistence.jpa.PersistenceProvider</provider>
 +
    <exclude-unlisted-classes>false</exclude-unlisted-classes>
 +
    <properties>
 +
      <property name="javax.persistence.jdbc.driver" value="oracle.jdbc.OracleDriver"/>
 +
      <property name="javax.persistence.jdbc.url" value="jdbc:oracle:thin:@localhost:1521:orcl"/>
 +
      <property name="javax.persistence.jdbc.user" value="scott"/>
 +
      <property name="javax.persistence.jdbc.password" value="tiger"/>
 +
    </properties>
 +
  </persistence-unit>
 +
</persistence>
 +
</source>
 +
 
 +
Note, <code>"javax.persistence.jdbc"</code> is used in JPA 2.0, as of EclipseLink 1.2, previously <code>"eclipselink.jdbc"</code> must be used.
 +
 
 +
Now the EntityManagerFactory can be instantiated using:
 +
 
 +
<source lang="java">
 +
Persistence.createEntityManagerFactory("my-app");
 +
</source>
  
 
== JavaSE Configuration using Property Map ==
 
== JavaSE Configuration using Property Map ==
Line 10: Line 39:
 
When a simple persistence unit configuration is defined which relies on container deployment:
 
When a simple persistence unit configuration is defined which relies on container deployment:
  
<pre>
+
<source lang="xml">
<persistence-unit name="employee" transaction-type="RESOURCE_LOCAL">
+
<persistence-unit name="employee" transaction-type="RESOURCE_LOCAL">
<non-jta-data-source>jdbc/MyDS</non-jta-data-source>
+
    <non-jta-data-source>jdbc/MyDS</non-jta-data-source>
</persistence-unit>
+
</persistence-unit>
</pre>
+
</source>
  
 
In order to test this persistence unit outside of the container the JavaSE bootstrapping API must be used. the following code can be used to customize the configuration:
 
In order to test this persistence unit outside of the container the JavaSE bootstrapping API must be used. the following code can be used to customize the configuration:
  
<pre>
+
<source lang="java">
import static org.eclipse.persistence.jpa.config.PersistenceUnitProperties.*;
+
import static org.eclipse.persistence.config.PersistenceUnitProperties.*;
 +
 
 +
    ...
 +
 
 +
    Map properties = new HashMap();
 +
 
 +
    // Ensure RESOURCE_LOCAL transactions is used.
 +
    properties.put(TRANSACTION_TYPE,
 +
        PersistenceUnitTransactionType.RESOURCE_LOCAL.name());
 +
 
 +
    // Configure the internal EclipseLink connection pool
 +
    properties.put(JDBC_DRIVER, "oracle.jdbc.OracleDriver");
 +
    properties.put(JDBC_URL, "jdbc:oracle:thin:@localhost:1521:ORCL");
 +
    properties.put(JDBC_USER, "scott");
 +
    properties.put(JDBC_PASSWORD, "tiger");
  
...
+
    // Configure logging. FINE ensures all SQL is shown
 +
    properties.put(LOGGING_LEVEL, "FINE");
 +
    properties.put(LOGGING_TIMESTAMP, "false");
 +
    properties.put(LOGGING_THREAD, "false");
 +
    properties.put(LOGGING_SESSION, "false");
  
Map properties = new HashMap();
+
    // Ensure that no server-platform is configured
 +
    properties.put(TARGET_SERVER, TargetServer.None);
 +
</source>
  
// Ensure RESOURCE_LOCAL transactions is used.
+
Now the EntityManagerFactory can be instantiated for testing using:
properties.put(TRANSACTION_TYPE,
+
PersistenceUnitTransactionType.RESOURCE_LOCAL.name());
+
  
// Configure the internal EclipseLink connection pool
+
<source lang="java">
properties.put(JDBC_DRIVER, "oracle.jdbc.OracleDriver");
+
Persistence.createEntityManagerFactory(unitName, properties);
properties.put(JDBC_URL, "jdbc:oracle:thin:@localhost:1521:ORCL");
+
</source>
properties.put(JDBC_USER, "scott");
+
properties.put(JDBC_PASSWORD, "tiger");
+
properties.put(JDBC_READ_CONNECTIONS_MIN, "1");
+
properties.put(JDBC_WRITE_CONNECTIONS_MIN, "1");
+
  
// Configure logging. FINE ensures all SQL is shown
 
properties.put(LOGGING_LEVEL, "FINE");
 
properties.put(LOGGING_TIMESTAMP, "false");
 
properties.put(LOGGING_THREAD, "false");
 
properties.put(LOGGING_SESSION, "false");
 
  
// Ensure that no server-platform is configured
+
----
properties.put(TARGET_SERVER, TargetServer.None);
+
</pre>
+
  
Now the PU can be instantiated for testing using:
+
'''For more information, see "Testing JPA Outside a Container" in the ''[http://www.eclipse.org/eclipselink/documentation/ EclipseLink Solutions Guide]''.'''
  
<pre>
+
[[Category:EclipseLink/Example/JPA|OutsideContainer]]
Persistence.createEntityManagerFactory(unitName, properties);
+
</pre>
+

Latest revision as of 19:05, 1 February 2013

Users may also use the EntityManager API outside the container, either through configuring a persistence.xml, or by creating a EntityManagerFactory for a given persistence unit name and properties map (includes database information etc.)

EntityManagerFactory emf = Persistence.createEntityManagerFactory(persistenceUnitName, propertiesMap);
EntityManager em = emf.createEntityManager();


[edit] JavaSE Configuration using persistence.xml

<persistence 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 persistence_1_0.xsd"
        version="1.0">
  <persistence-unit name="my-app" transaction-type="RESOURCE_LOCAL">
    <provider>org.eclipse.persistence.jpa.PersistenceProvider</provider>
    <exclude-unlisted-classes>false</exclude-unlisted-classes>
    <properties>
      <property name="javax.persistence.jdbc.driver" value="oracle.jdbc.OracleDriver"/>
      <property name="javax.persistence.jdbc.url" value="jdbc:oracle:thin:@localhost:1521:orcl"/>
      <property name="javax.persistence.jdbc.user" value="scott"/>
      <property name="javax.persistence.jdbc.password" value="tiger"/>
    </properties>
  </persistence-unit>
</persistence>

Note, "javax.persistence.jdbc" is used in JPA 2.0, as of EclipseLink 1.2, previously "eclipselink.jdbc" must be used.

Now the EntityManagerFactory can be instantiated using:

Persistence.createEntityManagerFactory("my-app");

[edit] JavaSE Configuration using Property Map

When a simple persistence unit configuration is defined which relies on container deployment:

<persistence-unit name="employee" transaction-type="RESOURCE_LOCAL">
    <non-jta-data-source>jdbc/MyDS</non-jta-data-source>
</persistence-unit>

In order to test this persistence unit outside of the container the JavaSE bootstrapping API must be used. the following code can be used to customize the configuration:

import static org.eclipse.persistence.config.PersistenceUnitProperties.*;
 
    ...
 
    Map properties = new HashMap();
 
    // Ensure RESOURCE_LOCAL transactions is used.
    properties.put(TRANSACTION_TYPE,
        PersistenceUnitTransactionType.RESOURCE_LOCAL.name());
 
    // Configure the internal EclipseLink connection pool
    properties.put(JDBC_DRIVER, "oracle.jdbc.OracleDriver");
    properties.put(JDBC_URL, "jdbc:oracle:thin:@localhost:1521:ORCL");
    properties.put(JDBC_USER, "scott");
    properties.put(JDBC_PASSWORD, "tiger");
 
    // Configure logging. FINE ensures all SQL is shown
    properties.put(LOGGING_LEVEL, "FINE");
    properties.put(LOGGING_TIMESTAMP, "false");
    properties.put(LOGGING_THREAD, "false");
    properties.put(LOGGING_SESSION, "false");
 
    // Ensure that no server-platform is configured
    properties.put(TARGET_SERVER, TargetServer.None);

Now the EntityManagerFactory can be instantiated for testing using:

Persistence.createEntityManagerFactory(unitName, properties);



For more information, see "Testing JPA Outside a Container" in the EclipseLink Solutions Guide.