J2EE

Writing Enterprise Applications with
Java 2 SDK, Enterprise Edition
by Monica Pawlan
copyright  1995-99 Sun Microsystems, Inc.
As used in this document, the terms “Java virtual machine” or “Java VM” mean a virtual machine for the Java
platform.
iii
Preface
This tutorial introduces you to the APIs, tools, and services provided in the Java 2 Enter-
prise Edition (J2EE) Reference Implementation. You can get the J2EE Reference Implemen-
taion as a free download (http://developer.java.sun.com/developer/earlyAccess/
j2sdkee/) for demonstrations, prototyping, educational use, and verifying J2EE application
portability.
To support these uses the J2EE Reference Implementation comes with J2EE development
and deployment tools, Java WebServer technology, Cloudscape database, Java Software
application server, Extensible Markup Language (XML) support, the J2EE APIs, and Java
Plug-In. Java Plug-In lets you run Java 2 applets in browsers that support an earlier release of
the Java Runtime Environment (JRE).
Note: This is a work in progress. Links to new lessons are turned on when they become
available. Submit comments and suggestions to [email protected]
Online Copies
You can find an online version of this material at the JDC:
Writing Enterprise Applications for the J2EE Reference Implementation:
http://developer.java.sun.com/developer/onlineTraining/J2EE/Intro/
index.html
iv
v
Contents
Preface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
Online Copies iii
A Simple Session Bean. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Example Thin-Client Multitiered Application 2
J2EE Software and Setup 3
Unix: 3
Windows: 3
Path Settings 3
Unix: 3
Windows: 4
Class Path Settings 4
Unix: 4
Windows: 4
J2EE Application Components 4
Create the HTML File 6
HTML Code 6
Create the Servlet 6
Import Statements 7
init Method 7
doGet Method 7
Servlet Code 9
Create the Session Bean 10
CalcHome 11
Calc 12
CalcBean 12
Compile the Session Bean and Servlet 13
Compile the Session Bean 13
Compile the Servlet 13
Start the J2EE Application Server 14
Unix: 14
Windows: 14
Start the Deploy Tool 14
Unix: 15
Windows: 15
Deploy Tool 15
vi
Assemble the J2EE Application 16

Create J2EE Application EAR file 17
Create Session Bean JAR File 17
Create Web Component WAR File 20
Specify JNDI Name and Root Context 23
Verify and Deploy the J2EE Application 24
Verify 25
Deploy 25
Run the J2EE Application 26
A Simple Entity Bean . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
Create the Entity Bean 27
BonusHome 28
Bonus 28
BonusBean 29
Change the Servlet 32
Compile 34
Compile the Entity Bean 34
Start the Platform and Tools 35
Unix 35
Windows 35
Assemble and Deploy 35
Uninstall the Application 35
Delete and Create New WAR File 36
Create EJB JAR for the Entity Bean 36
Cooperating Enterprise Beans . . . . . . . . . . . . . . . . . . . . . .43
Change the Session Bean 44
CalcHome 44
Calc 45
CalcBean 45
Change the Servlet 47
Compile 48
Compile the Entity Bean 48
Start the Platform and Tools 49
Unix 49
Windows 50
vii
Assemble and Deploy 50

Uninstall the Application 50
Create J2EE Application EAR file 50
Create Web Component WAR File 51
Create EJB JAR for the Session and Entity Beans 51
Verify 54
Deploy 54
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
viii
1
L E S S O N 1
A Simple Session Bean
This lesson introduces you to J2EE applications programming, and the J2EE Reference
Implementation by showing you how to write a simple thin-client multitiered enterprise
application.
The J2EE Reference Implementation is a non-commercial operational definition of the J2EE
platform and specification made freely available by Sun Microsystems for demonstrations,
prototyping, and educational uses. It comes with the J2EE application server, web server,
database, J2EE APIs, and a full-range of development and deployment tools. You will
become acquainted with many of these features and tools as you work through the lessons in
this tutorial.
• Example Thin-Client Multitiered Application
• J2EE Software and Setup
• Path Settings
• Classpath Settings
• J2EE Application Components
• Create the HTML File
• Create the Servlet
• Servlet Code
• Create the Session Bean and Servlet
• Start the J2EE Application Server
• Start the Deploy Tool
• Assemble the J2EE Application
• Verify and Deploy the J2EE Application
• Run the J2EE Application
2
Example Thin-Client Multitiered Application

The example thin-client multitiered application for this lesson accepts user input through an
HTML form that invokes a servlet. The servlet uses Java Naming and Directory Interface
(JNDI) code to look up a session Bean to perform a calculation on its behalf. Upon receiving
the results of the calculation, the servlet returns the calculation value to the end user in an
HTML page.
This example is a thin-client application because the servlet does not execute any business
logic. The simple calculation is performed by a session Bean executing on the J2EE applica-
tion server. So, the client is thin because it does not handle the processing; the session Bean
does.
As shown in Figure 1, the thin-client servlet is the first tier in this multitier example, and the
application server is the second tier. Multitier or three-tier architecture extends the standard
two-tier client and server model by placing a multithreaded application server between the
client and database.
Browser
Network
Thin-Client
Tier Servlet
1
Network
Tier Enterprise Beans

2 Application
Server
Network
Tier Database
3 Server
3
Figure 1 Multitiered Architecture
While this lesson uses only two of the three tiers, Lesson 2 expands this same example to
access the database server in the third tier. Later lessons adapt the example to use JavaSer-
ver Pages and Extensible Markup Language (XML).
J2EE Software and Setup

To run the lesson examples, you need to download and install the Java 2 SDK Enterprise
Edition (J2EE), Version 1.2 Release, and Java 2 SDK, Standard Edition. The instructions in
this tutorial assume these are installed in a directory in monicap's home directory.
Note: Everywhere monicap is used in a path name, please change it to your own user
name.
Unix:
/home/monicap/J2EE/j2sdkee1.2
/home/monicap/J2EE/jdk1.2.2
Windows:
\home\monicap\J2EE\j2sdkee1.2
\home\monicap\J2EE\jdk1.2.2
The download has the J2EE application server, Cloudscape database, HTTP, HTTP over
secure socket layer (SSL) also known as HTTPS, development and deployment tools, and
the Java APIs for the Enterprise. To use these features, set your path and class path variables
as described here.
Path Settings
Path settings make the development and deployment tools accessible from anywhere on your
system.
Unix:
/home/monicap/J2EE/jdk1.2.2/bin
/home/monicap/J2EE/j2sdkee1.2/bin
4
Windows:
\home\monicap\J2EE\jdk1.2.2\bin
\home\monicap\J2EE\j2sdkee1.2\bin
Class Path Settings

Class path settings tell the Java 2 development and deployment tools where to find the vari-
ous class libraries they use.
Unix:
/home/monicap/J2EE/j2sdkee1.2/lib/j2ee.jar
Windows:
\home\monicap\J2EE\j2sdkee1.2\lib\j2ee.jar
J2EE Application Components

J2EE applications programmers write J2EE application components. A J2EE application
component is a self-contained functional software unit that is added to and interfaces with
other application components. The applications programmer or an assembler uses the
Deploy tool to assemble application components into a complete J2EE application.
The example for this lesson has two application components: (1) An HTML page and serv-
let, and (2) A session Bean. You will create the components, assemble them into a complete
J2EE application, and deploy and run the application in this lesson.
An application component can consist of a number of elements. For example, the HTML
page and servlet are one application component because they work together. The HTML
form invokes the servlet, and the servlet retrieves the data entered onto the form embedded
in the HTML page.
Also, the session Bean is one application component that consists of the session Bean (Cal-
cBean.class), and its home (CalcHome.class) and remote (Calc.class) interfaces. The
home and remote interfaces are the means by which client programs access the session Bean
methods.
Figure 2 shows how the page looks when displayed to the user. The bonus.html file has two
data fields so the user can enter a social security number and a multiplier. When the user
clicks the Submit button, BonusServlet retrieves the end user data, looks up the session
5
Bean, and passes the user data to the session Bean. The session Bean calculates a bonus and
returns the bonus value to the servlet. The servlet then returns another HTML page with the
bonus value for the end user to view.
Figure 2 HTML Page
Figure 3 shows how data flows between the browser and the session Bean. The session Bean
executes in the J2EE application server.
Component Component
Browser Servlet Session Bean
bonus.html BonusServlet.class CalcBean.class

