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.

    @ThingsExpo Stories
    Organizations planning enterprise data center consolidation and modernization projects are faced with a challenging, costly reality. Requirements to deploy modern, cloud-native applications simultaneously with traditional client/server applications are almost impossible to achieve with hardware-centric enterprise infrastructure. Compute and network infrastructure are fast moving down a software-defined path, but storage has been a laggard. Until now.
    Dion Hinchcliffe is an internationally recognized digital expert, bestselling book author, frequent keynote speaker, analyst, futurist, and transformation expert based in Washington, DC. He is currently Chief Strategy Officer at the industry-leading digital strategy and online community solutions firm, 7Summits.
    Digital Transformation is much more than a buzzword. The radical shift to digital mechanisms for almost every process is evident across all industries and verticals. This is often especially true in financial services, where the legacy environment is many times unable to keep up with the rapidly shifting demands of the consumer. The constant pressure to provide complete, omnichannel delivery of customer-facing solutions to meet both regulatory and customer demands is putting enormous pressure on...
    IoT is at the core or many Digital Transformation initiatives with the goal of re-inventing a company's business model. We all agree that collecting relevant IoT data will result in massive amounts of data needing to be stored. However, with the rapid development of IoT devices and ongoing business model transformation, we are not able to predict the volume and growth of IoT data. And with the lack of IoT history, traditional methods of IT and infrastructure planning based on the past do not app...
    "Akvelon is a software development company and we also provide consultancy services to folks who are looking to scale or accelerate their engineering roadmaps," explained Jeremiah Mothersell, Marketing Manager at Akvelon, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
    DXWorldEXPO LLC, the producer of the world's most influential technology conferences and trade shows has announced the 22nd International CloudEXPO | DXWorldEXPO "Early Bird Registration" is now open. Register for Full Conference "Gold Pass" ▸ Here (Expo Hall ▸ Here)
    More and more brands have jumped on the IoT bandwagon. We have an excess of wearables – activity trackers, smartwatches, smart glasses and sneakers, and more that track seemingly endless datapoints. However, most consumers have no idea what “IoT” means. Creating more wearables that track data shouldn't be the aim of brands; delivering meaningful, tangible relevance to their users should be. We're in a period in which the IoT pendulum is still swinging. Initially, it swung toward "smart for smart...
    IoT is rapidly becoming mainstream as more and more investments are made into the platforms and technology. As this movement continues to expand and gain momentum it creates a massive wall of noise that can be difficult to sift through. Unfortunately, this inevitably makes IoT less approachable for people to get started with and can hamper efforts to integrate this key technology into your own portfolio. There are so many connected products already in place today with many hundreds more on the h...
    Here are the Top 20 Twitter Influencers of the month as determined by the Kcore algorithm, in a range of current topics of interest from #IoT to #DeepLearning. To run a real-time search of a given term in our website and see the current top influencers, click on the topic name. Among the top 20 IoT influencers, ThingsEXPO ranked #14 and CloudEXPO ranked #17.
    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...
    As data explodes in quantity, importance and from new sources, the need for managing and protecting data residing across physical, virtual, and cloud environments grow with it. Managing data includes protecting it, indexing and classifying it for true, long-term management, compliance and E-Discovery. Commvault can ensure this with a single pane of glass solution – whether in a private cloud, a Service Provider delivered public cloud or a hybrid cloud environment – across the heterogeneous enter...
    The Jevons Paradox suggests that when technological advances increase efficiency of a resource, it results in an overall increase in consumption. Writing on the increased use of coal as a result of technological improvements, 19th-century economist William Stanley Jevons found that these improvements led to the development of new ways to utilize coal. In his session at 19th Cloud Expo, Mark Thiele, Chief Strategy Officer for Apcera, compared the Jevons Paradox to modern-day enterprise IT, examin...
    DXWorldEXPO LLC announced today that ICC-USA, a computer systems integrator and server manufacturing company focused on developing products and product appliances, will exhibit at the 22nd International CloudEXPO | DXWorldEXPO. DXWordEXPO New York 2018, colocated with CloudEXPO New York 2018 will be held November 11-13, 2018, in New York City. ICC is a computer systems integrator and server manufacturing company focused on developing products and product appliances to meet a wide range of ...
    Major trends and emerging technologies – from virtual reality and IoT, to Big Data and algorithms – are helping organizations innovate in the digital era. However, to create real business value, IT must think beyond the ‘what’ of digital transformation to the ‘how’ to harness emerging trends, innovation and disruption. Architecture is the key that underpins and ties all these efforts together. In the digital age, it’s important to invest in architecture, extend the enterprise footprint to the cl...
    DXWorldEXPO LLC announced today that All in Mobile, a mobile app development company from Poland, will exhibit at the 22nd International CloudEXPO | DXWorldEXPO. All In Mobile is a mobile app development company from Poland. Since 2014, they maintain passion for developing mobile applications for enterprises and startups worldwide.
    In an era of historic innovation fueled by unprecedented access to data and technology, the low cost and risk of entering new markets has leveled the playing field for business. Today, any ambitious innovator can easily introduce a new application or product that can reinvent business models and transform the client experience. In their Day 2 Keynote at 19th Cloud Expo, Mercer Rowe, IBM Vice President of Strategic Alliances, and Raejeanne Skillern, Intel Vice President of Data Center Group and ...
    "We are a well-established player in the application life cycle management market and we also have a very strong version control product," stated Flint Brenton, CEO of CollabNet,, in this SYS-CON.tv interview at 18th Cloud Expo at the Javits Center in New York City, NY.
    In his session at @ThingsExpo, Arvind Radhakrishnen discussed how IoT offers new business models in banking and financial services organizations with the capability to revolutionize products, payments, channels, business processes and asset management built on strong architectural foundation. The following topics were covered: How IoT stands to impact various business parameters including customer experience, cost and risk management within BFS organizations.
    While the focus and objectives of IoT initiatives are many and diverse, they all share a few common attributes, and one of those is the network. Commonly, that network includes the Internet, over which there isn't any real control for performance and availability. Or is there? The current state of the art for Big Data analytics, as applied to network telemetry, offers new opportunities for improving and assuring operational integrity. In his session at @ThingsExpo, Jim Frey, Vice President of S...
    With the introduction of IoT and Smart Living in every aspect of our lives, one question has become relevant: What are the security implications? To answer this, first we have to look and explore the security models of the technologies that IoT is founded upon. In his session at @ThingsExpo, Nevi Kaja, a Research Engineer at Ford Motor Company, discussed some of the security challenges of the IoT infrastructure and related how these aspects impact Smart Living. The material was delivered interac...