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

Related Topics: Weblogic

Weblogic: Article

RMI Interoperability - In a clasloader of its own

RMI Interoperability - In a clasloader of its own

If you've had the pleasure of working with BEA WebLogic Server for several years, you may know that RMI/T3 calls between different releases of the server used to be disallowed ­ to be buzzword -compliant, the releases were not "wire compatible."

For example, you couldn't call an EJB deployed on WebLogic Server 4.5.1 from a WebLogic Server 5.1 application. This often meant that groups of applications had to be migrated together to new versions of WebLogic Server.

The lack of wire compatibility became more of a problem as users began to put increasingly sophisticated WebLogic Server configurations into production. Engineering stepped up to the mark and WebLogic Server 6.1 became the RMI/T3 "interoperability baseline" ­ interoperability between 6.1 and a number of future releases is designed into the product. New features such as Web services and enhanced RMI/IIOP also provide creative alternatives.

Not everyone has the luxury of green field sites using the latest WebLogic Server releases. In this article, I describe a scheme for sending JMS messages to both a WebLogic Server 5.1 application and a WebLogic Server 6.1 application from a single client. The approach I take is to use a special class loader that allows both versions of the RMI stack to be loaded into a single Java Virtual Machine (JVM).

A warning: you might need your propeller-head hats for some of this. I hope you come out the other side with an enhanced understanding of how class loaders work and how to use them to your advantage. The technique is not limited to addressing WebLogic Server interoperability problems; it can be applied wherever you want to load more than one version of a particular code base in a single JVM.

The full source code for this article can be found on the WLDJ Web site at www.sys-con.com/weblogic/sourcec.cfm.

So What's The Problem?
For a client to engage in RMI communication with a particular version of WebLogic Server, it must have the appropriate classes available. Usually, this means adding the WebLogic classes directory (for 5.1) or weblogic.jar (for 6.1) to the client's system classpath. The client uses these classes to communicate with the server and RMI stubs for application types are then retrieved from the server at runtime. Unfortunately, RMI classes and stubs from WebLogic Server 5.1 are not compatible with those from WebLogic Server 6.1; they can't be loaded together.

Java uses class loaders to control how classes are located and loaded into the virtual machine. Each class used by a program belongs to a class loader and, by default, a method uses its caller's class loader to load other classes. Class loaders are arranged in a hierarchy, with the Java boot, extension, and system class loaders at the top of the hierarchy. By convention, class loaders defer to their parents, meaning that when asked to load a particular class they give their parent class loader the option to load it instead. This is usually sensible; it minimizes the number of instances of a class that are loaded and allows parts of an application that use different class loaders to communicate through a set of common classes loaded by a parent class loader.

It's quite possible for a class with the same name to be loaded independently in two different class loaders and in this case the two instances are treated as distinct. By creating appropriate class loaders, you can partition parts of your application into separate "sandboxes" and ensure that classes one application component loads do not affect other components. This is what WebLogic Server 6.1 does to ensure that Web applications and enterprise applications are kept separate from one another. Refer to http://edocs.bea.com/wls/docs61/ programming/packaging.html#1048725 for details. The WebLogic Server class loader also supports dynamic loading and unloading (hot deployment) of Web applications and enterprise applications. An interesting article on writing dynamic class loaders can be found at www.javageeks.com/Papers/ClassForName/index.html.

By now, I think you can see where this is going. We should be able to load the two versions of the WebLogic Server RMI classes in separate class loaders. Our client needs to access both JNDI and JMS services from the two servers. The services are implemented differently in the two server versions, and we'll need to load two sets of the classes and stubs. We can't load everything in isolation though; the JNDI and JMS interfaces must be loaded in a single class loader so we can compose a useful program that calls both servers. Figure 1 shows the class loader hierarchy we will use.

An alternative strategy would be to load one version of the RMI classes and stubs in the same class loader as the controlling code (the main method in our example). This would be the case if you were using the technique to call out from a servlet running in one version of WebLogic Server to an Enterprise JavaBean running in another. I chose to use a distinct class loader for each version of the RMI classes because the symmetry makes the code simpler to understand. However, the class loader implementation I provide allows you to take either approach.

The Isolating Class Loader
If you've been paying attention, you might be wondering about the previous paragraph. How would a WebLogic Server 6.1 class loader work if the WebLogic Server 5.1 RMI classes were loaded in the system classpath? When asked to load a particular class, wouldn't the WebLogic Server 6.1 class loader first call the system class loader (its parent), which would erroneously load a WebLogic Server 5.1 version of the class?

This would certainly be the case for a conventional class loader, which would always defer to its parent first, but I've created an unconventional class loader, IsolatingClassloader. Each IsolatingClassloader is constructed with a list of packages and classes that it should load, and a class path that specifies where to load them from. This method is called to load a class and is shown in Listing 1.

IsolatingClassLoader first determines whether the class name is one that should be loaded in isolation, and if so, attempts to discover and load the class and make it available to the JVM. The class loader asks its parent to load the class only if the class is one that shouldn't be isolated or an implementation cannot be found.

Putting It To Work, The JMS Client
The supplied example client has four command-line parameters, the classpath and JNDI provider URL for each of the servers. Listing 2 is an example of the client running against the two servers. Note that I added the WebLogic Server 5.1 weblogicaux.jar file to the system classpath. This contains the JNDI and JMS interface classes.

