Lets get started!

1. Configure GlassFish for using the MySQL sample database (sakila) as described in TOTD #121.
2. Add the GlassFish instance in NetBeans IDE using "Services" panel.
3. Create JPA entities using NetBeans IDE.
   1. Create a Java class library:
      
      
      
      Our ultimate goal is to create a reusable JAR file and that's why this project type is chosen.
      
   2. Specify the name of project as "SakilaPU":
      
      
      
   3. Right-click on the project and select "New", "Entity Classes from Database ..." to initiate the process of entity generation:
      
      
   4. Choose the database connection as:
      
      
      
      If not configured, then can be easily done by clicking on "New Database Connection ..." in the list box.
      1. Click on "Add All >>" to generate the mapped JPA entities for all tables and views.
      2. The views do not have primary keys and will need to be appropriately annotated (described later).
      3. Click on "Next >".
         
   5. Give the package name as:
      
      
      
      and specify the package name as "sakila". Click on "Create Persistence Unit ...".
   6. Change the default PU name from "SakilaPUPU" to "SakilaPU":
      
      
      
      and click on "Finish". Notice that "EclipseLink", the Reference Implementation of JPA 2.0, is used as the persistence library.
   7. Add "@javax.persistence.Id" annotation to the following class/field combination:

      Class	Field
      sakila.SalesByFilmCategory	category
      sakila.ActorInfo	actorId
      sakila.FilmList	fid
      sakila.CustomerList	id
      sakila.NicerButSlowerFilmList	fid
      sakila.StaffList	id
      sakila.SalesByStore	store

      
      This is required because none of the "views" are defined with a primary key.

   8. Right-click on the project and select "Clean & Build". This generates "dist/SakilaPU.jar" and the structure looks like:

      

This JAR file can now be included in any web application. The pre-built JAR file can also be downloaded here. The key items to note about this pre-built JAR:

• Persistence Unit Name: "SakilaPU"
• All classes are in "sakila.*" package.
• Each class has a pre-defined "<CLASS-NAME>.findAll" named query that returns all elements from the underlying view/table.
• Can be easily added in "WEB-INF/lib" directory of your web application.

Even though this blog uses a MySQL sample database, these steps can be easily followed for any other database such as Oracle or JavaDB.

Technorati: totd javaee glassfish v3 jpa eclipselink persistenceunit mysql sakila netbeans

1. Download sakila sample database and unzip the archive.
2. Install the database as described here - basically load and run "sakila-schema.sql" and "sakila-data.sql" extracted from the archive.
3. Create a new MySQL user account using MySQL CLI Admin and assign the privileges
   1. Using "root" user (sudo mysql --user root)
      

      CREATE USER glassfish IDENTIFIED BY 'glassfish';
      GRANT ALL PRIVILEGES ON *.* TO 'glassfish'@'localhost' IDENTIFIED BY 'glassfish';
      FLUSH PRIVILEGES;
      

   2. Using "glassfish" user (sudo mysql --user glassfish)

      source sakila-schema.sql;
      source sakila-data.sql;
      

4. Download Connector/J, unzip and copy "mysql-connector-java-5.x.x-bin.jar" to "glassfish/domains/domain1/lib/ext" directory.
5. Start GlassFish server as:

   asadmin start-domain
   
   

6. Create a JDBC resource
   1. Create JDBC connection pool as:

      asadmin create-jdbc-connection-pool --datasourceclassname com.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSource --restype javax.sql.DataSource --property "User=glassfish:Password=glassfish:URL=jdbc\:mysql\://localhost/sakila" jdbc/sakilaPool
      

   2. Test the JDBC connection pool as:

      asadmin ping-connection-pool jdbc/sakilaPool
      

   3. Create the JDBC resource as:

      asadmin create-jdbc-resource --connectionpoolid jdbc/sakilaPool jdbc/sakila
      

That's it!

Creating a JDBC resource for any other database requires the following updates to the steps mentioned above. Lets consider modifying these steps for the Oracle sample database.

1. Use the client interface SQL*PLus and connect as:
   

   sqlplus "/ as sysdba"
   

   
   create user and grant the privileges as:
   

   CREATE USER glassfish IDENTIFIED BY glassfish DEFAULT tablespace users TEMPORARY tablespace temp;
   GRANT CONNECT TO glassfish IDENTIFIED BY glassfish;
   GRANT UNLIMITED TABLESPACE TO glassfish;
   GRANT CREATE TABLE TO glassfish;
   GRANT CREATE SEQUENCE TO glassfish;
   

