Welcome!

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

Related Topics: Weblogic

Weblogic: Article

J2EE Design Patterns

J2EE Design Patterns

Not surprisingly, the concept of design patterns originated in the world of architecture. A design pattern is a proven, reusable solution to a recurring problem.

I've always enjoyed building things, both as a software engineer and as a homeowner. Whether the raw materials are Java classes or plywood and nails, I get the best finished results when I start with a good design and follow standard procedures that reflect the experience and knowledge of seasoned professionals. When I wear my tool belt, I try to follow these "tricks of the trade." As a software developer, I use design patterns.

Software design patterns were initially popularized by the book Design Patterns: Elements of Reusable Object-Oriented Software by Erich Gamma, Richard Helm, Ralph Johnson, and John Vlissides. The four authors are often referred to as the "Gang of Four," or simply GOF.

Sun's Java Center has cataloged a number of design patterns specifically for J2EE applications (see http://java.sun.com/blueprints/corej2eepatterns). Each pattern is documented formally with accompanying UML diagrams. I'll introduce four of these patterns in this article.

Pattern #1: Composite View Pattern
Don't start from scratch. If you want to construct a housing development with a number of similar houses, you probably wouldn't undertake each house as a separate project. Instead, you would work from a master design and reuse common elements such as doors, windows, and floor plans. That's the idea behind this pattern.

Today's Web applications typically have complex screens with repeated elements such as menus, navigation bars, company logos, and so on. The Composite View pattern suggests that you divide the screens into pieces, coding the pieces as self-contained units. This pattern helps your Web application's screen to have a common look and feel, and it promotes reuse of view components.

It's easy to implement the Composite View pattern using JSPs. There are two built-in mechanisms: the <%@ include> directive and the <jsp:include> action. Both allow you to construct a JSP from a number of smaller JSPs (see Listing 1). Note that there is a subtle difference between JSP directives and JSP actions. Directives are acted upon when the JSP is translated to a servlet. This normally occurs just once during the lifetime of a Web application. JSP actions, however, are carried out at request time. Request-time inclusion gives you more flexibility and is generally the preferred approach.

A more sophisticated implementation of the Composite View pattern allows you to generate all of an application's screens dynamically, based on settings in an XML-based configuration file. One JSP can be used as a template that specifies the common overall layout and defines subregions that are filled in at run time. Some of these regions contain common screen elements, while other regions show content that varies according to the user's current activity. You will find this approach in Sun's demonstration J2EE application, the Java Pet Store (see http://java.sun.com/blueprints/patterns/ CompositeView.html).

Custom JSP tags are used to implement the Composite View pattern in the Pet Store application. Custom tags allow you to extend the JSP language and create your own tags. Each tag is associated with a Java class called the tag handler. Sun provides the JSP Standard Tag Library (JSTL), and BEA provides a set of custom tags that are packaged in a file called weblogic-tags.jar. This JAR file contains the tag handler classes and a tag library descriptor (TLD). To use these tags, copy this JAR file to the Web application that contains your JSPs and reference the tag library in the JSPs.

Pattern #2: Intercepting Filter Pattern
Tools that can be adapted with "snap-on" accessories are the most useful and flexible. If you've been in a hardware store lately, you've probably seen sets of tools that share a common battery pack. At one moment it's a drill, but with a quick twist of the wrist you can take off the drill head and turn it into a saw or a sander. This makes me think of the Intercepting Filter pattern, which involves creating pluggable filters that can intercept incoming HTTP requests and outgoing responses. You can add and remove these filters unobtrusively without any changes to existing code.

Servlet filters, introduced with servlet specification version 2.3, are perfect for this pattern. A servlet filter is a small class that allows you to manipulate the request and/or response. A filter object is instantiated and managed by the servlet container, and has a life cycle similar to a servlet. Common uses for filters include logging HTTP requests, validating request parameters, and authorizing or denying access to resources. A simple logging filter is shown in Listing 2. Filters can also be used to modify the response, changing its format and/or contents.

Filters are applied selectively to one or more servlets or JSPs by settings in web.xml (see Listing 3). Filters and filter mappings can also be configured in the WebLogic Administration Console by selecting your Web application and then clicking on the link labeled "Edit Web Application Deployment Descriptors."

Servlet filters provide a mechanism to encapsulate recurring tasks in reusable units, a goal shared by the Composite View and several other J2EE design patterns. Since filters are applied declaratively rather than programmatically, they can easily be enabled, disabled, or replaced, just like the attachments on my cordless drill.

Pattern #3: Session Facade Pattern
If you want to have a custom home built, you usually hire a general contractor, who then worries about dealing with all the various subcontractors (drywall, roofing, plumbing, and so on). This simplifies your life in that you only have to interface with and pay the general contractor. The general contractor serves as a front end, or "facade", for the subcontractors.

A commonly used J2EE pattern for EJBs is called the Session Facade pattern. In this pattern, a stateless session bean is used as a facade to hide access to one or more entity beans. Remote clients interact only with the session bean and never directly with the entity beans (see Figure 1). The first important benefit of the Session Facade pattern is that the client has a simpler interface and doesn't need to know about the details of which entity beans and which methods to use. In my analogy, the session bean is like the general contractor and the entity beans are the subcontractors.

The Session Facade pattern improves performance as only the calls between the client and the session bean go across the network, while calls from the session bean to the entity beans are local to the EJB container. Performance can be further enhanced through the use of local interfaces, introduced as part of the EJB specification version 2.0. Local interfaces provide support for "lightweight" access from within the EJB container, avoiding the overhead associated with a remote interface.

