Welcome!

Java IoT Authors: Elizabeth White, Pat Romanski, David Bermingham, Charlotte Spencer-Smith, Tim Hinds

Related Topics: Java IoT

Java IoT: Article

Improved Observer/ Observable

Improved Observer/ Observable

The Observer Design Pattern is among the most useful for object-oriented software design. The JDK itself makes heavy use of a variant of this pattern in the 1.1 AWT event delegation model. The JDK also provides a reusable embodiment of the pattern in the form of the java.util.Observer interface and the java.util.Observable class. If you've done much serious Java programming you've more than likely had occasion to use these classes.

The idea of the pattern is to model a one-to-many dependency without tightly coupling the observed object with its many observers. When the observed object changes in some interesting way it can automatically notify all of its observers without knowing them directly. For more on this pattern, see Qusay Mahmoud's article, "Implementing Design Patterns in Java" (JDJ, Vol. 2, Iss. 5), or the Design Patterns book.

Unfortunately, a number of weaknesses have been identified in the JDK's Observer/Observable classes. Peter Coad and Mark Mayfield discuss some of these weaknesses in their excellent book, Java Design. These weaknesses significantly limit the reusability and power of the classes, which is a shame since powerful reusability is a big part of what object-oriented design is all about.

Most of the weaknesses are due to the fact that java.util.Observable is a class rather than an interface; or rather, that it is a class without a corresponding interface. This implies that the only way to reuse Observable is to subclass it. You can't take an existing class and tack on the role of Observable by having it implement an Observable interface because there is no Observable interface.

What if you have a class that is already in a class hierarchy and also needs to play the role of an Observable? Since Java doesn't support multiple inheritance, you're out of luck. That class cannot extend from Observable because it is already extending from some other class.

It also means that you are stuck with the one and only implementation of Observable in java.util.Observable. For a variety of reasons, you may want to use an alternate implementation - e.g., to do the notification in a separate thread or in a particular order. You may even want to vary the implementation of Observable at runtime. There is no Observable interface for your alternate implementations to implement. You cannot reuse Observable by composition so you cannot vary the composed Observable implementation at runtime.

The designers of the Observable class broke two general principles of object-oriented design with Java. The first principle is to design with interfaces rather than classes. Whenever possible, avoid committing yourself to a particular implementation of an interface. The second principle is to favor reuse by composition over reuse by inheritance unless a class hierarchy is clearly indicated. By omitting an Observable interface and making some of its methods protected, the designers made it impossible to reuse Observable by composition.

A minor weakness in Observable is the necessity to call setChanged() before notifySubscribers(). The intention there seems to be to eliminate needless notifications in cases where there is no interesting change to the Observable. There may be situations in which this two-stage notification is appropriate, but it isn't the simplest case and programmers shouldn't be forced to use this implementation in all situations. Also, setChanged() is protected, further reinforcing the necessity to reuse the class only by inheritance.

Now let's look at the Observer interface. The weakness here is its tight coupling with the Observable class. The first parameter to the update() method is unnecessarily typed as an Observable. If it were typed more generally as a simple Object, the Observer interface would be more reusable. It then could be used with any Observable implementation or even in any situation, completely unrelated to Observer/Observable, which called for a void method with two Object parameters.

Despite all these weaknesses, I was initially reluctant to ignore the JDK classes in favor of the homegrown replacements suggested by Coad and Mayfield. After all, the JDK classes are already locally available to every VM and they do serve their purpose nicely for the majority of cases. On the other hand, designing for maximal reuse is crucial to the success of any object-oriented design. A little forethought early in the game can lead to great savings down the road. Luckily, when I started a new project some months ago, I decided to take the plunge and start using the improved classes.

More recently I began designing a number of distributed three-tier Java apps using Remote Method Invocation (RMI). It turns out that the Observer pattern has great application to remote applications. A remote object that lives on the server often needs to be observed by multiple objects living on multiple clients. When the remote object changes, all clients need to find out in order to, for example, update the user's view.

