Welcome!

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.

    References

  • 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.


    @ThingsExpo Stories
    Organizations do not need a Big Data strategy; they need a business strategy that incorporates Big Data. Most organizations lack a road map for using Big Data to optimize key business processes, deliver a differentiated customer experience, or uncover new business opportunities. They do not understand what’s possible with respect to integrating Big Data into the business model.
    Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, will discuss some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he’ll go over some of the best practices for structured team migrat...
    Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, will discuss how from store operations...
    Recently, REAN Cloud built a digital concierge for a North Carolina hospital that had observed that most patient call button questions were repetitive. In addition, the paper-based process used to measure patient health metrics was laborious, not in real-time and sometimes error-prone. In their session at 21st Cloud Expo, Sean Finnerty, Executive Director, Practice Lead, Health Care & Life Science at REAN Cloud, and Dr. S.P.T. Krishnan, Principal Architect at REAN Cloud, will discuss how they bu...
    SYS-CON Events announced today that Dasher Technologies will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Dasher Technologies, Inc. ® is a premier IT solution provider that delivers expert technical resources along with trusted account executives to architect and deliver complete IT solutions and services to help our clients execute their goals, plans and objectives. Since 1999, we'v...
    SYS-CON Events announced today that TidalScale, a leading provider of systems and services, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. TidalScale has been involved in shaping the computing landscape. They've designed, developed and deployed some of the most important and successful systems and services in the history of the computing industry - internet, Ethernet, operating s...
    Enterprises have taken advantage of IoT to achieve important revenue and cost advantages. What is less apparent is how incumbent enterprises operating at scale have, following success with IoT, built analytic, operations management and software development capabilities – ranging from autonomous vehicles to manageable robotics installations. They have embraced these capabilities as if they were Silicon Valley startups. As a result, many firms employ new business models that place enormous impor...
    SYS-CON Events announced today that Taica will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Taica manufacturers Alpha-GEL brand silicone components and materials, which maintain outstanding performance over a wide temperature range -40C to +200C. For more information, visit http://www.taica.co.jp/english/.
    SYS-CON Events announced today that MIRAI Inc. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. MIRAI Inc. are IT consultants from the public sector whose mission is to solve social issues by technology and innovation and to create a meaningful future for people.
    As hybrid cloud becomes the de-facto standard mode of operation for most enterprises, new challenges arise on how to efficiently and economically share data across environments. In his session at 21st Cloud Expo, Dr. Allon Cohen, VP of Product at Elastifile, will explore new techniques and best practices that help enterprise IT benefit from the advantages of hybrid cloud environments by enabling data availability for both legacy enterprise and cloud-native mission critical applications. By rev...
    Join IBM November 1 at 21st Cloud Expo at the Santa Clara Convention Center in Santa Clara, CA, and learn how IBM Watson can bring cognitive services and AI to intelligent, unmanned systems. Cognitive analysis impacts today’s systems with unparalleled ability that were previously available only to manned, back-end operations. Thanks to cloud processing, IBM Watson can bring cognitive services and AI to intelligent, unmanned systems. Imagine a robot vacuum that becomes your personal assistant tha...
    SYS-CON Events announced today that Datera will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Datera offers a radically new approach to data management, where innovative software makes data infrastructure invisible, elastic and able to perform at the highest level. It eliminates hardware lock-in and gives IT organizations the choice to source x86 server nodes, with business model option...
    With major technology companies and startups seriously embracing Cloud strategies, now is the perfect time to attend 21st Cloud Expo October 31 - November 2, 2017, at the Santa Clara Convention Center, CA, and June 12-14, 2018, at the Javits Center in New York City, NY, and learn what is going on, contribute to the discussions, and ensure that your enterprise is on the right path to Digital Transformation.
    Infoblox delivers Actionable Network Intelligence to enterprise, government, and service provider customers around the world. They are the industry leader in DNS, DHCP, and IP address management, the category known as DDI. We empower thousands of organizations to control and secure their networks from the core-enabling them to increase efficiency and visibility, improve customer service, and meet compliance requirements.
    Digital transformation is changing the face of business. The IDC predicts that enterprises will commit to a massive new scale of digital transformation, to stake out leadership positions in the "digital transformation economy." Accordingly, attendees at the upcoming Cloud Expo | @ThingsExpo at the Santa Clara Convention Center in Santa Clara, CA, Oct 31-Nov 2, will find fresh new content in a new track called Enterprise Cloud & Digital Transformation.
    SYS-CON Events announced today that N3N will exhibit at SYS-CON's @ThingsExpo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. N3N’s solutions increase the effectiveness of operations and control centers, increase the value of IoT investments, and facilitate real-time operational decision making. N3N enables operations teams with a four dimensional digital “big board” that consolidates real-time live video feeds alongside IoT sensor data a...
    SYS-CON Events announced today that NetApp has been named “Bronze Sponsor” of SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. NetApp is the data authority for hybrid cloud. NetApp provides a full range of hybrid cloud data services that simplify management of applications and data across cloud and on-premises environments to accelerate digital transformation. Together with their partners, NetApp emp...
    Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
    SYS-CON Events announced today that Avere Systems, a leading provider of hybrid cloud enablement solutions, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Avere Systems was created by file systems experts determined to reinvent storage by changing the way enterprises thought about and bought storage resources. With decades of experience behind the company’s founders, Avere got its ...
    SYS-CON Events announced today that Avere Systems, a leading provider of enterprise storage for the hybrid cloud, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Avere delivers a more modern architectural approach to storage that doesn't require the overprovisioning of storage capacity to achieve performance, overspending on expensive storage media for inactive data or the overbui...