A third benefit of the Session Facade pattern relates to transactions. With container-managed transactions, the container begins a transaction when a method starts to execute and ends the transaction when the method returns. By enclosing the entity beans calls in the session bean method, the database operations are automatically grouped together as a transactional unit. To ensure that they participate in the same transaction, the entity bean methods should be assigned the "Required" transaction attribute in ejb-jar.xml (or by using the WebLogic Administration Console).

Pattern #4: Service Locator Pattern
Don't waste a lot of time looking for your tools. In an ideal world, if I needed my extra-long Phillips screwdriver, I would look for it just once and keep it close at hand until I finish my project. Unfortunately, I usually end up spending a lot of time looking for (and cursing at) the same tool. Distributed applications often exhibit the same behavior: they waste time looking for network resources. The Service Locator pattern solves this problem.

Most J2EE applications can take advantage of the Service Locator pattern. The idea behind this pattern is to provide a utility class that centralizes and hides all the details of a complex service. JNDI lookups are perfect candidates, since they generally need to be done only once, and the results can be saved for later use. Enterprise applications use JNDI lookups to locate EJB home interfaces, JDBC datasources, and Java Message Service (JMS) components.

Listing 4 shows a simple implementation of the Service Locator pattern. Note that the class does not offer a public constructor, but instead has a public static method that allows callers to access a unique instance of the class. This demonstrates a basic GOF pattern, the Singleton pattern.

Conclusion
We've looked at four J2EE design patterns, and I hope you'll be motivated to learn other patterns. I like to keep design patterns handy in my virtual "tool belt," and I always have room for more. In both software and home construction, design patterns help us to build better products and profit from the experience (and mistakes) of our colleagues. Now if I could just stop hitting my thumb with the hammer!

More Stories By Alan Baumgarten

Alan Baumgarten has over 20 years’ experience in software engineering and technical training. He currently teaches and develops courseware for /training/etc, Inc., a Columbia, MD– based firm specializing in software training for the enterprise. Alan holds a masters degree in computer science from The Johns Hopkins University.

[email protected]

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
DX World EXPO, LLC, a Lighthouse Point, Florida-based startup trade show producer and the creator of "DXWorldEXPO® - Digital Transformation Conference & Expo" has announced its executive management team. The team is headed by Levent Selamoglu, who has been named CEO. "Now is the time for a truly global DX event, to bring together the leading minds from the technology world in a conversation about Digital Transformation," he said in making the announcement.
"Space Monkey by Vivent Smart Home is a product that is a distributed cloud-based edge storage network. Vivent Smart Home, our parent company, is a smart home provider that places a lot of hard drives across homes in North America," explained JT Olds, Director of Engineering, and Brandon Crowfeather, Product Manager, at Vivint Smart Home, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that Conference Guru has been named “Media Sponsor” of the 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. A valuable conference experience generates new contacts, sales leads, potential strategic partners and potential investors; helps gather competitive intelligence and even provides inspiration for new products and services. Conference Guru works with conference organizers to pass great deals to gre...
The Internet of Things will challenge the status quo of how IT and development organizations operate. Or will it? Certainly the fog layer of IoT requires special insights about data ontology, security and transactional integrity. But the developmental challenges are the same: People, Process and Platform. In his session at @ThingsExpo, Craig Sproule, CEO of Metavine, demonstrated how to move beyond today's coding paradigm and shared the must-have mindsets for removing complexity from the develop...
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, led attendees through the exciting evolution of the cloud. He looked at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering m...
"Evatronix provides design services to companies that need to integrate the IoT technology in their products but they don't necessarily have the expertise, knowledge and design team to do so," explained Adam Morawiec, VP of Business Development at Evatronix, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
Large industrial manufacturing organizations are adopting the agile principles of cloud software companies. The industrial manufacturing development process has not scaled over time. Now that design CAD teams are geographically distributed, centralizing their work is key. With large multi-gigabyte projects, outdated tools have stifled industrial team agility, time-to-market milestones, and impacted P&L stakeholders.
"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.
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
In his session at 21st Cloud Expo, Carl J. Levine, Senior Technical Evangelist for NS1, will objectively discuss how DNS is used to solve Digital Transformation challenges in large SaaS applications, CDNs, AdTech platforms, and other demanding use cases. Carl J. Levine is the Senior Technical Evangelist for NS1. A veteran of the Internet Infrastructure space, he has over a decade of experience with startups, networking protocols and Internet infrastructure, combined with the unique ability to it...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
"Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
Gemini is Yahoo’s native and search advertising platform. To ensure the quality of a complex distributed system that spans multiple products and components and across various desktop websites and mobile app and web experiences – both Yahoo owned and operated and third-party syndication (supply), with complex interaction with more than a billion users and numerous advertisers globally (demand) – it becomes imperative to automate a set of end-to-end tests 24x7 to detect bugs and regression. In th...
"MobiDev is a software development company and we do complex, custom software development for everybody from entrepreneurs to large enterprises," explained Alan Winters, U.S. Head of Business Development at MobiDev, 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.
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, discussed how from store operations and ...
"There's plenty of bandwidth out there but it's never in the right place. So what Cedexis does is uses data to work out the best pathways to get data from the origin to the person who wants to get it," explained Simon Jones, Evangelist and Head of Marketing at Cedexis, 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.
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...
SYS-CON Events announced today that Telecom Reseller 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, NY. Telecom Reseller reports on Unified Communications, UCaaS, BPaaS for enterprise and SMBs. They report extensively on both customer premises based solutions such as IP-PBX as well as cloud based and hosted platforms.