The JDK's Observer/Observable classes are of no use here. They do not extend from java.rmi.Remote and their method signatures do not allow for the possible throwing of RemoteException. Both of these are required of any Remote interface for RMI. So the JDK's Observable/Observer classes can never be implemented as an RMI remote interface of a RemoteObject.

The solution that I've seen in articles and books is to write a separate set of classes for Remote Observable/Observer. This always seemed wrong to me. Why should I have to write, support and use two disjoint sets of classes to do basically the same thing albeit in different situations? What if I have a class that needs to notify both local and remote Observers? You mean it has to implement both versions of Observable?!

Having already severed my dependence on the JDK's Observable classes, I was able to painlessly enhance my classes to support Remote Method Invocation. The same classes can now be used for local Observers as well as remote Observers or even for a mixture of remote and local Observers.

The interfaces are shown in Listing 1. In order to avoid confusion with the JDK classes, I use the synonymous terminology of Publisher/Subscriber rather than Observable/Observer.

Notice that the Publisher and Subscriber interfaces extend from java.rmi.Remote and all their methods may throw RemoteException. This is so that these interfaces may be implemented by remote classes for use with RMI. These additions do not preclude these classes from being used in a strictly local situation without RMI. In fact, the same Publisher could be used to publish to a mixture of local and remote Subscribers.

A simple basic implementation of Publisher is presented in Listing 2. This Publisher can be used for both local and remote Subscribers.

The notifySubscribers() method deserves some elaboration. The call to the Subscribers' update() method is in a try/catch clause to deal with possibly thrown RemoteExceptions. Two particular RemoteExceptions, ConnectException and NoSuchObjectException, are considered serious enough to consider the Subscriber to be dead. Subscribers that are considered dead are removed from the list of Subscribers for this Publisher. Other RemoteExceptions may be indications of transient failures that could correct themselves. This is the type of fuzzy logic you need to apply in networked situations where errors are unpredictable and non-deterministic.

The dead Subscribers are not removed from the list of Subscribers until after the list is enumerated. At first glance you might ask, why not remove the dead Observers right away, within the catch clauses? This is because of a quirk in java.util.Vector that makes it unsafe to manipulate a Vector while it is being enumerated. This quirk (bug?) is a discussion for another time, but a few words about the workaround I chose are warranted here.

As I discover Subscribers that are to be considered dead, I accumulate them in a Vector. Only after enumeration of all Subscribers do I go through the Vector of dead Subscribers and actually remove them. Another workaround that I could have used is to clone the Vector of Subscribers before enumerating it. Then I could operate on the original Vector while enumerating the clone. I chose the workaround I did because it has little overhead for the more usual case when no RemoteException is thrown. Even the deadSubs Vector is not allocated until and unless it is needed. This technique is known as lazy instantiation.

The preferred way to reuse BasicPublisher is by composition. Any class that needs to play the role of a Publisher should implement the Publisher interface and include a reference to an instance of BasicPublisher to do the work of a Publisher. Listing 3 is a rough outline of this.

Class XX is free to extend from some other class if it needs to and it can publish changes to subscribers, whether local or remote, by calling pub.notifySubscribers(). You can also reuse BasicPublisher by subclassing it, but this is not the preferred way. It eliminates the need to delegate the Publisher interface but it reduces the extendibility of the class because the class can no longer be a subclass of any other class.

To use these classes with RMI, the classes that implement Publisher and Subscriber must be remote objects. Without going into too much detail on RMI, let me just point out that any class can be made remote in two simple steps. First, add the following to its constructor:

UnicastRemoteObject.exportObject(this);

and recompile. Second, run the rmic post compiler on the class. That's it. Your class is now remote. Remote publishers can now publish changes to local subscribers in the same VM or to remote subscribers in other VMs.

In summary, these two interfaces and class constitute a far more powerful and reusable embodiment of the Observer design pattern than the JDK's Observer/Observable. They can even be used for remote Observers with RMI. This is just the sort of weapon in your object-oriented arsenal that makes Java programming such a joy.

References
Gamma, E., Johnson, R. and Vlissides, J., "Design Patterns: Elements of Object-Oriented Architecture", Addison-Wesley, Reading, MA, 1995.
Coad , P. and Mayfield, M., "Java Design: Building Better Apps and Applets", Yourdon Press, Upper Saddle River, NJ, 1997.

