Home > Articles > Programming > Java

This chapter is from the book

This chapter is from the book

Configuring and Deploying a BMP Entity Bean

Yesterday, you learned how to deploy Session beans by creating ejb-jar files with their own deployment descriptor and including the ejb-jar into an enterprise application. Deploying Entity beans is done in precisely the same way, by creating ejb-jar files that contain the Entity bean classes, with appropriate entries in the deployment descriptor. This deployment descriptor is the same deployment descriptor as for Session beans. As you saw yesterday, the root element of this deployment descriptor is the ejb-jar element:

<!ELEMENT ejb-jar (description?, display-name?, small-icon?, large-icon?,
enterprise-beans, relationships?, assembly-descriptor?, ejb-client-jar?)>

Looking at the enterprise-beans element, this is defined as follows:

<!ELEMENT enterprise-beans (session | entity | message-driven)+>

The deployment descriptor can contain Session, Entity, and/or Message-driven beans. Or put another way, Session beans and Entity beans can be placed in the same ejb-jar if required.

Entity Element

The entity element of the DTD is defined as follows:

<!ELEMENT entity (description?, display-name?, small-icon?, large-icon?,
ejb-name, home?, remote?, local-home?, local?, ejb-class,
cmp-version?, abstract-schema-name?,
cmp-field*, primkey-field?,
ejb-ref*, ejb-local-ref*,
security-role-ref*, security-identity?,

Many of the elements referred by the entity element are also used by the session element, and were discussed yesterday:

  • Presentational elementsdescription, display-name, small-icon, and large-icon.

  • Elements describing the components of the beanejb-name, home, remote, local-home, local, and ejb-class elements. The local-home and local elements just name the interfaces that extend javax.ejb.EJBLocalHome and javax.ejb.EJBLocal, respectively.

  • Elements referring to the environment and other resourcesenv-entry, ejb-ref, ejb-local-ref, resource-ref, and resource-env-ref.

The remaining elements are specific to Entity beans:

  • persistence-type—Set to Bean for bean-managed persistence or Container for container-managed persistence. For the purposes of today, this will be set to Bean.

  • prim-key-class—This mandatory element indicates the name of the primary key class. This will be a custom developed class for beans that have primary keys (JobPK for Job bean) but may be a regular class (java.lang.String) for others (the Location bean).

  • cmp-version, abstract-schema-name, cmp-field, prim-key-field, query—These are used only for CMP beans and are covered tomorrow.

  • reentrant—Set to true for reentrant Entity beans, or false for non reentrant beans. It's safer to mark Entity beans as non reentrant. There's more on this topic on Day 8, as part of the coverage of transactions.

  • security-role-ref, security-identity—You will learn more about security on Day 15.

Listing 6.12 shows the deployment descriptor for the Job bean.

Listing 6.12—entity Element Descriptor for the Job Bean

  1: <entity>
  2:   <display-name>JobBean</display-name>
  3:   <ejb-name>JobBean</ejb-name>
  4:   <local-home>data.JobLocalHome</local-home>
  5:   <local>data.JobLocal</local>
  6:   <ejb-class>data.JobBean</ejb-class>
  7:   <persistence-type>Bean</persistence-type>
  8:   <prim-key-class>data.JobPK</prim-key-class>
  9:   <reentrant>False</reentrant>
 10:   <ejb-local-ref>
 11:     <ejb-ref-name>ejb/SkillLocal</ejb-ref-name>
 12:     <ejb-ref-type>Entity</ejb-ref-type>
 13:     <local-home>data.SkillLocalHome</local-home>
x    <local>data.SkillLocal</local>
 15:     <ejb-link>data_entity_ejbs.jar#SkillBean</ejb-link>
 16:   </ejb-local-ref>
 17:   <ejb-local-ref>
 18:     <ejb-ref-name>ejb/LocationLocal</ejb-ref-name>
 19:     <ejb-ref-type>Entity</ejb-ref-type>
 20:     <local-home>data.LocationLocalHome</local-home>
 21:     <local>data.LocationLocal</local>
 22:     <ejb-link>data_entity_ejbs.jar#LocationBean</ejb-link>
 23:   </ejb-local-ref>
 24:   <ejb-local-ref>
 25:     <ejb-ref-name>ejb/CustomerLocal</ejb-ref-name>
 26:     <ejb-ref-type>Entity</ejb-ref-type>
 27:     <local-home>data.CustomerLocalHome</local-home>
 28:     <local>data.CustomerLocal</local>
 29:     <ejb-link>data_entity_ejbs.jar#CustomerBean</ejb-link>
 30:   </ejb-local-ref>
 31:   <security-identity>
 32:   <description></description>
 33:   <use-caller-identity></use-caller-identity>
 34:   </security-identity>
 35:   <resource-ref>
 36:     <res-ref-name>jdbc/Agency</res-ref-name>
 37:     <res-type>javax.sql.DataSource</res-type>
xx    <res-auth>Container</res-auth>
 39:     <res-sharing-scope>Shareable</res-sharing-scope>
 40:   </resource-ref>
 41: </entity>

Note the resource-ref dependency on jdbc/Agency, just as you saw for Session beans that make JDBC calls. The res-ref-name is the coded name jdbc/Agency that appears in the setEntityContext() method of LocationBean. This logical reference is mapped to the physical resource through the auxiliary deployment descriptor agency_ea-sun-j2ee-ri.xml. There are also ejb-ref dependencies on various other beans; these are ultimately used to manage the relationships with the Location, Skill, and Customer beans.

All of this information can be seen through the J2EE RI deploytool GUI, as shown in Figure 6.9.

Figure 6.9 The deploytool GUI displays deployment descriptor information graphically.

Good though the deploytool GUI is, sometimes a command-line interface is required. For example, you might want to automatically compile and then re-deploy your enterprise application in a project as part of a nightly build. Luckily, the deploytool also provides a command-line interface, so today you will deploy the Entity beans using this mechanism.

Under day06\agency, the directory structure has been reorganized into a number of subdirectories, as shown in Table 6.2.

Table 6.2—Directory Structure under day06\agency.




a) buildAll, which calls most of the other scripts in this directory, except