To call a particular version of the server, we first construct an instance of IsolatingClassLoader that will isolate the WebLogic implementation classes (package names beginning with weblogic and COM.rsa) and set an appropriate classpath. We can then use the code in Listing 3 to call either version of the server. All that changes from server to server is the isolating class loader instance and the JNDI provider URL.

I guess you're wondering what those setContextClassLoader calls are doing? These calls set a "context class loader," which is associated with the current thread. The Java JNDI and RMI interface classes use the context class loader to determine how to load the implementation classes.

I encourage you to download the source code to see just how elegant the class loader solution is. With the exception of the IsolatingClassLoader setup and the calls to setContextClassLoader, the application code uses the standard J2EE API's.

Bridging Interface Differences
By now you can appreciate the appropriate emerging pattern when using IsolatingClassLoader to call several different versions of an implementation. Interface code is loaded in a common class loader; implementation code that needs to be isolated is loaded in its own IsolatingClassLoader. But what if the interfaces themselves vary?

In fact, this is the case for our JMS example. WebLogic Server 5.1 uses JMS 1.0.1, whereas WebLogic Server 6.1 uses JMS 1.0.2b. There are minor API differences in the handling of TopicConnections between the two versions of the JMS specification. Even if you don't create a TopicConnection, you'll run into this problem when you attempt to employ the IsolatingClassLoader technique to make WebLogic Server 5.1 JMS calls from a WebLogic Server 6.1 application. WebLogic Server 5.1 RMI performs strict type- checking that uses the stub interface and throws a ClassCastException if the local interface type does not exactly match the remote interface type. The mirror image of the scheme, with a WebLogic Server 6.1 IsolatingClassLoader embedded in a WebLogic Server 5.1 server, works fine because WebLogic Server 6.1 RMI uses dynamic proxies and is more relaxed about the API differences.

All is not lost. I've successfully extended the IsolatingClassLoader pattern to address this problem. I don't have room to cover the full solution here, but I will briefly describe it. I used a proxy object, residing in the common WebLogic Server 6.1 class loader, which maps JMS 1.0.2b calls to a neutral interface (a subset of the JMS 1.0.1 and 1.0.2b interfaces). A second proxy object, which is loaded by the WebLogic Server 5.1 IsolatingClassLoader, maps calls from the neutral interface to the JMS 1.0.1 interface. I managed to hide this implementation from application code by binding the entry points of the interfaces (connection factories) into the WebLogic Server 6.1 JNDI tree. Look out for this trick in the JMS Bridge that comes with the next release of WebLogic Server.

That's all for this month. I hope I've given you a different perspective on Java class loaders, and that you'll find it useful when wiring WebLogic Server applications together. Till the next time…

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
As businesses evolve, they need technology that is simple to help them succeed today and flexible enough to help them build for tomorrow. Chrome is fit for the workplace of the future — providing a secure, consistent user experience across a range of devices that can be used anywhere. In her session at 21st Cloud Expo, Vidya Nagarajan, a Senior Product Manager at Google, will take a look at various options as to how ChromeOS can be leveraged to interact with people on the devices, and formats th...
SYS-CON Events announced today that Yuasa System 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. Yuasa System is introducing a multi-purpose endurance testing system for flexible displays, OLED devices, flexible substrates, flat cables, and films in smartphones, wearables, automobiles, and healthcare.
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 SourceForge has been named “Media 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. SourceForge is the largest, most trusted destination for Open Source Software development, collaboration, discovery and download on the web serving over 32 million viewers, 150 million downloads and over 460,000 active development projects each and every month.
SYS-CON Events announced today that Nihon Micron 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. Nihon Micron Co., Ltd. strives for technological innovation to establish high-density, high-precision processing technology for providing printed circuit board and metal mount RFID tags used for communication devices. For more inf...
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 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.
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.
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...
SYS-CON Events announced today that Massive Networks, that helps your business operate seamlessly with fast, reliable, and secure internet and network solutions, has been named "Exhibitor" 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. As a premier telecommunications provider, Massive Networks is headquartered out of Louisville, Colorado. With years of experience under their belt, their team of...
SYS-CON Events announced today that IBM has been named “Diamond Sponsor” of 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.
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.
SYS-CON Events announced today that TidalScale 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 is the leading provider of Software-Defined Servers that bring flexibility to modern data centers by right-sizing servers on the fly to fit any data set or workload. TidalScale’s award-winning inverse hypervisor technology combines multiple commodity servers (including their ass...
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...
As popularity of the smart home is growing and continues to go mainstream, technological factors play a greater role. The IoT protocol houses the interoperability battery consumption, security, and configuration of a smart home device, and it can be difficult for companies to choose the right kind for their product. For both DIY and professionally installed smart homes, developers need to consider each of these elements for their product to be successful in the market and current smart homes.
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, will lead you through the exciting evolution of the cloud. He'll look 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 ...
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...
In a recent survey, Sumo Logic surveyed 1,500 customers who employ cloud services such as Amazon Web Services (AWS), Microsoft Azure, and Google Cloud Platform (GCP). According to the survey, a quarter of the respondents have already deployed Docker containers and nearly as many (23 percent) are employing the AWS Lambda serverless computing framework. It’s clear: serverless is here to stay. The adoption does come with some needed changes, within both application development and operations. Tha...