This document is based on the following products and tools, although the principles apply to any supported database or development environment. It is assumed that the software is already installed, except where noted in later sections.

• GlassFish Server 3.1.2.

  For more information and downloads, see http://www.oracle.com/technetwork/middleware/glassfish/overview/index.html on the Oracle Technology Network.

• EclipseLink 2.4.1.

  For more information and downloads, see http://www.eclipse.org/eclipselink/ on the EclipseLink website.

• Any compliant JDBC database including Oracle Database, Oracle Database Express Edition, MySQL, and so on.

  For Oracle Database, see http://www.oracle.com/technetwork/database/enterprise-edition/overview/index.html.

  For Oracle Database Express Edition, see http://www.oracle.com/technetwork/database/express-edition/overview/index.html.

  For MySQL, see http://www.oracle.com/us/products/mysql/index.html.

• While it is not required, you may want to use a Java EE integrated development environment (IDE) for convenience during development. For example, Oracle JDeveloper, Oracle Enterprise Pack for Eclipse, and NetBeans all provide sophisticated Java EE development tools.

  For JDeveloper, see http://www.oracle.com/technetwork/developer-tools/jdev/downloads/index.html.

  For Oracle Enterprise Pack for Eclipse, see http://www.oracle.com/technetwork/developer-tools/eclipse/overview/index.html.

  For NetBeans, see https://www.oracle.com/tools/technologies/netbeans-ide.html.

EclipseLink is included with the GlassFish Server distribution. You can find instructions for installing and configuring GlassFish Server at this URL:

http://docs.oracle.com/cd/E26576_01/index.htm

The EclipseLink modules appear as separate JAR files in the modules directory.

* \glassfish\modules
      .
      .
      .
      o org.eclipse.persistence.antlr.jar
      o org.eclipse.persistence.asm.jar
      o org.eclipse.persistence.core.jar
      o org.eclipse.persistence.jpa.jar
      o org.eclipse.persistence.jpa.modelgen.jar
      o org.eclipse.persistence.moxy.jar
      o org.eclipse.persistence.oracle.jar
      .
      .
      .

Object-XML (also known as JAXB support) is a component that enables you to bind Java classes to XML schemas. This support is provided by the org.eclipse.persistence.moxy.jar.

Object-XML (also known as JAXB support, or MOXy) is a component that enables you to bind Java classes to XML schemas. This support is provided by the org.eclipse.persistence.moxy.jar.

Configuring an Oracle database as a JDBC resource for a Java EE application involves the following steps:

1. Integrate the JDBC Driver for Oracle Database into GlassFish Server

2. Create a JDBC Connection Pool for the Resource

3. Create the JDBC Resource

Example 4-1 illustrates a sample persistence.xml file that specifies the default persistence provider for EclipseLink, org.eclipse.persistence.jpa.PersistenceProvider. For more information about this file, see About the Persistence Unit in Understanding Oracle TopLink.

If you are using the default persistence provider, then you can specify additional database properties described in Java Persistence API (JPA) Extensions Reference for Oracle TopLink.

Several of the values you enter in the file must match the values you chose when you defined the cluster, connection, and connection pool properties in GlassFish Server, as follows:

JDBC Data Source Properties:

• Name: The name of the data source, which is typically the same as the JNDI name, for example jdbc/bvcallbackbmt.

• JNDI Name: The JNDI path to where this data source is bound. This must be the same name as the value for the <jta-data-source> element in persistence.xml, for example jdbc/bvcallbackbmt.

• Database Type: Oracle

• Database Driver: (default) Oracle's Driver (Thin XA) for Instance connections; Versions: 9.0.1 and later

Connection Properties:

• Database Name: The name of the database, for example, XE for Oracle Database Express Edition samples.

• Host Name: The IP address of the database server, for example 127.0.0.1 for a locally hosted database.

• Port: The port number on which your database server listens for connection requests, for example, 1521, the default for Oracle Database Express Edition 11g.

• Database User Name: The database account user name used to create database connections, for example hr for Oracle Database Express Edition 11g samples.

• Password: Your password.

Select Targets:

• Servers / Clusters: Select the administration server, managed servers, or clusters to which you want to deploy the data source. You can choose one or more.

The sample persistence.xml file in Example 4-1 highlights the properties defining the persistence provider, the JTA data source, and logging details. In this example, the logging level is set to FINE. At this level, SQL code generated by EclipseLink is logged to the server.log file. For more information about these properties, see:

• Specify the Persistence Provider.

• Specify an Oracle Database.

• Specify Logging.

<?xml version="1.0" encoding="UTF-8"?>
<persistence xmlns="http://java.sun.com/xml/ns/persistence" version="2.0">
  <persistence-unit name="pu1" transaction-type="JTA">
    <provider>org.eclipse.persistence.jpa.PersistenceProvider</provider>
    <jta-data-source>jdbc/bvcallbackbmt</jta-data-source>
    <properties>
       <property name="eclipselink.logging.level" value="FINE"/>
       <property name="eclipselink.ddl-generation" 
                 value="drop-and-create-tables"/>
    </properties>
  </persistence-unit>
</persistence>

GlassFish Server Application Development Guide describes server-specific considerations on setting up GlassFish Server to run applications that employ JPA:

http://docs.oracle.com/cd/E26576_01/doc.312/e24930/jpa.htm

It provides more information about these topics:

• "Specifying the Database for an Application," for information about database connection properties

• "Specifying the Persistence Provider for an Application," for setting the default or non-default persistence provider for an application

• "Primary Key Generation Defaults," for the default persistence provider's primary key generation defaults

• "Automatic Schema Generation," for information on annotations and options to manage automatic schema generation

• "Restrictions and Optimizations," for restrictions and performance optimizations that affect using the Java Persistence API

To create an application that uses EclipseLink as its JPA persistence provider, you may want to use a Java EE IDE for convenience during development. For example, JDeveloper, Oracle Enterprise Pack for Eclipse, and NetBeans provide sophisticated Java EE development tools, including support for EclipseLink. See Key Tools in Understanding Oracle TopLink.

For guidance in writing your application, see these topics from the Configuring the Java Persistence Provider chapter in Oracle GlassFish Server Application Development Guide.

For information about deploying to GlassFish Server, see Deploy Applications or Modules, To Deploy an Enterprise Application, and To Deploy a Web Application in GlassFish Server Administration Console Online Help. See also Oracle GlassFish Server Application Deployment Guide, at:

http://docs.oracle.com/cd/E26576_01/index.htm

For instructions for starting a deployed application from the GlassFish Server Administration Console, see Application Client Launch and To Launch an Application in GlassFish Server Administration Console Online Help.

GlassFish Server provides a monitoring service to track the health and performance of an application. For information about monitoring an application from the console, see the Monitoring and Monitoring Data topics in GlassFish Server Administration Console Online Help. For information about monitoring the application from the command line, see Administering the Monitoring Service in Oracle GlassFish Server Administration Guide, at:

http://docs.oracle.com/cd/E26576_01/doc.312/e24928/monitoring.htm