More Stories By Steven Schwell

Steven Schwell is a Senior Developer and Java Guru in the New York office of Micromuse, Inc., a leading provider of Service Level Management software. Steve is currently developing a number of large distributed Java apps. He holds a M.S. in Computer Science from Columbia University.

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
With an estimated 50 billion devices connected to the Internet by 2020, several industries will begin to expand their capabilities for retaining end point data at the edge to better utilize the range of data types and sheer volume of M2M data generated by the Internet of Things. In his session at @ThingsExpo, Don DeLoach, CEO and President of Infobright, will discuss the infrastructures businesses will need to implement to handle this explosion of data by providing specific use cases for filte...
Fortunately, meaningful and tangible business cases for IoT are plentiful in a broad array of industries and vertical markets. These range from simple warranty cost reduction for capital intensive assets, to minimizing downtime for vital business tools, to creating feedback loops improving product design, to improving and enhancing enterprise customer experiences. All of these business cases, which will be briefly explored in this session, hinge on cost effectively extracting relevant data from ...
SYS-CON Events announced today that VAI, a leading ERP software provider, will exhibit at SYS-CON's 18th International Cloud Expo®, which will take place on June 7-9, 2016, at the Javits Center in New York City, NY. VAI (Vormittag Associates, Inc.) is a leading independent mid-market ERP software developer renowned for its flexible solutions and ability to automate critical business functions for the distribution, manufacturing, specialty retail and service sectors. An IBM Premier Business Part...
SYS-CON Events announced today that Alert Logic, Inc., the leading provider of Security-as-a-Service solutions for the cloud, will exhibit at SYS-CON's 18th International Cloud Expo®, which will take place on June 7-9, 2016, at the Javits Center in New York City, NY. Alert Logic, Inc., provides Security-as-a-Service for on-premises, cloud, and hybrid infrastructures, delivering deep security insight and continuous protection for customers at a lower cost than traditional security solutions. Ful...
SYS-CON Events announced today that Interoute, owner-operator of one of Europe's largest networks and a global cloud services platform, has been named “Bronze Sponsor” of SYS-CON's 18th Cloud Expo, which will take place on June 7-9, 2015 at the Javits Center in New York, New York. Interoute is the owner-operator of one of Europe's largest networks and a global cloud services platform which encompasses 12 data centers, 14 virtual data centers and 31 colocation centers, with connections to 195 ad...
As enterprises work to take advantage of Big Data technologies, they frequently become distracted by product-level decisions. In most new Big Data builds this approach is completely counter-productive: it presupposes tools that may not be a fit for development teams, forces IT to take on the burden of evaluating and maintaining unfamiliar technology, and represents a major up-front expense. In his session at @BigDataExpo at @ThingsExpo, Andrew Warfield, CTO and Co-Founder of Coho Data, will dis...
SYS-CON Events announced today that Commvault, a global leader in enterprise data protection and information management, has been named “Bronze Sponsor” of SYS-CON's 18th International Cloud Expo, which will take place on June 7–9, 2016, at the Javits Center in New York City, NY, and the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Commvault is a leading provider of data protection and information management...
The cloud promises new levels of agility and cost-savings for Big Data, data warehousing and analytics. But it’s challenging to understand all the options – from IaaS and PaaS to newer services like HaaS (Hadoop as a Service) and BDaaS (Big Data as a Service). In her session at @BigDataExpo at @ThingsExpo, Hannah Smalltree, a director at Cazena, will provide an educational overview of emerging “as-a-service” options for Big Data in the cloud. This is critical background for IT and data profes...
With the Apple Watch making its way onto wrists all over the world, it’s only a matter of time before it becomes a staple in the workplace. In fact, Forrester reported that 68 percent of technology and business decision-makers characterize wearables as a top priority for 2015. Recognizing their business value early on, FinancialForce.com was the first to bring ERP to wearables, helping streamline communication across front and back office functions. In his session at @ThingsExpo, Kevin Roberts...
SYS-CON Events announced today that Fusion, a leading provider of cloud services, will exhibit at SYS-CON's 18th International Cloud Expo®, which will take place on June 7-9, 2016, at the Javits Center in New York City, NY. Fusion, a leading provider of integrated cloud solutions to small, medium and large businesses, is the industry's single source for the cloud. Fusion's advanced, proprietary cloud service platform enables the integration of leading edge solutions in the cloud, including clou...
Most people haven’t heard the word, “gamification,” even though they probably, and perhaps unwittingly, participate in it every day. Gamification is “the process of adding games or game-like elements to something (as a task) so as to encourage participation.” Further, gamification is about bringing game mechanics – rules, constructs, processes, and methods – into the real world in an effort to engage people. In his session at @ThingsExpo, Robert Endo, owner and engagement manager of Intrepid D...
Eighty percent of a data scientist’s time is spent gathering and cleaning up data, and 80% of all data is unstructured and almost never analyzed. Cognitive computing, in combination with Big Data, is changing the equation by creating data reservoirs and using natural language processing to enable analysis of unstructured data sources. This is impacting every aspect of the analytics profession from how data is mined (and by whom) to how it is delivered. This is not some futuristic vision: it's ha...
WebRTC has had a real tough three or four years, and so have those working with it. Only a few short years ago, the development world were excited about WebRTC and proclaiming how awesome it was. You might have played with the technology a couple of years ago, only to find the extra infrastructure requirements were painful to implement and poorly documented. This probably left a bitter taste in your mouth, especially when things went wrong.
Learn how IoT, cloud, social networks and last but not least, humans, can be integrated into a seamless integration of cooperative organisms both cybernetic and biological. This has been enabled by recent advances in IoT device capabilities, messaging frameworks, presence and collaboration services, where devices can share information and make independent and human assisted decisions based upon social status from other entities. In his session at @ThingsExpo, Michael Heydt, founder of Seamless...
The IoT's basic concept of collecting data from as many sources possible to drive better decision making, create process innovation and realize additional revenue has been in use at large enterprises with deep pockets for decades. So what has changed? In his session at @ThingsExpo, Prasanna Sivaramakrishnan, Solutions Architect at Red Hat, discussed the impact commodity hardware, ubiquitous connectivity, and innovations in open source software are having on the connected universe of people, thi...
WebRTC: together these advances have created a perfect storm of technologies that are disrupting and transforming classic communications models and ecosystems. In his session at WebRTC Summit, Cary Bran, VP of Innovation and New Ventures at Plantronics and PLT Labs, provided an overview of this technological shift, including associated business and consumer communications impacts, and opportunities it may enable, complement or entirely transform.
For manufacturers, the Internet of Things (IoT) represents a jumping-off point for innovation, jobs, and revenue creation. But to adequately seize the opportunity, manufacturers must design devices that are interconnected, can continually sense their environment and process huge amounts of data. As a first step, manufacturers must embrace a new product development ecosystem in order to support these products.
There are so many tools and techniques for data analytics that even for a data scientist the choices, possible systems, and even the types of data can be daunting. In his session at @ThingsExpo, Chris Harrold, Global CTO for Big Data Solutions for EMC Corporation, showed how to perform a simple, but meaningful analysis of social sentiment data using freely available tools that take only minutes to download and install. Participants received the download information, scripts, and complete end-t...
Manufacturing connected IoT versions of traditional products requires more than multiple deep technology skills. It also requires a shift in mindset, to realize that connected, sensor-enabled “things” act more like services than what we usually think of as products. In his session at @ThingsExpo, David Friedman, CEO and co-founder of Ayla Networks, discussed how when sensors start generating detailed real-world data about products and how they’re being used, smart manufacturers can use the dat...
When it comes to IoT in the enterprise, namely the commercial building and hospitality markets, a benefit not getting the attention it deserves is energy efficiency, and IoT’s direct impact on a cleaner, greener environment when installed in smart buildings. Until now clean technology was offered piecemeal and led with point solutions that require significant systems integration to orchestrate and deploy. There didn't exist a 'top down' approach that can manage and monitor the way a Smart Buildi...