Weblogic Authors: Yeshim Deniz, Elizabeth White, Michael Meiner, Michael Bushong, Avi Rosenthal

Related Topics: Weblogic

Weblogic: Article

Simplifying EJB Development with XDoclet and BEA WebLogic

Simplifying EJB Development with XDoclet and BEA WebLogic

Are you tired of going through the cumbersome process of creating local/remote component and home interfaces for your EJBs, as well as the necessary WebLogic XML deployment descriptors?

Wouldn't it be wonderful to develop only the particular EJB bean file and have another tool generate all of the necessary interfaces and WebLogic deployment descriptors? Look no further: XDoclet to the rescue! XDoclet is an open-source tool that uses attribute-oriented programming concepts to automatically generate various source code files based on embedded XDoclet-specific javadoc comments. XDoclet is used in conjunction with the Ant build tool to process the various XDoclet comments in the developer's main EJB file. In this article I'll demonstrate how to use XDoclet with BEA WebLogic server to handle the creation of CMP Entity beans and container-managed relationships among CMP entity beans, as well as how to use the various WebLogic-specific XDoclet tags. (Note: The source code was generated using XDoclet 1.2 Beta and Ant 1.5. The source code for this article can be found at www.sys-con.com/weblogic/ sourcec.cfm).)

XDoclet Basics
So how does a developer actually use XDoclet? I've provided a simple business domain model that is implemented as three CMP entity beans with the following relationships:

  • Doctor Bean [M <--> N] Patient Bean (Bidirectional)
  • Patient Bean [1 <--> M] Illness Bean (Unidirectional)
  • Doctor Bean [1 <--> 1] Illness Bean (Bidirectional)

    To simplify matters we assume that:

    1. A doctor can have multiple patients.
    2. A patient can be seen by multiple doctors.
    3. A patient can have more than one illness.
    4. Only one patient can have a certain illness.
    5. Only one doctor can cure any one illness.
    XDoclet is comprised of two types of tags: class-level and method-level tags. Class-level tags are used to set properties of the EJB that characterize a main function, such as the actual bean type and the JNDI name that will be used to locate the EJB. Other options specify the name of the EJB, finder methods, transaction settings, as well as other WebLogic-specific settings. The following is an example from the Doctor bean:

    * CMP Bean utilizing XDoclet tags to represent a
    * Doctor entity.
    * @ejb.bean
    * name="Doctor"
    * type="CMP"
    * local-jndi-name="Doctor"
    * primkey-field="doctorId"
    * view-type="local"
    * @ejb.persistence
    * table-name="doctor"
    * @ejb.transaction
    * type="Required"

    Method-level tags specify attributes such as a particular method's transactional configuration (if it should appear in the remote/local component interface), create methods, relationship attributes, etc. The following is an example from the Illness bean:

    * @ejb.interface-method
    * @ejb.relation
    * name="Doctor-Illness"
    * role-name="Illness-Has-Doctor"
    * @weblogic.column-map
    * foreign-key-column="doctor_id"
    * key-column="doctor_id"
    public abstract DoctorLocal getDoctor();

    Container-Managed Relationships
    One of the rather challenging tasks for XDoclet newcomers is establishing various container-managed relationships among CMP entity beans via the XDoclet tags. XDoclet handles relationships with the @ejb.relation tag and @weblogic.column-map for specifying the familiar <column-map> elements that must be listed in the weblogic-cmp-rdbms-jar.xml file. Let's look at an example from PatientBean.java:

    * @ejb.interface-method
    * @ejb.relation
    * name="Doctors-Patients"
    * role-name="Patients-Have-Doctors"
    * @weblogic.relation
    * join-table-name="doctor_patient_link"
    * @weblogic.column-map
    * foreign-key-column="patient_id_fk"
    * key-column="patient_id"
    public abstract Collection getDoctors();

    Here we are specifying a many-to-many relationship between the Doctor and the Patient beans. The name and role-name attributes will be used to generate the necessary elements in the ejb-jar.xml file. The WebLogic-specific tags specify a common join table for the relationship as well as the <column-map> elements that will be used in the generated weblogic-cmp-rdbms-jar.xml file. A bidirectional relationship is implied here due to the corresponding XDoclet relationship tags in DoctorBean.java. To demonstrate how a windirectional relationship is described, let's look at PatientBean,java.

    * @ejb.interface-method
    * @ejb.relation
    * name="Patients-Illness"
    * role-name="Patient-Has-Illness"
    * target-ejb="Illness"
    * target-role-name="Illness-Has-Patient"
    * target-cascade-delete="yes"
    * @weblogic.target-column-map
    * foreign-key-column="patient_id"
    * key-column="patient_id"
    public abstract Collection getIllnesses();

    Here we are specifying a unidirectional relationship between the Patient and Illness beans. The target-ejb, target-role-name, and target-cascade-delete are used to specify the other side of the unidrectional relationship. XDoclet tags describing this particular relationship are not included in the corresponding Illness bean, since we are explicitly specifying the related entity from the Patient bean. In a unidrectional relationship, the @weblogic.target-column-map tag is used to specify the related bean's <column-map> elements.

    Other WebLogic-Specific XDoclet tags
    XDoclet supports both WebLogic 6.1 and 7.0 deployment descriptor settings. Instead of describing various WebLogic-specific characterstics for EJBs explicitly in the weblogic-ejb-jar.xml and weblogic-cmp-rdbms-jar.xml files, you can express them using XDoclet tags in the centralized EJB bean file. This eliminates the need to create these XML files manually.

    Following is an example of how to configure WebLogic to autoincrement an entity bean's primary key, set the concurrency strategy element to ReadOnly, and specify that the WebLogic server is not required to call ejbLoad() upon each new transaction:

    * @weblogic.cache
    * concurrency-strategy="ReadOnly"
    * read-timeout-seconds="5"
    * @weblogic.persistence
    * db-is-shared="False"
    * @weblogic.automatic-key-generation
    * generator-type="ORACLE"
    * generator-name="doctor_seq"
    * key-cache-size="10"

    XDoclet provides many other WebLogic tags that allow the developer to conveniently configure features such as clustering, field groups, and relationship caching in a single bean file via Javadoc comments. Consult the XDoclet documentation for more information on these specific tags as well as other features provided by XDoclet. Utilizing the powerful capabilities of XDoclet with BEA WebLogic Server defintitely facilitates the development of EJBs.


  • http://xdoclet.sourceforge.net
  • http://jakarta.apache.org/ant
  • http://dev2dev.bea.com
  • More Stories By Ryan LeCompte

    Ryan LeCompte is a research assistant with the ACIM Center of the University of Louisiana at Lafayette. Ryan has been selected to engage in research and development at the Center as part of a NSF-funded Research Experiences for Undergraduates Program. He has extensive research and development experience in designing and implementing enterprise solutions based on Enterprise JavaBeans and BEA WebLogic application server technologies. He has developed various J2EE applications that have been deployed by the State of Louisiana, the University and the private sector.

    Comments (0)

    Share your thoughts on this story.

    Add your comment
    You must be signed in to add a comment. Sign-in | Register

    In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.

    IoT & Smart Cities Stories
    All in Mobile is a place where we continually maximize their impact by fostering understanding, empathy, insights, creativity and joy. They believe that a truly useful and desirable mobile app doesn't need the brightest idea or the most advanced technology. A great product begins with understanding people. It's easy to think that customers will love your app, but can you justify it? They make sure your final app is something that users truly want and need. The only way to do this is by ...
    Digital Transformation and Disruption, Amazon Style - What You Can Learn. Chris Kocher is a co-founder of Grey Heron, a management and strategic marketing consulting firm. He has 25+ years in both strategic and hands-on operating experience helping executives and investors build revenues and shareholder value. He has consulted with over 130 companies on innovating with new business models, product strategies and monetization. Chris has held management positions at HP and Symantec in addition to ...
    DXWorldEXPO LLC announced today that Big Data Federation to Exhibit at the 22nd International CloudEXPO, colocated with DevOpsSUMMIT and DXWorldEXPO, November 12-13, 2018 in New York City. Big Data Federation, Inc. develops and applies artificial intelligence to predict financial and economic events that matter. The company uncovers patterns and precise drivers of performance and outcomes with the aid of machine-learning algorithms, big data, and fundamental analysis. Their products are deployed...
    Dynatrace is an application performance management software company with products for the information technology departments and digital business owners of medium and large businesses. Building the Future of Monitoring with Artificial Intelligence. Today we can collect lots and lots of performance data. We build beautiful dashboards and even have fancy query languages to access and transform the data. Still performance data is a secret language only a couple of people understand. The more busine...
    The challenges of aggregating data from consumer-oriented devices, such as wearable technologies and smart thermostats, are fairly well-understood. However, there are a new set of challenges for IoT devices that generate megabytes or gigabytes of data per second. Certainly, the infrastructure will have to change, as those volumes of data will likely overwhelm the available bandwidth for aggregating the data into a central repository. Ochandarena discusses a whole new way to think about your next...
    CloudEXPO | DevOpsSUMMIT | DXWorldEXPO are the world's most influential, independent events where Cloud Computing was coined and where technology buyers and vendors meet to experience and discuss the big picture of Digital Transformation and all of the strategies, tactics, and tools they need to realize their goals. Sponsors of DXWorldEXPO | CloudEXPO benefit from unmatched branding, profile building and lead generation opportunities.
    Cell networks have the advantage of long-range communications, reaching an estimated 90% of the world. But cell networks such as 2G, 3G and LTE consume lots of power and were designed for connecting people. They are not optimized for low- or battery-powered devices or for IoT applications with infrequently transmitted data. Cell IoT modules that support narrow-band IoT and 4G cell networks will enable cell connectivity, device management, and app enablement for low-power wide-area network IoT. B...
    The hierarchical architecture that distributes "compute" within the network specially at the edge can enable new services by harnessing emerging technologies. But Edge-Compute comes at increased cost that needs to be managed and potentially augmented by creative architecture solutions as there will always a catching-up with the capacity demands. Processing power in smartphones has enhanced YoY and there is increasingly spare compute capacity that can be potentially pooled. Uber has successfully ...
    SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
    When talking IoT we often focus on the devices, the sensors, the hardware itself. The new smart appliances, the new smart or self-driving cars (which are amalgamations of many ‘things'). When we are looking at the world of IoT, we should take a step back, look at the big picture. What value are these devices providing. IoT is not about the devices, its about the data consumed and generated. The devices are tools, mechanisms, conduits. This paper discusses the considerations when dealing with the...