Calc.class
CalcHome.class
Figure 3 Data Flow

6
Create the HTML File

The HTML code for bonus.html is below. The interesting thing about the form HTML code
is the alias used to invoke BonusServlet. When the user clicks the Submit button on the
HTML form, BonusServlet is invoked because it is mapped to the BonusAlias during appli-
cation assembly.
HTML Code
The example assumes this file is in the /home/monicap/J2EE/ClientCode directory on
Unix. Here and hereafter, Windows users can reverse the slashes to get the correct directory
pathname for their platform.
<HTML>
<BODY BGCOLOR = "WHITE">
<BLOCKQUOTE>
<H3>Bonus Calculation</H3>
<FORM METHOD="GET"
ACTION="BonusAlias">
<P>
Enter social security Number:
<P>
<INPUT TYPE="TEXT" NAME="SOCSEC"></INPUT>
<P>
Enter Multiplier:
<P>
<INPUT TYPE="TEXT" NAME="MULTIPLIER"></INPUT>
<P>
<INPUT TYPE="SUBMIT" VALUE="Submit">
<INPUT TYPE="RESET">
</FORM>
</BLOCKQUOTE>
</BODY>
</HTML>
Create the Servlet

The servlet code retrieves the user data, looks up the session Bean, passes the data to the ses-
sion Bean, and upon receiving a value back from the session Bean creates an HTML page to
display the returned value to the user. The servlet code is shown in its entirety in Servlet
Code (page 9).
7
Import Statements
The servlet code begins with import statements for these packages:
• javax.servlet, which contains generic (protocol-independent) servlet classes. The
HTTPServlet class uses the ServletException class in this package to indicate a
servlet problem.
• javax.servlet.http, which contains HTTP servlet classes. The HttpServlet class is in
this package.
• java.io for system input and output. The HttpServlet class uses the IOException
class in this package to signal that an input or output exception of some kind has
occurred.
• javax.naming for using the Java naming and directory interface APIs to look up the
session Bean home interface.
• javax.rmi for looking up the session Bean home interface and making its remote
server object ready for communications.
init Method
The BonusServlet.init method looks up the session Bean home interface and creates its
instance. The method uses the JNDI name specified during component assembly (calcs) to
get a reference to the home interface by its name. The next line passes the reference and the
home interface class to the PortableRemoteObject.narrow method to be sure the reference
can be cast to type CalcHome.
InitialContext ctx = new InitialContext();
Object objref = ctx.lookup("calcs");
homecalc = (CalcHome)PortableRemoteObject.narrow(obj
ref, CalcHome.class);
doGet Method
The parameter list for the doGet method takes a request and response object. The browser
sends a request to the servlet and the servlet sends a response back to the browser. The
method implementation accesses information in the request object to find out who made
the request, what form the request data is in, and which HTTP headers were sent, and uses
the response object to create an HTML page in response to the browser's request.
The doGet method throws an IOException if there is an input or output problem when it
handles the request, and a ServletException if the request could not be handled. To calcu-
late the bonus value, the doGet method creates the home interface and calls its calcBonus
method.
8
public void doGet (HttpServletRequest request,

HttpServletResponse response)
throws ServletException, IOException
{
String socsec = null;
int multiplier = 0;
double calc = 0.0;
PrintWriter out;
response.setContentType("text/html");
String title = "EJB Example";
out = response.getWriter();
out.println("<HTML><HEAD><TITLE>)
out.println(title);
out.println("</TITLE></HEAD><BODY>");
try{
//Retrieve Bonus and Social Security Information
String strMult = request.getParameter(
"MULTIPLIER");
Integer integerMult = new Integer(strMult);
multiplier = integerMult.intValue();
socsec = request.getParameter("SOCSEC");
//Calculate bonus
double bonus = 100.00;
theCalculation = homecalc.create();
calc = theCalculation.calcBonus(multiplier, bo
nus);
}catch(Exception CreateException){
CreateException.printStackTrace();
}
//Display Data
out.println("<H1>Bonus Calculation</H1>");
out.println("<P>Soc Sec: " + socsec + "<P>");
out.println("<P>Multiplier: " + multiplier + "<P
>");
out.println("<P>Bonus Amount: " + calc + "<P>");
out.println("</BODY></HTML>");
out.close();
}
9
Servlet Code
Here is the full code. The example assumes this file is in the ClientCode directory on Unix.
import javax.servlet.*;
import javax.servlet.http.*;
import java.io.*;
import javax.naming.*;
import javax.rmi.PortableRemoteObject;
import Beans.*;
public class BonusServlet extends HttpServlet {

CalcHome homecalc;
Calc theCalculation;
public void init(ServletConfig config)

throws ServletException{
//Look up home interface

try{
homecalc =
(CalcHome)PortableRemoteObject.narrow(
objref,
CalcHome.class);
} catch (Exception NamingException) {
NamingException.printStackTrace();
}
}
public void doGet (HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException
{
String socsec = null;
int multiplier = 0;
double calc = 0.0;
PrintWriter out;
response.setContentType("text/html");
String title = "EJB Example";
out = response.getWriter();
out.println("<HTML><HEAD><TITLE>");
out.println(title);
out.println("</TITLE></HEAD><BODY>");
try{
String strMult =
request.getParameter("MULTIPLIER");
10

//Calculate bonus
calc =
theCalculation.calcBonus(multiplier, bonus);
}catch(Exception CreateException){
}
//Display Data
out.println("<P>Soc Sec: " + socsec + "<P>");
out.println("<P>Multiplier: " + multiplier + "<P
>");
out.println("<P>Bonus Amount: " + calc + "<P>");
out.close();
}
public void destroy() {
System.out.println("Destroy");
}
}
Create the Session Bean

A session Bean represents a transient conversation with a client. If the server or client
crashes, the session Bean and its data are gone. In contrast, entity Beans are persistent and
represent data in a database. If the server or client crashes, the underlying services ensure
that the entity Bean data is saved.
Because the enterprise Bean performs a simple calculation at the request of BonusServlet
and the calculation can be reinitiated in the event of a crash, it makes sense to use a session
Bean in this example.
Figure 4 shows how the application components work as a complete J2EE application once
they are assembled and deployed. The container, shown in the shaded box, is the interface
between the session Bean and the low-level platform-specific functionality that supports the
session Bean. The container is created during deployment.
11
Home
Interface
Session
Browser Servlet Bean
Remote
Interface
Figure 4 Application Components
The next sections show the session Bean code. The example assumes these files are placed in
the /home/monicap/J2EE/Beans directory on Unix.
Note: While this example shows how to write the example session Bean, it is also pos-
sible to purchase enterprise Beans from a provider and assemble them into a J2EE
application.
CalcHome
BonusServlet does not work directly with the session Bean, but creates an instance of its
home interface. The home interface extends EJBHome and has a create method for creating
the session Bean in its container.
CreateException is thrown if the session Bean cannot be created, and RemoteException is
thrown if a communications-related exception occurs during the execution of a remote
method.
package Beans;
import java.rmi.RemoteException;
import javax.ejb.CreateException;
import javax.ejb.EJBHome;
public interface CalcHome extends EJBHome {

Calc create() throws CreateException,
RemoteException;
}
12
Calc
When the home interface is created, the J2EE application server creates the remote interface
and session Bean. The remote interface extends EJBObject and declares the calcBonus
method for calculating the bonus value. This method is required to throw javax.rmi.Remo-
teException, and is implemented by the CalcBean class.
package Beans;
import javax.ejb.EJBObject;
public interface Calc extends EJBObject {

public double calcBonus(
int multiplier, double bonus)
throws RemoteException;
}
CalcBean
The session Bean class implements the SessionBean interface and provides behavior for the
calcBonus method. The setSessionContext and ejbCreate methods are called in that
order by the container after BonusServlet calls the create method in CalcHome.
The empty methods are from the SessionBean interface. These methods are called by the
Bean's container. You do not have to provide behavior for these methods unless you need
additional functionality when the Bean is, for example, created or removed from its con-
tainer.
package Beans;
import javax.ejb.SessionBean;
import javax.ejb.SessionContext;
public class CalcBean implements SessionBean {
public double calcBonus(int multiplier,

double bonus) {
double calc = (multiplier*bonus);
return calc;
}
//These methods are described in more
//detail in Lesson 2
public void ejbCreate() { }
public void setSessionContext(
SessionContext ctx) { }
13
public void ejbRemove() { }

public void ejbActivate() { }
public void ejbPassivate() { }
public void ejbLoad() { }
public void ejbStore() { }
}
Compile the Session Bean and Servlet

To save on typing, the easiest way to compile the session Bean and servlet code is with a
script (on Unix) or a batch file (on Windows).
Compile the Session Bean

Unix
#!/bin/sh
cd /home/monicap/J2EE
J2EE_HOME=/home/monicap/J2EE/j2sdkee1.2
CPATH=.:$J2EE_HOME/lib/j2ee.jar
javac -d . -classpath "$CPATH" Beans/CalcBean.java
Beans/CalcHome.java Beans/Calc.java
Windows
cd \home\monicap\J2EE
set J2EE_HOME=\home\monicap\J2EE\j2sdkee1.2
set CPATH=.;%J2EE_HOME%\lib\j2ee.jar
javac -d . -classpath %CPATH% Beans/CalcBean.java
Beans/CalcHome.java Beans/Calc.java
Compile the Servlet

Unix
cd /home/monicap/J2EE/ClientCode
CPATH=.:$J2EE_HOME/lib/j2ee.jar:
/home/monicap/J2EE:
/home/monicap/J2EE/Beans
javac -d . -classpath "$CPATH" BonusServlet.java
14
Windows
cd \home\monicap\J2EE\ClientCode
set CPATH=.;%J2EE_HOME%\lib\j2ee.jar:
\home\monicap\J2EE:
\home\monicap\J2EE\Beans
javac -d . -classpath %CPATH% BonusServlet.java
Start the J2EE Application Server

You need to start the J2EE application server to deploy and run the example. The command
to start the server is in the bin directory under your J2EE installation. If you have your path
set to read the bin directory, go to the J2EE directory (so your live version matches what you
see in this text) and type:
j2ee -verbose
If that does not work, type the following from the J2EE directory:
Unix:
j2sdkee1.2/bin/j2ee -verbose
Windows:
j2sdkee1.2\bin\j2ee -verbose
The verbose option prints informational messages to the command line as the server starts
up. When you see J2EE server startup complete, you can start the depoloyer tool.
Start the Deploy Tool

To assemble and deploy the J2EE application, you have to start the deploy tool. If you have
your path set to read the bin directory, go to the J2EE directory (so your live version matches
what you see in this text) and type:
deploytool
If that does not work, do the following from the J2EE directory:
15
Unix:
j2sdkee1.2/bin/deploytool
Windows:
j2sdkee1.2\bin\deploytool
Notes: If a memory access error is encountered when starting deploytool, add an

environment variable called JAVA_FONTS and set the path toc: \<font directory>.
For example c:\winnt\fonts. Also, If a NullPointerException for BasicFi-
leChooserUI is encountered when starting deploytool, be sure you are not starting
the tool from the root directory (i.e. c:\). If you run it from another location, such as
the bin directory for your j2sdkee1.2 installation, you will not encounter the prob-
lem.
Deploy Tool
The Deploy tool shown in Figure 5 has four main windows. The Local Applications window
displays J2EE applications and their components. The Inspecting window displays informa-
tion on the selected application or components. The Servers window tells you the application
server is running on the local host. And the Server Applications window tells you which
applications have been installed. As you go through the steps to assemble the example J2EE
application, you will see the Local Applications, Inspecting, and Server Applications win-
dows display information.
16
Figure 5 Deploy Tool
Note: To the right of the Server Applications window is a grayed Uninstall button.
After you deploy the application, you will see the application listed in the Server
Applications window. You can click Uninstall to uninstall the application, make
changes, and redeploy it without having to stop and restart the application server.
Assemble the J2EE Application

To assemble a J2EE application, you first create an Enterprise Archive (EAR) file and then
add the application components to it. In this example, there are the following two application
components:
• A Web Archive (WAR) file that contains the bonus.html and BonusServlet files.
• A Java Archive (JAR) file that contains the three session Bean files: Calc.class, Cal-
cHome.class, and CalcBean.class.
Here is a summary of the assembly steps, which are discussed in more detail below.
17
1. Create J2EE application EAR file (BonusApp.ear).

2. Create session Bean JAR file (CalcBean.jar).
3. Create web component WAR file (Bonus.war).
4. Specify JNDI name for session Bean (calcs).
5. Specify Root Context (BonusRoot).
Create J2EE Application EAR file

From the File menu, select New Application.
In the New Application dialog box that appears, type BonusApp for the Application Name.
Click the .. button next to the Location field to open the file chooser to select the location
where you want the application EAR file to be saved. In this example, that directory is /
export/home/monicap/J2EE.
In the New Application file chooser, locate the directory where you want to place the appli-
cation EAR file, and in the File name field, type BonusApp.
Click New Application.
Click OK.
The BonusApp file is now listed in the Local Applications window, and the Inspector window
to the right shows the display name, location, and contents information for BonusApp. The
meta information shown in the contents window describes the JAR file and J2EE applica-
tion, and provides runtime information about the application.
Create Session Bean JAR File

Enterprise Beans (entity and session Beans) are bundled into a Java Archive (JAR) file.
From the File menu, select New Enterprise Bean. The New Enterprise Bean Wizard
starts and displays an Introduction dialog box that summarizes the steps you are about to
take. After reading it over, click Next.
In the EJB JAR dialog box, specify the following information:
Enterprise Bean will go in: BonusApp
Display name: BonusApp
Description: A simple session Bean that
calculates a bonus. It has one method
Click Add. There are two Add buttons on this screen. Make sure you click the second one
down that is next to the Contents window.
18
In the Add Contents to .JAR dialog box, go to the J2EE directory. You can either type the
path name or use the browser to get there. Once at the J2EE directory, double click on Beans
to display the contents of the Beans directory.
Select Calc.class.
Click Add.
Select CalcHome.class.
Click Add.
Select CalcBean.class.
Click Add.
The Add Contents to .JAR dialog box should look like the one in Figure 6. The important
thing is that the Enterprise Bean JAR classes show the Beans directory prefixed to the class
names.
19
Figure 6 Select Session Bean Class Files
Click OK.
You should now be back at the EJB JAR dialog box. Beans/Calc.class, Beans/Cal-
cHome.class, and Beans/CalcBean.class should appear in the Contents window.
Click Next.
In the General dialog box, make sure the following information is selected:
classname: Beans.CalcHome
20
Home interface: Beans.CalcHome

Remote interface: Beans.Calc
Bean type: Session and Stateless
In the same dialog box, specify the display name (the name that appears when when the JAR
file is added to BonusApp in the Local Applications window, and provide a description of
the JAR file contents.
Display Name: CalcJar
Description: This JAR file contains the CalcBean session Bean.
Click Next.
The Environment Entries dialog box appears. This example does not use properties (envi-
ronment entries) so you can click Finish.
To verify the JAR file was indeed added, go to the Local Applications window and click the
key graphic in front of BonusApp. You will see the JAR file. Click the key graphic in front of
the JAR file to see the session Bean.
General inspection information appears in the right window for BonusApp. You can see Gen-
eral inspection information for CalcBeanJar or CalcBean by selecting them.
Create Web Component WAR File

Web clients (HTML pages and their corresponding servlets, or JavaServer Pages) are bun-
dled into a Web Archive (WAR) file.
From the File menu, select New Web Component. The New Web Component Wizard starts
and displays a window that summarizes the steps you are about to take. After reading it over,
click Next.
In the WAR File General Properties dialog box, provide the following information:
WAR file: BonusApp
Display name: BonusAppWar
Description: This war file contains a servlet and an
html page.
Click Add.
In the Add Contents to WAR dialog box, go to the ClientCode directory. You can either
type the path name or use the browser to get there.
21
Select BonusServlet.class. Make sure the WAR contents shows the listing as
bonus.html without the ClientCode directory prefixed to the name.
Figure 7 Add BonusServlet.class
Click Add.
Click Next.
Choose the ClientCode directory again.
22
Select bonus.html. Be sure the WAR contents shows the listing as bonus.html without
the ClientCode directory prefixed to the name.
Click Add.
Click Finish.
The Add Contents to WAR dialog box should look like the one in Figure 8.
Figure 8 Add bonus.html
In the Add Contents to WAR dialog box, click Next.

23
In the WAR File General Properties dialog box, click Next.

In the Choose Component Type dialog box, select Describe a servlet (if it is not already
selected), and click Next.
In the Component General Properties dialog box, make sure BonusServlet is selected for
the Servlet Class, and then enter a display name (BonusServlet), and a description. You
can ignore the Startup and load sequence setting here because this example uses only one
servlet.
Click Finish.
Click Next on the Parameters dialog box. BonusServlet does not use any initialization
parameters.
In the Aliases dialog box, click Add.
In the UTL Mappings list, type BonusAlias. This is the same alias name you put in the
ACTION field of the HTML form embedded in the bonus.html file.
Click Finish.
In the Content pane, you can see that the WAR file contains an XML file with structural and
attribute information on the web application, the bonus.html file, and the BonusServlet
class file. The WAR file format is such that all servlet classes go in an entry starting with
Web-INF/classes. However, when the WAR is deployed, the BonusServlet class is placed
in a Context Root directory under public_html. This placement is the convention for Serv-
let 2.2 compliant web servers.
If you want to change the display name or description, put your cursor in the appropriate
field in the window and change them as you wish. Your edits take effect with you press the
Return key.
Specify JNDI Name and Root Context

Before you can deploy the BonusApp application and its components, you have to specify the
JNDI name BonusServlet uses to look up the CalcBean session Bean, and specify a context
root directory where the deployer will put the web components.
JNDI Name
To specify the JNDI name, select BonusApp in the Local Applications window. The Inspect-
ing window displays tabs at the top, and one of those tabs is JNDI Names. Select it.
24
The Inspecting window shows a three-column display with one row. CalcJar is listed in the
left column, and in the far right column under JNDI name, type calcs and press the Return
key. That JNDI name is the same JNDI name passed to the BonusServlet.lookup method.
Context Root
Click the Web Context tab at the top of the Inspecting window. You will see BonusAppWar
in the left column. Type BonusRoot in the right column and press the Return key. During
deployment the BonusRoot directory is created under the public_html directory in your
J2sdkee1.2 installation, and the bonus.html file and BonusServlet class are copied
into it as shown in Figure 9.
j2sdkee1.2
public_html
BonusRoot
WEB-INF bonus.html
classes
BonusServlet.class
Figure 9 Context Root Directory Structure
Verify and Deploy the J2EE Application

Before you deploy the application, it is a good idea to run the verifier. The verifier will pick
up errors in the application components such as missing enterprise Bean methods that the
compiler does not catch.
25
Verify
With BonusEar selected, choose Verifier from the Tools menu. In the dialog that pops up,
click OK. The window should tell you that all tests passed. That is, if you used the session
Bean code provided for this lesson. Close the verifier window because you are now ready to
deploy the application.
Note: In the Version 1.2 software you might get a tests app.WebURI error. This
means the deploy tool did not put a .war extension on the WAR file during WAR file cre-
ation. This is a minor bug and the J2EE application deploys just fine in spite of it.
Deploy
From the Tools menu, choose Deploy Application. A Deploy BonusApp dialog box pops
up. Verify that the Target Server selectionis either localhost or the name of the jost running
the J2EE server.
Do not check the Return Client Jar box. The only time you need to check this box is when
you deploy a stand-alone application for the client program. This example uses a servlet and
HTML page so this book should not be checked. Checking this box creates a JAR file withg
deployment information needed by a stand-alone application.
Click Next.
Make sure the JNDI name shows calcs. If it does not type it in yourself, and press the
Returnkey.
Click Next.
Make sure the Context Root name shows BonusRoot. If it does not, type it in yourself and
press the Return key.
Click Next.
Click Finish to start the deployment. A dialog box pops up that displays the status of the
deployment operation. When it is complete, the three bars on the left will be completely
shaded as shown in tFigure 10. When that happens, click OK.
26
Figure 10 Deploy Application
Run the J2EE Application

The web server runs on port 8000 by default. To open the bonus.html page point your
browser to http://localhost:8000/BonusRoot/bonus.html, which is where the Deploy
tool put the HTML file.
Fill in a social security number and multiplier, and click the Submit button. BonusServlet
processes your data and returns an HTML page with the bonus calculation on it.
Bonus Calculation
Soc Sec: 777777777

Multiplier: 25
Bonus Amount 2500.0

27
L E S S O N 2
A Simple Entity Bean
This lesson expands the Lesson 1 example to use an entity Bean. BonusServlet calls on the
entity Bean to save the social security number and bonus information to and retrieve it from
a database table. This database access functionality adds the third and final tier to the thin-
client, multitiered example started in Lesson 1.
The J2EE Reference Implementation comes with Cloudscape database, and you need no
additional setup to your environment for the entity Bean to access it. In fact in this example,
you do not write any SQL or JDBC code to create the database table or perform any data-
base access operations. The table is created and the SQL code generated with the Deploy
tool during assembly and deployment.
• Create the Entity Bean
• Change the Servlet
• Compile
• Start the Platform and Tools
• Assemble and Deploy
Create the Entity Bean

An entity Bean represents persistent data stored in one row of a database table. When an
entity Bean is created, the data is written to the appropriate database table row, and if the
data in an entity Bean is updated, the data in the appropriate database table row is also
updated. The database table creation and row updates all occur without your writing any
SQL or JDBC code.
Entity Bean data is persistent because it survives crashes. If a crash occurs while the data in
an entity Bean is being updated, the entity Bean data is automatically restored to the state of
the last committed database transaction. If the crash occurs in the middle of a database trans-
action, the transaction is backed out to prevent a partial commit from corrupting the data.
28
BonusHome
The main difference between the CalcHome session Bean code and the BonusHome entity
Bean code shown below is the addition of the findByPrimaryKey finder method. This
method takes the primary key as a parameter, which is a social security number. The primary
key is used to retrieve the table row with a primary key value that corresponds to the social
security number passed to this method.
The create method takes the bonus value and primary key as parameters. When
BonusServlet instantiates the home interface and calls its create method, the container
creates a BonusBean instance and calls its ejbCreate method. The BonusHome.create and
BonusBean.ejbCreate methods must have the same signatures, so the bonus and primary
key values are passed from the home interface to the entity Bean by way of the entity Bean's
container. If a row for a given primary key (social security) number already exists, a
java.rmi.RemoteException is thrown that is handled in the BonusServlet client code.
package Beans;
import javax.ejb.FinderException;
public interface BonusHome extends EJBHome {

public Bonus create(double bonus, String socsec)
throws CreateException, RemoteException;
public Bonus findByPrimaryKey(String socsec)
throws FinderException, RemoteException;
}
Bonus
After the home interface is created, the container creates the remote interface and entity
Bean. The Bonus interface declares the getBonus and getSocSec methods so the servlet can
retrieve data from the entity Bean.
package Beans;
public interface Bonus extends EJBObject {

public double getBonus() throws RemoteException;
public String getSocSec() throws RemoteException;
}
29
Component Component
Browser Servlet Session Bean
bonus.html BonusServlet.class CalcBean.class

Calc.class
CalcHome.class
Component
Entity Bean
BonusBean.class
Bonus.class
BonusHome.class
Database
BonusBean
BonusBean is a container managed entity Bean. This means the container handles data per-
sistence and transaction management without your writing code to transfer data between the
entity Bean and the database or define transaction boundaries.
If for some reason you want the entity Bean to manage its own persistence or transactions,
you would provide implementations for some of the empty methods shown in the BonusBean
code below. The following links take you to documents that describe Bean-managed persis-
tence and transactions, and a later lesson in this tutorial will cover Bean-managed transac-
tions.
• Chapter 3 of the Writing Advanced Applications tutorial.
• Chapter 4 of the Enterprise JavaBeans Developer's Guide.
30
When BonusServlet calls BonusHome.create, the container calls the BonusBean.setEnti-

tyContext method. The EntityContext instance passed to the setEntityContext method
has methods that let the Bean return a reference to itself or get its primary key.
Next, the container calls the ejbCreate method. The ejbCreate method assigns data to the
Bean's instance variables, and then the container writes that data to the database.
The ejbPostCreate method is called after the ejbCreate method and performs any pro-
cessing needed after the Bean is created. This simple example does no post-create process-
ing.
The rest of the empty methods are callback methods called by the container to notify the
Bean that some event is about to occur. You would provide behavior for some of these meth-
ods if you are using Bean-managed persistence, and others if you need to provide Bean-spe-
cific cleanup or initialization operations. These cleanup and initialization operations take
place at specific times during the Bean's lifecycle, and the container notifies the Bean and
calls the applicable method at the appropriate time. Here is a brief description of the empty
methods:
• The ejbPassivate and ejbActivate methods are called by the container before the
container swaps the Bean in and out of storage. This process is similar to the virtual-
memory concept of swapping a memory page between memory and disk.
• The container calls the ejbRemove method if the home interface has a corresponding
remove method that gets called by the client.
• The ejbLoad and ejbStore methods are called by the container before the container
synchronizes the Bean's state with the underlying database.
The getBonus and getSocSec methods are called by clients to retrieve data stored in the
instance variables. This example has no setXXX methods, but if it did, clients would call
them to change the data in the Bean's instance variables. Any changes to the instance vari-
ables result in an update to the table row in the underlying database.
package Beans;
import javax.ejb.EntityBean;
import javax.ejb.EntityContext;
public class BonusBean implements EntityBean {
public double bonus;

public String socsec;
private EntityContext ctx;
public double getBonus() {

31
return this.bonus;
}
public String getSocSec() {
return this.socsec;
}
public String ejbCreate(double bonus,

String socsec)
throws CreateException{
//Called by container after setEntityContext
this.socsec=socsec;
this.bonus=bonus;
return null;
}
public void ejbPostCreate(double bonus,

String socsec) {
//Called by container after ejbCreate
}
//These next methods are callback methods that

//are called by the container to notify the
//Bean some event is about to occur
public void ejbActivate() {

//Called by container before Bean
//swapped into memory
}
public void ejbPassivate() {

//Called by container before
//Bean swapped into storage
}
public void ejbRemove() throws RemoteException {

//Called by container before
//data removed from database
}
public void ejbLoad() {

//Called by container to
//refresh entity Bean's state
}
public void ejbStore() {

//Called by container to save
//Bean's state to database
}
32
public void setEntityContext(EntityContext ctx){

//Called by container to set Bean context
}
public void unsetEntityContext(){

//Called by container to unset Bean context
}
}
Change the Servlet

The BonusServlet program is very similar to the Lesson 1 version with changes in the init
and doGet methods. The init method for this lesson looks up both the CalcBean session
Bean, and the BonusBean entity Bean.
CalcHome homecalc;
BonusHome homebonus;
Bonus theBonus, record;

try {
Object objref = ctx.lookup("bonus");
Object objref2 = ctx.lookup("calcs");
homebonus=(
BonusHome)PortableRemoteObject.narrow(
objref, BonusHome.class);
homecalc=(CalcHome)
PortableRemoteObject.narrow(
objref2, CalcHome.class);
}
}
The try statement in the doGet method creates the CalcBean and BonusBean home inter-
faces. After calling calcBonus to calculate the bonus, the BonusHome.create method is
called to create an entity Bean instance and a corresponding row in the underlying database
table. After creating the table, the BonusHome.findByPrimaryKey method is called to
retrieve the same record by its primary key (social security number). Next, an HTML page is
33
returned to the browser showing the data originally passed in, the calculated bonus, and the
data retrieved from the database table row.
The catch statement catches and handles duplicate primary key values (social security num-
bers). The underlying database table cannot have two rows with the same primary key, so if
you pass in the same social security number, the servlet catches and handles the error before
trying to create the entity Bean. In the event of a duplicate key, the servlet returns an HTML
page with the original data passed in, the calculated bonus, and a duplicate key error mes-
sage.
try {
String strMult = request.getParameter(
"MULTIPLIER");//Calculate bonus
//Calculate bonus
calc = theCalculation.calcBonus(
multiplier, bonus);
//Create row in table
theBonus = homebonus.create(calc, socsec);
record = homebonus.findByPrimaryKey(socsec);
//Display data
out.println("<P>Soc Sec passed in: " +
theBonus.getSocSec() + "<P>");
out.println("<P>Multiplier passed in: " +
multiplier + "<P>");
out.println("<P>Bonus Amount calculated: " +
theBonus.getBonus() + "<P>");
out.println("<P>Soc Sec retrieved: " +
record.getSocSec() + "<P>");
out.println("<P>Bonus Amount retrieved: " +
record.getBonus() + "<P>");
//Catch duplicate key error
} catch (javax.ejb.DuplicateKeyException e) {
String message = e.getMessage();
//Display data
out.println("<P>Soc Sec passed in: " +
socsec + "<P>");
out.println("<P>Bonus Amount calculated: " +
34
calc + "<P>");
out.println("<P>" + message + "<P>");
} catch (Exception CreateException) {
}
}
Compile
First, compile the entity Bean and servlet. Refer to Lesson 1 for path and classpath settings,
and information on where to place the source files.
Compile the Entity Bean

Unix
#!/bin/sh
javac -d . -classpath "$CPATH" Beans/BonusBean.java
Beans/BonusHome.java Beans/Bonus.java
Windows
javac -d . -classpath %CPATH% Beans/BonusBean.java
Compile the Servlet

Unix:
CPATH=.:$J2EE_HOME/lib/j2ee.jar:/home/monicap/J2EE:
35
Windows:
set CPATH=.;%J2EE_HOME%\lib\j2ee.jar:
\home\monicap\J2EE:
\home\monicap\J2EE\Beans
Start the Platform and Tools

To run this example, you need to start the J2EE server, the Deploy tool, and Cloudscape
database. In different windows, type the following commands:
j2ee -verbose
deploytool
cloudscape -start
If that does not work, type this from the J2EE directory:
Unix
j2sdkee1.2/bin/j2ee -verbose
j2sdkee1.2/bin/deploytool
j2sdkee1.2/bin/cloudscape -start
Windows
j2sdkee1.2\bin\j2ee -verbose
j2sdkee1.2\bin\deploytool
j2sdkee1.2\bin\cloudscape -start
Assemble and Deploy

Before you can redeploy the J2EE application with the changes for this lesson, you have to
uninstall the Lesson 1 J2EE application. You can do this any time before you deploy, but just
to make sure you do not forget, do it now.
Uninstall the Application

At the bottom of the Deploy tool is a window listing BonusApp with an Uninstall button to
the right. Click Uninstall.
36
Delete and Create New WAR File

The web archive (WAR) file contains BonusServlet and bonus.html. Because you have
changed BonusServlet, you have to delete the WAR file from the application, recreate it
with the new BonusServlet, and add the new WAR file back to the J2EE application.
Click the BonusApp application in the Local Applications window so you can see its
application components. Select BonusWar so it is highlighted. Also, toggle the key icon next
to BonusWar so BonusServlet does not show; otherwise, the delete might not work.
At the top of the Deploy tool, there is an Edit menu. Select Delete.
Now, go through the steps to create the WAR file. These steps are outlined in Lesson 1 and
summarized below:
• Select File.New Web Component from the menus at the top.
• Introduction: Read and Click Next
• War File General Properties: Specify BonusWar for the display name. Click Add, go
to the ClientCode directory, add BonusServlet.class, Click Next, go to the Client-
Code directory, add bonus.html, click Finish.
• War File General Properties: Click Next.
• Choose Component Type:. Make sure Describe a servlet is selected. Click Next.
• Component General Properties: Make the display name BonusServlet. Click Next.
• Skip Parameters. Click Next.
• Aliases: Specify BonusAlias for URL Mappings. Click Finish.
In the Inspecting window, select Web Context and specify BonusRoot.
Create EJB JAR for the Entity Bean

The steps to creating the EJB JAR for the entity Bean are very similar to the steps for the ses-
sion Bean covered in Lesson 1. There are a few differences, however, and those differences
are explained here.
Note: In this lesson, the entity Bean goes in a separate JAR file from the session Bean
to continue the example from Lesson 1 with the least number of changes.
Because these Beans have related functionality, however, you could bundle and deploy them
in the same JAR file. You will see how to bundle related Beans in the same JAR file in Les-
son 3.
• Select File.New Enterprise Bean from the menus at the top.
• Introduction: Read and click Next.
37
• EJB JAR: Make sure BonusApp shows in the Enterprise Bean will go in field. Spec-
ify BonusJar as the display name. Click Add (the one next to the Contents window).
Toggle the directory so the Beans directory displays with its contents.
• Select Bonus.class, Click Add.
• Select BonusBean.class. Click Add.
• Select BonusHome.class. Click Add.
• Click OK.
Figure 11 Adding Classes to BonusJar
• EJB JAR: Click Next.

38
• General: Make sure Beans.BonusBean is the classname, Beans.BonusHome is the

Home interface, and Beans.Bonus is the Remote interface. Enter BonusBean as the dis-
play name. Click Entity. Click Next.
• Entity Settings: Select Container managed persistence. In the window below,
check bonus and socsec. The primary key class is java.lang.String, and the pri-
mary key field name is socsec. Note that the primary key has to be a class type. Prim-
itive types are not valid for primary keys. Click Next.
• Environment Entries: Click Next. This simple entity Bean does not use properties
(environment entries).
• Enterprise Bean References: Click Next. This simple entity Bean does not reference
other enterprise Beans.
• Resource References: Click Next. This simple entity Bean does not look up a data-
base or JavaMail session object.
• Security: Click Next. This simple entity Bean does not use security roles.
• Transaction Management: Select Container-managed transactions (if it is not
already selected. In the list below make create, findByPrimaryKey, getBonus and
getSocSec required. This means the container starts a new transaction before running
these methods. The transaction commits just before the methods end. You can find
more information on these transaction settings in Chapter 6 of the Enterprise Java-
Beans Developer's Guide. Click Next.
• Click Finish.
39
Figure 12 Transaction Management
• Transaction Management: Click Finish.

• In the Local Applications window, select BonusApp. In the Inspecting window,
select JNDI names, give BonusBean the JNDI name of bonus, and press the Return key.
Before the J2EE application can be deployed, you need to specify deployment settings for
the entity Bean and generate the SQL. Here is how to do it:
• In the Local Applications window, select BonusBean.
• In the Inspecting window, select Entity, and click the Deployment Settings button
to the lower right.
• In the Deployment Settings window, specify jdbc/Cloudscape (with a capital C on
Cloudscape) for the Database JNDI name, press Return, make sure the Create table
40
on deploy and Delete table on Deploy boxes are checked, and click Generate SQL
now.
Note: If you get an error that the connection was refused, start the database as
described in Start the Platform and Tools (page 35).
Figure 13 Generate SQL and Database Table

41
• When the SQL generation completes, select the findByPrimaryKey method in the EJB
method box. To the right a SQL statement appears. It should read SELECT “socsec”
FROM “BonusBeanTable” WHERE “socsec”=?. The question mark (?) represents the
parameter passed to the findByPrimaryKey method.
• Click OK.

Note: In the Version 1.2 software you might get a tests app.WebURI error. The J2EE
application deploys in spite of it. I’ll try to find out what causes this error.
Select Tools.Deploy Application from the menus at the top. If you did not uninstall the
application first, you are prompted to do it now.
Do not check the Return Client Jar box.
Click Next.
Returnkey.
Click Next.
Click Next.
Click Finish to start the deployment. When deployment completes, click OK.
42

Bonus Calculation
Soc Sec passed in: 777777777

Multiplier passed in: 25
Bonus Amount calculated: 2500.0
Soc Sec retrieved: 7777777777
Bonus Amount retrieved: 2500.0
If you go back to bonus.html and change the multiplier to 2, but use the same social secu-
rity number, you see this:
Bonus Calculation
Bonus Amount calculated: 200.0
Duplicate primary key.
43
3
L E S S O N 4
Cooperating Enterprise Beans
In Lesson 2, A Simple Entity Bean (page 27), the servlet looks up and creates a session Bean
to perform a bonus calculation, and then looks up and creates an Entity Bean to store the
bonus value and related social security number. This lesson modifies the example so the ses-
sion Bean looks up and creates the entity Bean. Because the session and entity Bean work
together, they are bundled into one JAR file for deployment.
• Change the Session Bean
• Change the Servlet
• Compile
• Start the Platform and Tools
• Assemble and Deploy
44
Change the Session Bean

In this lesson and as shown in Figure 14, the entity Bean is a client of the session Bean. This
means the entity Bean gets its data from the session Bean instead of from BonusServlet as
it did in A Simple Entity Bean (page 27). So, the calcBonus method in the session Bean is
modified to take the social security number as a parameter and create the entity Bean.
Browser Servlet
Session Bean
bonus.html BonusServlet.class
calcBonus method
getRecord method
Entity Bean
Database
Figure 14 Beans Working Together
CalcHome
The CalcHome interface is unchanged. It has the same create method that returns an
instance of the remote interface.
package Beans;
public interface CalcHome extends EJBHome {

public Calc create()
throws CreateException, RemoteException;
}
45
Calc
The calcBonus method in the Calc interface is changed to take the social security number as
a parameter. This is so CalcBean can pass the bonus and social security number to the entity
Bean after calculating the bonus value. A new getRecord method is added so CalcBean can
find an entity Bean by its primary key (the social security number).
Also, the calcBonus method signature throws DuplicateKeyException and CreateExcep-
tion. This is so BonusServlet can catch and handle either of these exception conditions.
DuplicateKeyException descends from CreateException. If you design the calcBonus
method to throw DuplicateKeyException, but catch CreateException, DuplicateKeyEx-
ception is not thrown. The way around this is to have calcBonus throw both Dupli-
cateKeyException and CreateException.
package Beans;
import javax.ejb.DuplicateKeyException;
public interface Calc extends EJBObject {

public Bonus calcBonus(int multiplier,
double bonus,
String socsec)
throws RemoteException,
DuplicateKeyException,
CreateException;
public Bonus getRecord(String socsec)
throws RemoteException;
CalcBean
The code to create the entity Bean is moved from BonusServlet to the CalcBonus method
so the bonus and social security number can be written to the entity Bean after the bonus is
calculated. The homebonus variable is an instance variable so it can be used in the calcBo-
nus method to look up the entity Bean and in the getRecord method to locate the entity
Bean corresponding to the social security number.
package Beans;
import javax.ejb.SessionBean;
import javax.ejb.SessionContext;
46
import javax.naming.InitialContext;
import javax.rmi.PortableRemoteObject;
import javax.ejb.RemoveException;
import javax.ejb.DuplicateKeyException;
public class CalcBean implements SessionBean {

BonusHome homebonus;
//Throw DuplicateKeyException and CreateException
//so BonusServlet can catch and handle these
//exception conditions.
public Bonus calcBonus(int multiplier,
double bonus, String socsec)
throws DuplicateKeyException,
CreateException {
Bonus theBonus = null;
double calc = (multiplier*bonus);
try {
Object objref = ctx.lookup("bonus");
homebonus = (BonusHome)
objref, BonusHome.class);
}
//Store data in entity Bean
try {
theBonus = homebonus.create(calc, socsec);
} catch (java.rmi.RemoteException e) {
e.printStackTrace();
}
return theBonus;
}
public Bonus getRecord(String socsec) {

Bonus record = null;
//Use primary key to retrieve data from entity Bean
try {
record = homebonus.findByPrimaryKey(socsec);
} catch (java.rmi.RemoteException e) {
} catch (javax.ejb.FinderException e) {
e.printStackTrace();
}
return record;
}
47
public void ejbCreate() { }

public void setSessionContext(
SessionContext context){
}
public void ejbRemove() { }
public void ejbActivate() { }
public void ejbPassivate() { }
public void ejbLoad() { }
public void ejbStore() { }
}
Change the Servlet

The BonusServlet program is very similar to the version in A Simple Entity Bean (page 27)
with changes in the init and doGet methods. The init method for this lesson looks up the
CalcBean session Bean only.

CalcHome homecalc;
//Need Bonus variables because CalcBean methods
//called in the doGet method return instances
//of type Bonus
Bonus theBonus, record;

try {
homecalc = (CalcHome)
objref, CalcHome.class);
}
}
The try statement in the doGet method calculates the bonus, creates the session Bean home
interface, and calls the calcBonus and getRecord methods. If the methods successfully
complete, an HTML page is returned showing the data retrieved from the entity Bean. If
DuplicateKeyException is thrown by the calcBonus method an HTML page is returned
showing the social security number and multiplier passed in, and the exception message,
Duplicate primary key.
48
As before in A Simple Entity Bean (page 27), the catch statement catches and handles
duplicate primary key values (social security numbers).
try {
//Calculate bonus
//Call session Bean
//Pass 3 parameters:multiplier, bonus, and socsec
theBonus = theCalculation.calcBonus(
multiplier, bonus, socsec);
record = theCalculation.getRecord(socsec);
//Display data returned by session Bean
out.println("<P>Soc Sec retrieved: " +
record.getSocSec() + "<P>");
out.println("<P>Bonus Amount retrieved: " +
record.getBonus() + "<P>");
} catch (javax.ejb.DuplicateKeyException e) {
out.println("<P>Soc Sec passed in: " + socsec +
"<P>");
} catch (Exception CreateException) {
}
Compile
First, compile the entity Bean and servlet. Refer to Lesson 1 for path and classpath settings,
and information on where to place the source files.
Compile the Entity Bean

Unix
#!/bin/sh
J2EE_HOME=/home/monicap/J2EE/j2sdkee-beta
javac -d . -classpath "$CPATH" Beans/BonusBean.java
49
Windows
set J2EE_HOME=\home\monicap\J2EE\j2sdkee-beta
javac -d . -classpath %CPATH% Beans/BonusBean.java
Compile the Servlet

Unix:
J2EE_HOME=/home/monicap/J2EE/j2sdkee-beta
CPATH=.:$J2EE_HOME/lib/j2ee.jar:
/home/monicap/J2EE:
Windows:
set J2EE_HOME=\home\monicap\J2EE\j2sdkee-beta set
CPATH=.;%J2EE_HOME%\lib\j2ee.jar:\home\monicap\J2EE:
\home\monicap\J2EE/Beans
Start the Platform and Tools

To run this example, you need to start the J2EE server, the Deploy tool, and Cloudscape
database. In different windows, type the following commands:
j2ee -verbose
deploytool
cloudscape -start
If that does not work, type this from the J2EE directory:
Unix
j2sdkee-beta/bin/j2ee -verbose
j2sdkee-beta/bin/deploytool
j2sdkee-beta/bin/cloudscape -start
50
Windows
j2sdkee-beta\bin\j2ee -verbose
j2sdkee-beta\bin\deploytool
j2sdkee-beta\bin\cloudscape -start
Assemble and Deploy

Before you can redeploy the J2EE application with the changes for this lesson, you have to
uninstall the Lesson 2 J2EE application. You can do this any time before you deploy, but just
to make sure you do not forget, do it now.
Uninstall the Application

At the bottom of the Deploy tool is a window listing BonusApp with an Uninstall button to
the right. Click Uninstall.
Create J2EE Application EAR file

Rather than update the J2EE application from Lessons 1 and 2, these steps create a whole
new J2EE application. You can either delete the existing J2EE application or leave it. If you
leave the BonusApp application, make sure the 2BonusApp application which you are about
to create is selected when you go on and create the WAR and JAR files to go with it. If it is
not selected, the WAR and JAR files might be added to the BonusApp J2EE application
instead. You can use the cut, paste, and delete options on the Edit menu to move components
from one application to another.
• From the File menu, select New Application.
• In the New Application dialog box that appears, type BonusApp for the Application
Name.
• Click the .. button next to the Location field to open the file chooser to select the loca-
tion where you want the application ear file to be saved. In this example, that directory
is /export/home/monicap/J2EE.
• In the New Application file chooser, locate the directory where you want to place the
application EAR file, and in the File name field, type 2BonusApp.
• Click New Application.
• Click OK.
51
Create Web Component WAR File

Now, go through the steps to create the WAR file. These steps are outlined in Lesson 1 and
summarized below. With 2BonusApp selected,
• Select File.New Web Component from the menus at the top.
• Introduction: Read and Click Next
• War File General Properties: Specify BonusWar for the display name. Click Add, go
to the ClientCode directory, add BonusServlet.class, Click Next, go to the Client-
Code directory, add bonus.html, click Finish.
• War File General Properties: Click Next.
• Choose Component Type:. Make sure Describe a servlet is selected. Click Next.
• Component General Properties: Make the display name BonusServlet. Click Next.
• Skip Parameters. Click Next.
• Aliases: Specify BonusAlias for URL Mappings. Click Finish.
In the Inspecting window, select Web Context and specify BonusRoot.
Create EJB JAR for the Session and Entity Beans

In this lesson, you will put both the session and entity Beans in the same JAR file. To do this,
you first create the JAR file with only the session Bean in it, and then add the entity Bean to
that JAR file.
Create JAR with Session Bean

With 2BonusApp selected,
• EJB JAR: Make sure BonusApp shows in the Enterprise Bean will go in field. Spec-
ify 2BeansJar as the display name. Click Add (the one next to the Contents window).
Toggle the directory so the Beans directory displays with its contents.
• Select Calc.class, Click Add.
• Select CalcBean.class. Click Add.
• Select CalcHome.class. Click Add.
• Contents: Make sure you see Beans/Calc.class, Beans/CalcHome.class, and
Beans/CalcBean.class in the display.
• Click OK.
52

Home interface, and Beans.Bonus is the Remote interface. Enter CalcBean as the dis-
play name. Click Next.
already selected. In the list below make calcBonus, and getRecord required. This
means the container starts a new transaction before running these methods. The trans-
action commits just before the methods end. You can find more information on these
transaction settings in Chapter 6 of the Enterprise JavaBeans Developer's Guide. Click
Next.
• Review Settings: Click Finish.
select JNDI names, give CalcBean the JNDI name of calcs, and press the Return key.
Add the Entity Bean

WIth BonusApp selected,
• EJB JAR: Make sure 2BeansJar shows in the Enterprise Bean will go in field. This
setting will add the new Bean to the existing JAR file instead of putting the new Bean
in its own JAR file. Specify 2BeansJar as the display name. Click Add (the one next to
the Contents window). Toggle the directory so the Beans directory displays with its
contents.
• Select Bonus.class, Click Add.
• Select BonusBean.class. Click Add.
• Select BonusHome.class. Click Add.
• Contents: Make sure you see Beans/Bonus.class, Beans/BonusHome.class, and
Beans/BonusBean.class in the display.
• Click OK.
53

Home interface, and Beans.Bonus is the Remote interface. Enter BonusBean as the dis-
play name. Click Next.
• Entity Settings: Select Container managed persistence. In the window below,
check bonus and socsec. The primary key class is java.lang.String, and the pri-
mary key field name is socsec. Note that the primary key has to be a class type. Prim-
itive types are not valid for primary keys. Click Next.
already selected. In the list below make create, findByPrimaryKey, getBonus and
getSocSec required. This means the container starts a new transaction before running
these methods. The transaction commits just before the methods end. You can find
more information on these transaction settings in Chapter 6 of the Enterprise Java-
Beans Developer's Guide. Click Next.
• Review Settings: Click Finish.
select JNDI names, give BonusBean the JNDI name of bonus, and press the Return key.
Before the J2EE application can be deployed, you need to specify deployment settings for
the entity Bean and generate the SQL. Here is how to do it:
• In the Local Applications window, select BonusBean.
• In the Inspecting window, select Entity, and click the Deployment Settings button
to the lower right.
• In the Deployment Settings window, specify jdbc/Cloudscape (with a capital C on
Cloudscape) for the Database JNDI name, press Return, make sure the Create table
on deploy and Delete table on Deploy boxes are checked, and click Generate SQL
now.
Note: If you get an error that the connection was refused, start the database as
described in Start the Platform and Tools (page 49).
• When the SQL generation completes, select the findByPrimaryKey method in the EJB
method box. To the right a SQL statement appears. It should read SELECT “socsec”
54
FROM “BonusBeanTable” WHERE “socsec”=?. The question mark (?) represents the
parameter passed to the findByPrimaryKey method.
• Click OK.

Before you deploy the application, it is a good idea to run the verifier. The verifier will pick
up errors in the application components such as missing enterprise Bean methods that the
compiler does not catch.
Verify
Note: In the Version 1.2 software you might get a tests app.WebURI error. This
means the deploy tool did not put a .war extension on the WAR file during WAR file cre-
ation. This is a minor bug and the J2EE application deploys just fine in spite of it.
Deploy
From the Tools menu, choose Deploy Application. A Deploy BonusApp dialog box pops
up. Verify that the Target Server selection is either localhost or the name of the host running
the J2EE server.
Do not check the Return Client Jar box. The only time you need to check this box is when
you deploy a stand-alone application for the client program. This example uses a servlet and
HTML page so this book should not be checked. Checking this box creates a JAR file with
deployment information needed by a stand-alone application.
Click Next.
Returnkey.
Click Next.
Click Next.
55
Click Finish to start the deployment. A dialog box pops up that displays the status of the
deployment operation. When it is complete, the three bars on the left will be completely
shaded as shown in tFigure 15. When that happens, click OK.
Figure 15 Deploy Application

Bonus Calculation
Soc Sec retrieved: 777777777

Bonus Amount Retrieved: 200.0
56
If you supply the same social security number twice, you will see something similar to this:
Bonus Calculation

Duplicate primary key
57
Index
A doGet method 7
application assembly 16
E
application components editing information 23
editing information 23 ejbCreate method 12, 28
working together 10 EJBObject class 12
application deployment 25, 54 Enterprise Archive (EAR) file 16
application verification 24, 54 entity Bean
avax.rmi.RemoteException 12 container managed 29
B defined 27
bonus.html file 6
F
BonusServlet code 6 findByPrimaryKey method 28
C G
Cloudscape database 27 getBonus method 28
container managed getSocSec method 28
persistence 29 H
transaction management 29
home interface
Content pane 23
looking up 7
context root
role of 11
calling a servlet in an HTML form 6
HTTP headers 7
specify 23
HttpServlet class 7
create method 12, 28
CreateException class 11 I
D IOException class 7
deploy application 25, 54 J
deploy tool J2EE application components
assemble application 16 defined 4
deploy application 25, 54 j2ee -verbose command 14
described 15 Java Archive (JAR) 16
editing information 23 java.io 7
verify application 24, 54 javax.naming 7
view application components 20 javax.rmi 7
deploytool command 14 javax.servlet 7
58
javax.servlet.http 7 T
JNDI name
thin-client application defined 2
how used 7
transaction management 29
specify 23
transaction rollback 27
L
U
looking up the home interface 7
Uninstall button 16
M
V
meta information 17
verify application 24, 54
method signatures 28
Multitier architecture W
defined 2 Web Archive (WAR) file 16, 20
multitier architecture
example 3
P
persistent data 27
PortableRemoteObject class 7
primary key 28
duplicate 28
R
remote interface 12
request object 7
response object 7
run application 26, 55
S
ServletException class 7
session Bean
defined 10
SessionBean interface 12
setSessionContext method 12
signatures, methods 28

J2EE

Uploaded by

Copyright:

Available Formats

J2EE

Uploaded by

Copyright:

Available Formats

Writing Enterprise Applications with

Java 2 SDK, Enterprise Edition

Assemble the J2EE Application 16

Assemble and Deploy 50

A Simple Session Bean

Example Thin-Client Multitiered Application

Tier Enterprise Beans

Figure 1 Multitiered Architecture

J2EE Software and Setup

Class Path Settings

J2EE Application Components

Figure 2 HTML Page

Browser Servlet Session Bean

bonus.html BonusServlet.class CalcBean.class

Figure 3 Data Flow

Create the HTML File

Create the Servlet

public void doGet (HttpServletRequest request,

public class BonusServlet extends HttpServlet {

public void init(ServletConfig config)

//Look up home interface

Integer integerMult = new Integer(strMult);

Create the Session Bean

Figure 4 Application Components

public interface CalcHome extends EJBHome {

public interface Calc extends EJBObject {

public class CalcBean implements SessionBean {

public double calcBonus(int multiplier,

public void ejbRemove() { }

Compile the Session Bean and Servlet

Compile the Session Bean

Compile the Servlet

Start the J2EE Application Server

Start the Deploy Tool

Notes: If a memory access error is encountered when starting deploytool, add an

Figure 5 Deploy Tool

Assemble the J2EE Application

1. Create J2EE application EAR file (BonusApp.ear).

Create J2EE Application EAR file

Create Session Bean JAR File

Figure 6 Select Session Bean Class Files

Home interface: Beans.CalcHome

Create Web Component WAR File

Figure 7 Add BonusServlet.class

Figure 8 Add bonus.html

In the Add Contents to WAR dialog box, click Next.

In the WAR File General Properties dialog box, click Next.

Specify JNDI Name and Root Context

Figure 9 Context Root Directory Structure

Verify and Deploy the J2EE Application

Figure 10 Deploy Application

Run the J2EE Application

Soc Sec: 777777777

Bonus Amount 2500.0

A Simple Entity Bean

Create the Entity Bean

public interface BonusHome extends EJBHome {

public interface Bonus extends EJBObject {

Browser Servlet Session Bean

bonus.html BonusServlet.class CalcBean.class

When BonusServlet calls BonusHome.create, the container calls the BonusBean.setEnti-

public class BonusBean implements EntityBean {

public double bonus;

public double getBonus() {

public String ejbCreate(double bonus,

public void ejbPostCreate(double bonus,

//These next methods are callback methods that

public void ejbActivate() {

public void ejbPassivate() {

public void ejbRemove() throws RemoteException {

public void ejbLoad() {

public void ejbStore() {