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
The 22nd International Cloud Expo | 1st DXWorld Expo has announced that its Call for Papers is open. Cloud Expo | DXWorld Expo, to be held June 5-7, 2018, at the Javits Center in New York, NY, brings together Cloud Computing, Digital Transformation, Big Data, Internet of Things, DevOps, Machine Learning and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding busin...
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 ...
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, discussed 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 covered some of the best practices for structured team migration an...
No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
With tough new regulations coming to Europe on data privacy in May 2018, Calligo will explain why in reality the effect is global and transforms how you consider critical data. EU GDPR fundamentally rewrites the rules for cloud, Big Data and IoT. In his session at 21st Cloud Expo, Adam Ryan, Vice President and General Manager EMEA at Calligo, examined the regulations and provided insight on how it affects technology, challenges the established rules and will usher in new levels of diligence arou...
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...
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
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, discussed how they built...
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 ...
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 ...
DevOps at Cloud Expo – being held June 5-7, 2018, at the Javits Center in New York, NY – announces that its Call for Papers is open. Born out of proven success in agile development, cloud computing, and process automation, DevOps is a macro trend you cannot afford to miss. From showcase success stories from early adopters and web-scale businesses, DevOps is expanding to organizations of all sizes, including the world's largest enterprises – and delivering real results. Among the proven benefits,...
@DevOpsSummit at Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, is co-located with 22nd Cloud Expo | 1st DXWorld Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time to wait...
Cloud Expo | DXWorld Expo have announced the conference tracks for Cloud Expo 2018. Cloud Expo will be held June 5-7, 2018, at the Javits Center in New York City, and November 6-8, 2018, at the Santa Clara Convention Center, Santa Clara, CA. Digital Transformation (DX) is a major focus with the introduction of DX Expo within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive ov...
SYS-CON Events announced today that T-Mobile exhibited at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. As America's Un-carrier, T-Mobile US, Inc., is redefining the way consumers and businesses buy wireless services through leading product and service innovation. The Company's advanced nationwide 4G LTE network delivers outstanding wireless experiences to 67.4 million customers who are unwilling to compromise on qua...
SYS-CON Events announced today that Cedexis 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. Cedexis is the leader in data-driven enterprise global traffic management. Whether optimizing traffic through datacenters, clouds, CDNs, or any combination, Cedexis solutions drive quality and cost-effectiveness. For more information, please visit https://www.cedexis.com.
SYS-CON Events announced today that Google Cloud has been named “Keynote 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. Companies come to Google Cloud to transform their businesses. Google Cloud’s comprehensive portfolio – from infrastructure to apps to devices – helps enterprises innovate faster, scale smarter, stay secure, and do more with data than ever before.
SYS-CON Events announced today that Vivint to exhibit at SYS-CON's 21st Cloud Expo, which will take place on October 31 through November 2nd 2017 at the Santa Clara Convention Center in Santa Clara, California. As a leading smart home technology provider, Vivint offers home security, energy management, home automation, local cloud storage, and high-speed Internet solutions to more than one million customers throughout the United States and Canada. The end result is a smart home solution that sav...
SYS-CON Events announced today that Opsani 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. Opsani is the leading provider of deployment automation systems for running and scaling traditional enterprise applications on container infrastructure.
SYS-CON Events announced today that Nirmata 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. Nirmata provides a comprehensive platform, for deploying, operating, and optimizing containerized applications across clouds, powered by Kubernetes. Nirmata empowers enterprise DevOps teams by fully automating the complex operations and management of application containers and its underlying ...
SYS-CON Events announced today that Opsani to exhibit at SYS-CON's 21st Cloud Expo, which will take place on October 31 through November 2nd 2017 at the Santa Clara Convention Center in Santa Clara, California. Opsani is creating the next generation of automated continuous deployment tools designed specifically for containers. How is continuous deployment different from continuous integration and continuous delivery? CI/CD tools provide build and test. Continuous Deployment is the means by which...