2. Copy the appropriate JDBC driver (ojdbc6.jar).
3. Create the JDBC resource as:
   

   asadmin create-jdbc-connection-pool --datasourceclassname oracle.jdbc.pool.OracleDataSource --restype javax.sql.DataSource --property "User=hr:Password=hr:URL=jdbc\:oracle\:thin\:@localhost\:1521\:orcl" jdbc/hr
   asadmin ping-connection-pool jdbc/hr
   asadmin create-jdbc-resource --connectionpoolid jdbc/hr jdbc/hr
   

   
   as explained in TOTD #108.

Here are a few other related entries:

• RESTful representation of sakila using NetBeans and GlassFish

• JPA + Servlet 3.0 Application using Sakila in Eclipse

• JSF + JPA + EJB Application using Oracle, NetBeans, and GlassFish

Technorati: totd javaee glassfish v3 jpa mysql sakila oracle

1. The easiest way to back a JSF page with an EJB is to convert the managed bean into an EJB by adding @javax.ejb.Stateless annotation. So change the  "StateList" class from TOTD #94 as shown below:
   
   

   @javax.ejb.Stateless @ManagedBean public class StateList {     @PersistenceUnit     EntityManagerFactory emf;     public List<States> getStates() {         return emf.createEntityManager().createNamedQuery("States.findAll").getResultList();     } }

   
   The change is highlighted in bold, and that's it!