b) deploy, which deploys the enterprise application.


Java source for the client, agency, and data packages.


Standard XML deployment descriptors for the EJBs, for the enterprise application, and for the application clients. This directory also contains auxiliary deployment descriptors used by the J2EE RI to map the logical references in the standard deployment descriptors to the physical runtime environment managed by the J2EE RI container.


Compiled Java classes. The various compile* scripts in the build directory compile into this directory.


ejb-jar and ear (Enterprise Application) archives. Generated by the various build* scripts in the build directory.


The scripts to run the various clients.

To deploy the enterprise application, start Cloudscape and the J2EE RI, and then type

> cd day06\agency\build
> buildAll
> deploy

It's as simple as that!

One of the benefits of this approach is that bean developers, application assemblers and deployers who are familiar with the standard EJB deployment descriptors can modify the bean's deployment configuration by simply editing the XML deployment descriptors directly—without having to get to grips with the J2EE RI GUI. Moreover, some of the names automatically assigned by the deploytool GUI, such as the names of the ejb-jar files themselves, can be given more descriptive names. Consequently, the ejb-jar that contains the Entity beans is called data_entity_ejbs.jar and its deployment descriptor is called data_entity_ejbs_ejb-jar.xml.

If you look in the dd directory (or in the deploytool GUI as shown in Figure 6.9), you can see that the case study separates out the Session beans and the Entity beans into two different ejb-jars. The Agency ejb-jar contains the same set of Session beans that you saw yesterday (although their implementation is different as you shall see shortly, they now delegate to the Entity beans), while the Data ejb-jar has the new BMP Entity beans. How you choose to organize your enterprise application is up to you.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020