Home > Articles > Programming > Java

  • Print
  • + Share This
Like this article? We recommend

Entity Bean Client Interfaces

Building and using home and remote client interfaces for entity beans is very similar to building and using home and remote client interfaces for session beans. In fact, except for an additional type of finder method that needs to be added to the entity bean home interface definition, only a few small subtle semantic differences exist. I describe how to build entity bean interfaces and how clients access these interfaces next.

Entity Bean Remote Interfaces

Entity bean remote interfaces encapsulate the client's view of an entity bean. The approach by which entity bean remote interfaces are developed is identical to that of session bean remote interfaces. Entity bean interfaces typically consist of getters and setters for retrieving and establishing data to be associated with an entity bean, but they can also have other arbitrary application-specific interfaces defined for them.

Entity Bean Remote Interface Logical Architecture

This section describes how to build and use entity bean remote interfaces. Figure 3 depicts the basic logical architecture for building and using remote EJB client interfaces to distributed entity EJBs.

Figure 3 Entity bean remote interface architecture.

All application-specific interfaces to distributed EJB objects, such as MyEntityEJB, shown in the figure, must extend the javax.ejb.EJBObject interface. As with session beans, entity beans employ underlying stubs, skeletons, and container-management services for implementing distributed and managed access to server-side entity EJBs from client-side interfaces. The only real difference between entity bean and session bean remote interfaces lies in a few subtle semantic differences, as I discuss next.

As with session bean remote interfaces, an application-specific remote EJB interface must be created for each entity bean component. This interface provides the distributed interface usable by entity bean clients to invoke the application-specific logic of entity beans. For each distributable application-specific method on an entity bean server-side component, such as MyEntityEJBean.someMethod(), an associated application-specific method must be defined on the EJB client-side remote interface, such as MyEntityEJB.someMethod(). As a side effect of their distributable nature, each method in the application-specific remote interface should declare that it can throw a java.rmi.RemoteException. Of course, such rules apply only to server-side component methods that you want to make distributable. In addition to application-specific interfaces on an EJB remote interface, a set of methods inherited from EJBObject can be invoked on a remote entity bean object.

Entity Bean Home Interfaces

Entity bean clients use home interfaces to create, find, and remove entity beans. Creation of entity beans actually relates to the insertion of a new entry into a data source (for example, a new row in a database table). Interfaces for finding entity beans provide a mechanism of querying for data-source entries; results are returned in an object-oriented manner (that is, in terms of entity bean objects). Removing an entity bean involves deleting its associated data-source entry in the database. This section describes how to create and utilize entity bean interfaces to perform these basic functions as well as additional supporting functionality.

Entity Bean Home Interface Logical Architecture

Figure 4 depicts the architecture behind creating entity bean home interfaces and shows how clients may use these interfaces. To obtain handles to application-specific EJB home interface objects, such as MyEntityEJBHome, which must extend the standard javax.ejb.EJBHome interface, I use JNDI to look up named home references. Server-side skeletons and the container handle mapping calls from entity bean client stubs that implement application-specific home interfaces on a particular entity bean instance. Home interfaces can also be used to persist their handles for later reconstruction and to obtain metadata about the EJBs that they create.

Figure 4 Entity bean home interface architecture.

The means by which clients look up entity bean home objects is identical to the means by which they look up session bean home objects. JNDI is used whether your client operates inside a J2EE container or whether it operates outside a container in a standalone fashion. If a client operates inside a J2EE container, <ejb-ref> elements can be used to refer to EJB home interfaces during lookup. Entity beans that want to act as clients to other EJBs define <ejb-ref> elements within their <entity> element definition inside an ejb-jar.xml file.

A series of one or more create(...) methods is defined on the custom home interface to represent the different ways in which the associated entity bean data-source entry can be created. A single create(...) method must be defined on the home interface for each ejbCreate(...) method defined on the entity bean implementation. Each version of a create(...) method returns an instance of the entity bean's remote interface (for example, MyEntityEJB) and contains zero or more input parameters related to the specific types of initialization parameters needed by the associated ejbCreate(...) methods. Each create(...) method must also be defined to throw a java.rmi.RemoteException and a javax.ejb.CreateException. Additionally, each create(...) method must be defined to throw any application-specific exceptions that have been defined for its associated ejbCreate(...) method.

The create() methods are not the only application-specific methods that can be defined on an entity bean home interface. A collection of finder methods is also defined that enables the client to query for existing entity beans. A findXXX(...) method on the entity bean home interface must exist for each ejbFindXXX(...) method that exists on the entity bean implementation. For CMP entity beans, because no ejbFindXXX(...) methods are explicitly defined on an entity bean implementation, the valid findXXX(...) methods can be determined from the entity bean deployment descriptor (as we'll soon learn in the last section). Each findXXX(...) method defined on the entity bean client home interface should also declare that RemoteException and FinderException objects can be thrown back to the client.

All entity bean home interfaces must define at least one findByPrimaryKey() method because all entity beans must define an ejbFindByPrimaryKey() method. The findByPrimaryKey() method must be defined so that it returns a handle to an entity bean remote object (for example, MyEntityEJB). The container handles associating the primary key returned from the ejbFindByPrimaryKey() entity bean method to an actual bean instance and returned entity bean client remote interface stub. The other findXXX(...) methods must also be defined to match each associated ejbFindXXX(...) method, and they should have the same input and output parameters. The difference on the client side is that the Enumeration or Collection object returned from findXXX(...) contains implementations of entity bean remote objects instead of primary keys contained in the collections returned from associated ejbFindXXX(...) methods on server-side entity bean implementations.

  • + Share This
  • 🔖 Save To Your Account

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