1. Right-click on the project, select "New", "Session Bean ..." and create a stateless session bean by selecting the options as shown below:
   
   
   
   This creates a stateless session with the name "StateBeanBean" (bug #170392 for redundant "Bean" in the name).
2. Simplify your managed bean by refactoring all the business logic to the EJB as shown below:
   
   

   @Stateless public class StateBeanBean {     @PersistenceUnit     EntityManagerFactory emf;          public List<States> getStates() {         return emf.createEntityManager().createNamedQuery("States.findAll").getResultList();     } }

   
   and
   
   

   @ManagedBean public class StateList {     @EJB StateBeanBean bean;     public List<States> getStates() {         return bean.getStates();     } }

   
   In fact the EJB code can be further simplified to:
   
   

   @Stateless public class StateBeanBean {     @PersistenceContext     EntityManager em;         public List<States> getStates() {         return em.createNamedQuery("States.findAll").getResultList();     } }

   
   The changes are highlighted in bold.
   

1. Right-click on the project, select "Properties", select "Frameworks", click on "Add ..." as shown below:
   
   
   
   Select "JavaServer Faces" and click on "OK". The following configuration screen is shown:
   
   
   
   Click on "OK" to complete the dialog. This generates a whole bunch of files (7 to be accurate) in your project. Most of these files are leftover from previous version of NetBeans and will be cleaned up. For example, "faces-config.xml" is now optional and "forwardToJSF.jsp" is redundant.
2. Anyway, lets add a POJO class that will be our managed bean. Right-click on "server" package and select "New", "Java Class ...", give the name as "StateList". Change the class such that it looks like:
   
   

   package server; import java.util.List; import javax.faces.bean.ManagedBean; import javax.persistence.EntityManagerFactory; import javax.persistence.PersistenceUnit; import states.States; /**  * @author arungupta  */ @ManagedBean public class StateList {     @PersistenceUnit     EntityManagerFactory emf;     public List<States> getStates() {         return emf.createEntityManager().createNamedQuery("States.findAll").getResultList();     } }

   
   Here are the main characterisitcs of this class:
   
1. This is a POJO class with @ManagedBean annotation. This annotation makes this class a managed bean that can be used in the JSF pages. As no other annotations or parameters are specified, this is a request-scoped managed bean with the name "stateList" and lazily initialized. More details about this annotation are available in the javadocs.
2. The persistence unit created in TOTD #93 is injected using @PersistenceUnit annotation.
3. The POJO has one getter method that queries the database and return the list of all the states.
   
3. In the generated file "template-client.xhtml", change the "head" template to:
   
   

   Show States

   
   and "body" template to:
   
   

   <h:dataTable var="state" value="#{stateList.states}" border="1">                     <h:column><h:outputText value="#{state.abbrev}"/></h:column>                     <h:column><h:outputText value="#{state.name}"/></h:column>                 </h:dataTable>


This uses the standard JSF "dataTable", "column", and "outputText" tags and uses the value expression to fetch the values from the managed bean.

1. Create the database, table, and populate some data into it as shown below:
   
   

   ~/tools/glassfish/v3/58/glassfishv3/bin >sudo mysql --user root Password: Welcome to the MySQL monitor.  Commands end with ; or \g. Your MySQL connection id is 1592 Server version: 5.1.30 MySQL Community Server (GPL) Type 'help;' or '\h' for help. Type '\c' to clear the buffer. mysql> create database states; Query OK, 1 row affected (0.02 sec) mysql> CREATE USER duke IDENTIFIED by 'glassfish'; Query OK, 0 rows affected (0.00 sec) mysql> GRANT ALL on states.* TO duke; Query OK, 0 rows affected (0.24 sec) mysql> use states; Database changed mysql> CREATE TABLE STATES (     ->       id INT,     ->       abbrev VARCHAR(2),     ->       name VARCHAR(50),     ->       PRIMARY KEY (id)     -> ); Query OK, 0 rows affected (0.16 sec) mysql> INSERT INTO STATES VALUES (1, "AL", "Alabama"); INSERT INTO STATES VALUES (2, "AK", "Alaska"); . . . mysql> INSERT INTO STATES VALUES (49, "WI", "Wisconsin"); Query OK, 1 row affected (0.00 sec) mysql> INSERT INTO STATES VALUES (50, "WY", "Wyoming"); Query OK, 1 row affected (0.00 sec)

   
   The complete INSERT statement is available in TOTD #38. Most of this step can be executed from within the IDE as well as explained in TOTD #38.
2. Download and unzip GlassFish v3 build 58. Copy the latest MySQL Connector/J jar in "domains/domain1/lib" directory of GlassFish and start the application server as:
   
   

   ~/tools/glassfish/v3/58/glassfishv3/bin >asadmin start-domain

3. Create JDBC connection pool and JNDI resource as shown below:
   
   

   ~/tools/glassfish/v3/58/glassfishv3/bin >./asadmin create-jdbc-connection-pool --datasourceclassname com.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSource --restype javax.sql.DataSource --property "User=duke:Password=glassfish:URL=jdbc\:mysql\://localhost/states" jdbc/states Command create-jdbc-connection-pool executed successfully. ~/tools/glassfish/v3/58/glassfishv3/bin >./asadmin ping-connection-pool jdbc/states Command ping-connection-pool executed successfully. ~/tools/glassfish/v3/58/glassfishv3/bin >./asadmin create-jdbc-resource --connectionpoolid jdbc/states jdbc/jndi_states Command create-jdbc-resource executed successfully.

   
   
4. Download NetBeans 6.8 M1 and install "All" version. Expand "Servers" node and add the recently installed GlassFish server.
5. Create a new Web project and name it "HelloEclipseLink". Make sure to choose "GlassFish v3" as the server and "Java EE 6 Web" as the Java EE version as shown below:
   
   
   
   Take defaults elsewhere.
6. Create the Persistence Unit
1. Right-click on the newly created project and select "New", "Entity Classes from Database ...". Choose the earlier created data source "jdbc/jndi_states" as shown below:
   
   
2. Select "STATES" table in "Available Tables:" and click on "Add >" and then "Next >".
3. Click on "Create Persistence Unit ...", take all the defaults and click on "Create". "EclipseLink" is the Reference Implementation for JPA 2.0 is the default choosen Persistence Provider as shown below:
   
   
4. Enter the package name as "server" and click on "Finish".
7. Create a Servlet to retrieve and display all the information from the database
1. Right click on the project, "New", "Servlet ...".
2. Give the Servlet name "ShowStates" and package "server".
3. Even though you can take all the defaults and click on "Finish" but instead click on "Next >" and the following screen is shown:
   
   
   
   Notice "Add information to deployment descriptor (web.xml)" checkbox. Servlet 3.0 makes "web.xml" optional in most of the common cases by providing corresponding annotations and NetBeans 6.8 leverages that functionality. As a result, no "web.xml" will be bundled in our WAR file. Click on "Finish" now.
   
   The generated servlet code looks like:
   
   
   
   Notice @WebServlet annotation, this makes "web.xml" optional. TOTD #82 provide another example on how to use Servlet 3.0 with EJB 3.1.
4. Inject the Persistence Unit as:
   
   

   @PersistenceUnit     EntityManagerFactory emf;

   
   right above "processRequest" method.
5. Change the "try" block of "processRequest" method to:
   
   

   List<States> list = emf.createEntityManager().createNamedQuery("States.findAll").getResultList();             out.println("<table border=\"1\">");             for (States state : list) {                 out.println("<tr><td>" + state.getAbbrev() +                         "</td><td>" + state.getName() +                         "</td></tr>");             }             out.println("</table>");

   
   This uses a predefined query to retrieve all rows from the table and then display them in a simple formatted HTML table.
8. Run the project
1. Right click on the project, select "Properties" and change the "Relative URL" to "/ShowStates". This is the exact URL that you specified earlier.
   
   
2. Right-click on the project and select "Run" to see the following output: