Creating a Container Managed Persistence Enterprise Java Bean

Creating a Container Managed Persistence Enterprise Java Bean

The container managed persistence EJB part of this tutorial is performed using the Oracle 8.1.6 database client using the Oracle JDBC driver. As a result, you must have an access to an Oracle database to run the example created in this section.

In this section of the tutorial you will:

Create a table in an Oracle Database
Configure Oracle JDBC driver on iPlanet Application Server Version 6.5
Create the Container Managed Persistence EJB
Set the Resource Reference and JNDI Name
Map CMP fields and add CMP Business Methods
Add the CMP Finder Methods
Validate and Compile the EJB Classes
Register the Datasource with the iPlanet Application Server
Create a Servlet to call the CMP EJB
Create and run a J2EE application

Create a Table in an Oracle Database

The sample container-managed entity bean is stored in the database for persistence. Here are SQL statements that will create a table, named obcustomer, where the bean instances will be stored:

CREATE TABLE obcustomer
(
    ssn                 char(9)      NOT NULL ,
    username            varchar2(10) NOT NULL ,
    prefix              varchar2(4)  NULL     ,
    firstname           varchar2(30) NOT NULL ,
    middlename          varchar2(30) NULL     ,
    lastname            varchar2(30) NOT NULL ,
    address             varchar2(30) NOT NULL ,
    address2            varchar2(30) NULL     ,
    city                varchar2(25) NOT NULL ,
    state               char(2)      NOT NULL ,
    zip                 varchar2(9)  NOT NULL ,
    homephone           char(10)     NOT NULL ,
    workphone           char(10)     NOT NULL ,
    constraint PK_obcustomer primary key (ssn)
);
commit;

You may use any application of your choice, including Oracle SQL*Plus, to exeute the statements above.

Configure Oracle JDBC driver on iPlanet Application Server Version 6.5

In this subsection, you will configure Oracle JDBC database driver on iPlanet Application Server, naming the driver identifier ora-type4. If you already have configured Oracle JDBC driver, you may skip this section.

To configure Oracle JDBC driver on Solaris:

Go to iasinstall/ias/bin, and run the following script:

db_setup.sh

Specify the directory where iPlanet Application Server has been installed, for example

/usr/iplanet/ias65. Press Enter.

Type 1 to configure 3rd party JDBC drivers.
Enter ora-type4 for the driver identifier.
Enter driver class name, for example Oracle.Jdbc.driver.OracleDriver
Enter the driver class path, for example /Oracle/Ora81/jdbc/lib/classes12.zip
Press Enter to leave the native driver directory blank.

To configure Oracle JDBC driver on Windows

Go to iasinstall/ias/bin, and run the following program:

jdbcsetup.exe

In the Add tab of the Third Party JDBC Configuration window, specify a ora-type4 for Driver Identifier.
Enter the driver class path for Driver Classpath, for example

C:\Lang\Java\Oracle\lib\classes12.zip

Enter oracle.jdbc.pool.OracleConnectionPoolDataSource for PooledDatasource class name.

The window should look similar to below:

Select the Add button to add the Oracle JDBC driver setting.
Select the OK button to close the window.

Create the Container Managed Persistence EJB

In this subsection, you will create a Container-Managed Persistence EJB. To create the EJB:

From the Explorer Filesystems node, right click to select Mount Directory.

In this example, the directory is named EJB under the CMPExample directory.

Right click on the EJB directory and select New Package.
In the Create New Package dialog, enter customer in the name field.

Right click on the Customer package node and select New | EJB | Entity Bean.
When the New From Template Wizard dialog appears, for Entity EJB Type, select the Container Managed Persistence and the Select Database Table radio button, then click Next.

If you have an Oracle database connection, select it here. If not, then select Add Connection.

In the New Database Connection dialog enter the following data particular to your configuration:

Name: select Oracle thin
Driver: oracle.jdbc.driver.OracleDriver should already be displayed
Database URL: jdbc:oracle:thin:@hostname:portnumber:servicename
User Name: enter the username defined for the database connection
Password: enter the password defined for the database connection

Select OK. The database connection should be created and displayed.

Expand the database connection node and Tables node.
Select the OBCUSTOMER table and select Next.

Select the SSN field and select Edit.

Change the field name to customerID and select OK.

The Java Fields Name for selected entry is changed to customerID.

Select Next.

Accept the default settings and select Finish to generate the CMP Enterprise Java Bean.

Once the CMP EJB is created, the following files are available from Explorer (Filesystems) window:

Where:

is the Obcustomer (EJB) node
is the Obcustomer remote interface
is the Obcustomer bean class
is the Obcustomer home interface

A reminder message displays in the output window prompting you to set the resource references and JNDI name.

Set the Resource Reference and JNDI Name

Resource factory reference is an external reference to a resource, such as a database connection, that must be created so an enterprise bean can perform its work. The enterprise bean accesses the resource by making an JNDI lookup when it is running. In this subsection, you will add a new resource factory reference for the database connection whose name is dbsol0. Later in Register the Datasource, you will connect the name dbsol0 to the ora-type4 driver.

To add the reference:

Select the node.
Right click and select Properties.
From the Properties Editor, select the References tab.
Click in the text entry area of the Resource Factory References field to call up the ellipsis button; select the button.

Select Add.

From the Standard tab, enter the following data for each field:

Name: the name of your datasource (in this example jdbc/dbsol0 is used)
Description: any description you wish
Type: select javax.sql.DataSource
Authorization: select container

The J2EE RI tab is not applicable for cmp EJBs.

Select OK.

The resource reference entries are then displayed in the Properties editor.

Select OK.
Select the iPlanet AS tab.
Click in the text entry area of the Resource Reference Mappings to call up the ellipsis button, and select the button
Enter jdbc/dbsol0 in the JNDI Name field.
Select OK.
Close the Obcustomer (EJB) Properties window.

Map CMP fields and add CMP Business Methods

In this subsection you will map map the database fields to EJB fields and write business methods for accesing EJB fields. Follow the instruction below:

From the Explorer, double click on the to view it in the Source Editor.
Scroll to locate the Container managed fields.
Edit the address field to addressLine1.
Edit the address2 field to addressLine2.

Right click within the Source Editor and save the file.
From the Explorer, select the node.
Right click to select Properties.
Select the iPlanet AS tab and select the Map DB to EJB Fields button.

Double click on the address and address2 EJB Field Name to edit each field to addressLine1 and addressLine2, respectively.

Through this panel you can change the mapping settings of each field in your database table. If you edit the mappings here, you must also edit the corresponding Java file.

NOTE: If the database changes, or you change the mapping information, you can edit the mappings through this panel.

Select OK.
From the Explorer, select the node.
Right click and select New Business Method.
Enter the following data for each field of the New Business Method dialog:

Name: setUsername
Return Type: void
Method Parameters: Select Add and enter the following data in the Enter Method Parameter dialog.

Field name: Username

Type: java.lang.String

Select OK to dismiss the Method Parameters dialog.

The New Business Method dialog should appear as follows:

Select OK to dismiss the New Business Method dialog.
Select the node again and right click to select New Business Method.
Enter the following data for each field:

Name: getUsername
Return Type: java.lang.String

The New Business Method dialog should appear as follows:

Select OK to dismiss the New Business Method dialog.
Select the node once again and right click to select New Business Method.
Enter the following data for each field:

Name: getFirstname
Return Type: java.lang.String

The New Business Method dialog should appear as follows:

Select OK to dismiss the New Business Method dialog.
Select the node for the last time and right click to select New Business Method.
Enter the following data for each field:

Name: getLastname
Return Type: java.lang.String

The New Business Method dialog should appear as follows:

Select OK to dismiss the New Business Method dialog.
From the Explorer, double click on the node to open it in the Source Editor.
Verify that the business methods you just created have been added to the source code.

Double click on the node to open it in the source editor.
Add the following create() method at the end of the file.

 public Obcustomer create (String customerID, String username,
        String prefix, String firstname, String middlename, 
        String lastname, String addressLine1, String addressLine2, 
        String city, String state, String zip, String homephone, 
        String workphone)
    throws CreateException,RemoteException;

Save the file.
Double click on the bean class to open it in the source editor.
Verify that the business methods you created are in the bean class.
Additionally, verify that the ejbCreate() and ejbPostCreate() methods are also created.

Add the following code for each business method:

for setUserName() add this.username = Username;
for getUsername() add return username;
for getFirstname() add return firstname;
for getLastname() add return lastname;
for ejbActivate() method, add customerID = (java.lang.String)context.getPrimaryKey();
for ejbPassivate() methods add:

customerID = null;

username = null;

prefix = null;

firstname = null;

middlename = null;

lastname = null;

addressLine1 = null;

addressLine2 = null;

city = null;

state = null;

zip = null;

homephone = null;

workphone = null;

for ejbCreate() method add:

this.customerID = customerID;

this.username = username;

this.prefix = prefix;

this.firstname = firstname;

this.middlename = middlename;

this.lastname = lastname;

this.addressLine1 = addressLine1;

this.addressLine2 = addressLine2;

this.city = city;

this.state = state;

this.zip = zip;

this.homephone = homephone;

this.workphone = workphone;

return null;

Save the file.

You are now ready to add the finder methods.

Add the CMP Finder Methods

In this subsection, you will add 2 new finder methods, named findAll and findByFirstName, in addition to automaticall generated findByPrimaryKey method. A call to findAll will retrieve all Obcustomer instances. With findByFirstName, you can retrieved EJB instances with the specified firstname. To create the finder methods:

Select the node.
Right click and select New Finder Method.
Enter the following data in each field of the Finder Method dialog:

Name: findAll
Return type: select java.util.Collection

The New Finder Method dialog should appear as follows:

Select OK.
Select the node.
Right click and select New Finder Method.
Enter the following data in each field of the Finder Method dialog:

Name: findByFirstName
Return type: select java.util.Collection
Method Parameters: select Add and enter the following data in the Method Parameters dialog:

Field name: firstname

Type: java.lang.String

Select OK to dismiss the Enter Method Parameter dialog.

The Add a new Finder Method dialog should appear as follows:

Select OK.
Expand the node.
Expand the node.
Select the node and right click on Properties.
Click the iPlanet AS tab.

Click in the text entry area of the Finder Fields Mapping Tool field to call up the ellipsis button; select the button

The Property Editor: Finder Parameters Mapping Tool dialog is displayed.

Click in the Cmp Field Name text area and select the firstname option from the drop down list.
Select OK to close the dialog.

You are now ready to validate and compile the EJB Classes.

Validate and Compile the EJB Classes

The IDE can run a validation check on an enterprise bean to ensure that it matches the J2EE specification. You can run a validation check after doing development work on a bean before you compile it; the validation check will catch J2EE errors not caught by the compiler.

In this subsection, you will validate the Obcustomer EJB, and compile it. To validate and compile:

Select the node.
Right click and select Validate EJB.

Once your EJB is validated, a Finished message is displayed in the status bar.

Select the node.
Right click to select Compile EJB Classes.

Once compilation is complete, the message Finished Obcustomer (EJB) is displayed in the status bar.

Select the node again.
Right click and select New EJB Module...
Select OK to accept defaults.

You are now ready to register the datasource with the iPlanet Application Server.

Register the Datasource with the iPlanet Application Server

If your module/application depends on a data source, you need to add the datasource and register it so that when it is deployed to the iPlanet Application Server the identfied datasource is used.

From the Explorer, select the Runtime tab.
Expand the Server Instance node.
Select the Data Sources node and right click to select the Add new Data Source...
Enter the following data for each field:

DataBase the server name (required only for a Sybase server; leave it as displayed)
Database URL jdbc:oracle:thin:@hostname:portnumber:servicename
DataSource your datasource name (in this example, dbsol0 is used)
Driver the registered driver name (ora-type4 was created earlier in this tutorial)
User Name yourusername
Password yourpassword

Select the datasourcename node and right click to select Register from the context menu.

Select the server instance you want to register this datasource to.

Select Register.

After a few moments, the Output window iPlanet Deployment Tab displays a message indicating that deployment is finished.

Also, the status message window displays the message Deployment to iPlanet Application Server finished.

You are now ready to create a servlet to call your Container Managed Persistence EJB.

· Create a Servlet that uses CMP EJB

In this subsection, you will create a servlet that will use the Obcustomer EJB. The servlet creates Obcustomer instances and looks them up with the findByPrimaryKey, findByFirstName, and findAll methods. To create the servlet:

From the File menu, select New.
Expand the JSP & Servlet node, select Web Module, then select Next.
Select the button to create a new directory.
Create a directory named EJBClient under the CMPExample directory and select Add.
Select Finish.

You may see the following dialog informiing you of an alternate project view.

Select OK to dismiss the dialog.

From the Explorer, expand the EJBClient node and the WEB-INF node.
Right click on the Classes node and select New Package from the context menu.
In the Create New Package Name field enter cmpPack and select OK.
Right click on the cmpPack node and select New -> JSP & Servlet -> Servlet.
Enter ObClient in the name field and select Finish.

The Source Editor opens the ObClient.java file.

Add the following import statements to the ObClient.java file.

import javax.ejb.*; import javax.naming.*;
import java.rmi.*;
import java.util.*;
import customer.*;

Your ObClient.java file should look like this:

Edit the processRequest() method as follows:

protected void processRequest(HttpServletRequest request, HttpServletResponse response)
throws ServletException, java.io.IOException {
    response.setContentType("text/html");
    java.io.PrintWriter out = response.getWriter();
    String JNDI = "java:comp/env/Obcustomer";
    Object beanObject = null;
    out.println("<html>");
    out.println("<head>");
    out.println("<title>ObClient Servlet Output</title>");  
    out.println("</head>");
    out.println("<body>");
    try
    {
       InitialContext ctx = new InitialContext();
       beanObject = ctx.lookup(JNDI);
       System.out.println("Lookup OK");
       ObcustomerHome home = (ObcustomerHome) beanObject;
       System.out.println("before emptying database");
       Collection c = (java.util.Collection) home.findAll();
       Iterator i = c.iterator();
       while (i.hasNext()) {
         Obcustomer cust =( Obcustomer)i.next();
         cust.remove();
       }
       System.out.println("Before Home.create");
       Obcustomer remote = (Obcustomer) home.create("987654321","SRoberts","Mr","Steve","o","Roberts","Main Street","Suite 20","Santa Clara","CA","95054","4081112222","4082223333");
       out.println("<h1>CMP Bean Sample Application<br /></h1>");
       out.println("<h5>Inserting the Record for Steve Roberts in DB: ");
       out.println("FirstName : " + remote.getFirstname()+ "<br />");
       out.println("LastName : " + remote.getLastname()+ "<br />");
       out.println("UserID : " + remote.getUsername()+ "<br />");
       out.println("<P> Changing the UserID for Steve Roberts from " + remote.getUsername() + " to " + "Roberts :</P>");
       remote.setUsername("Roberts");
       out.println("Accesing DB for UserID for Steve Roberts: <br />");
       out.println("The UserID for Steve Roberts now is : " + remote.getUsername()+ "<br />");
       remote = (Obcustomer) home.create("876543219","LHall","Mr","Larry","M","Hall","South Street","#89","Santa Clara","CA","95054","4088889999","4086667777");
       remote = (Obcustomer) home.create("789123456","LAllen","Mrs","Lora","C","Allen","First Street","# 1895","Santa Clara","CA","95054","4083334444","4085558888");
       remote = (Obcustomer) home.create("678912345","LReeves","Mrs","Lora","K","Reeves","Market Street","# 6677","Santa Clara","CA","95054","4087779999","4088880098");
       System.out.println("Now calling findByPrimaryKey");
       Obcustomer primKey = home.findByPrimaryKey("876543219");
       System.out.println("primKey: "+ primKey.toString()+"\n");
       String id = (String)primKey.getPrimaryKey(); 
       System.out.println(id);
       out.println("<P> Using findByPrimaryKey : Getting User record for SSN = " + id);
       out.println("FirstName : " + primKey.getFirstname()+"<br />");
       out.println("LastName : " + primKey.getLastname()+"<br />");
       out.println("UserID : " + primKey.getUsername()+"<br />");
       System.out.println("calling findByFirstname");
       c = home.findByFirstName("Lora");
       i = c.iterator();
       out.println("<P> Using findByFirstname : Getting User record for : Lora");
       while (i.hasNext()) {
          Obcustomer cust = (Obcustomer)i.next();
          String customerId = (String)cust.getPrimaryKey();
          String firstname = cust.getFirstname();
          String lastname = cust.getLastname();
          out.println(customerId + ": " + firstname + " " + lastname + "<br />");
        }
        System.out.println("calling findAll");    
        out.println("<P> Calling findAll");
        c = (java.util.Collection) home.findAll();
        i = c.iterator();
        while (i.hasNext()) {
           Obcustomer cust =( Obcustomer)i.next();
           String customerId = (String)cust.getPrimaryKey();
           String firstname = cust.getFirstname();
           String lastname = cust.getLastname();
           out.println(customerId + ": " + firstname + " " + lastname + "<br />");
         }
     } catch (Exception ex) {
           System.err.println("Caught an exception." );
           ex.printStackTrace();
     }
     out.println("</body>");
     out.println("</html>");
     out.close();
}

Save the file.
Select the web.xml node and select Properties.
Select the References tab.
Select the EJB references field.
From the EJB References dialog select Add.

Enter the following data in each field of the Add EJB Reference dialog:

Reference Name: Obcustomer
Description: any description you like
Referenced EJB Name: Obcustomer
Type: Entity
Home Interface: customer.ObcustomerHome
Remote Interface: customer.Obcustomer

Select iPlanet App Server tab and specify JNDI Name: ejb/EJBModule_Obcustomer/Obcustomer

Select OK.

The EJB References dialog should appear as follows:

Select OK.
Expand the cmpPack folder node.
Right click on the ObClient node and select Compile.
Right click on the ObClient node and select Properties.
Specify URI field as /ObClient
Right click on the web.xml node and select Properties.
Select Servlet field. The Property Editor: Servlets dialog is displayed.
Select the entry and select Edit. The Edit Servlet dialog is displayed.
Specify Servlet Name = ObClient, Display Name = ObClient, and Servlet Class = cmpPack.ObClient

Select Mappings. The Edit Servlet Mappings dialog is displayed.

Select the entry and select Edit.
Specify Servlet Name = ObClient and URL Pattern = /ObClient
Select OK for both dialogs
Select OK on Edit Servlet dialog to accept the changes.
Select OK on Property Editor: Servlet dialog.
Select Welcome Files fields and remove all files.
Select the WEB-INF node and right click on Properties. Specify Context Root field as EJBClient.

Create and Run a J2EE Application

In this subsection, you will create, deploy, and run a J2EE application. The application contains the Obcustomer EJB and ObClient servlet created previously. To run the sample application:

Mount directory CMPExample.
Select CMPExample node, right click and select New | J2EE | Application.

Enter name as CMPExample and then select Finish.
Select the CMPExample application node, right click and select Add Module... Navigate to the EJBModule_Obcustomer node, select and click OK to add EJB module.
Repeat the previous step to add EJBClient web module, select WEB-INF node and click OK to add web module.

Select CMPExample application node, right click and select Deploy.

The Progress Monitor dialog is displayed. It will disappear when the deployment process is finished.

Right click on the ObClient servlet node of the EJBClient web module and select Execute.

The web browser launches and displays the following screen.

The next step in the iPlanet Application Server Integration Module Tutorial is deploying and executing the CDShopCart Forte for Java.

Legal Notices