Welcome!

You will be redirected in 30 seconds or close now.

ColdFusion Authors: Yakov Fain, Jeremy Geelan, Maureen O'Gara, Nancy Y. Nee, Tad Anderson

Related Topics: ColdFusion

ColdFusion: Article

Designing ColdFusion Applications for Deployment as EAR Files

There are benefits for everyone

Enterprise Application aRchive (EAR) files are a standard and portable manner for packaging applications to be deployed on J2EE application servers, such as Adobe JRun, BEA WebLogic, and IBM WebSphere. An EAR file is, in essence, just a big ZIP file with a special layout of the directory tree inside that contains a full application, see the following code. EAR files have a well-defined format and make Java bytecode truly portable. The same EAR file that we compile and build on our i386 Windows laptop can also run on a 64-CPU mainframe running commercial Unix.

Directory Structure of an EAR file application.ear

  • META-INF
  • application.xml
  • contextroot.war
  • CFML source
  • HTML sources
  • CSS
  • images
  • WEB-INF
  • web.xml
  • ColdFusion runtime
As you can see from this directory structure, an EAR file deployment for a ColdFusion application can include both the CFML source code that you write and a complete ColdFusion server runtime. It's important to note that even when stripped of all documentation and images, an EAR file can be quite large - over 50 MB, not including your source code.

In this article you will learn why it is beneficial to deliver your ColdFusion applications using EAR files. We will also explain what to watch out for when you design applications that you are planning to deliver in an EAR file.

Requirements
ColdFusion MX 7 Enterprise
To try, go to http://www.adobe.com/go/devcenter_cf_try, and to buy, go to: www.adobe.com/go/devcenter_cf_buy.

Note: You will need to install the ColdFusion multiserver installation. This option is available in the licensed Enterprise Edition, the Developer Edition, or in the 30-day trial edition of ColdFusion MX 7. This requires that you download the trial or purchase the Enterprise, Evaluation, or Developer Edition. You must select "multiserver configuration" during the installation process.

Apache Ant
Download Apache Ant from http://ant.apache.org/.

Prerequisite Knowledge

  • Basic understanding of ColdFusion
  • Basic J2EE knowledge
Advantages of EAR Files
There are many reasons for using EAR files to deploy ColdFusion applications for your customers. Not all are applicable to all customers, but there are generally benefits for everyone.

On the business side, J2EE is a standard technology that has a lot of traction. If your customers already have a J2EE environment, ColdFusion will fit in without changes to their infrastructure. If you want, you can even position ColdFusion as a 4GL language for rapid application development. All that the server administrator sees is an EAR file; it may be big but an EAR file is like any other EAR file. This advantage can open a whole new market that was previously the exclusive domain of Java shops.

On the technical side, EAR files can provide more than just a format for delivering your code. Because EAR files can include the complete ColdFusion runtime, you can also package additional components like database drivers and preconfigured ColdFusion runtime settings. This means you can deliver your application to your customer with far fewer instructions for installation and configuration - greatly reducing the risk of a deployment error.

Combined with the J2EE underpinnings, using EAR files makes it easier to deploy your application in more than one instance on one or more servers. You also have the option to combine these instances into a cluster that provides fault-tolerance and increases the scalability of the application you are deploying.

From a support standpoint, we have all been there: a customer reports that the latest patch doesn't work. After several hours of frantic debugging, you discover that the issue is that the customer never installed a previous patch. However, if you deliver your application as an EAR file, you can ensure that the customer has installed the latest version of every file because each EAR file you deliver contains the entire application.

Challenges to Deploying Applications as EAR Files
There are challenges to delivering your application as an EAR file. Some of the aforementioned advantages can, in other contexts, become disadvantages. For instance, because all the code is compiled and packaged in the EAR file, the customer cannot tinker with it. This also means that you cannot tinker with it after preparing it. If you frequently have to add last-minute, one-line adjustments to your code during deployment, you might find yourself at a disadvantage.

Likewise, creating EAR files requires that you own the ColdFusion Enterprise Edition. You can still develop and build your application using ColdFusion Developer Edition on your local host, but for deployment you must own an Enterprise Edition license for every two CPUs on which you deploy your application. EAR deployments will not work on ColdFusion Standard Edition.

The biggest challenge is how your application interacts with its environment. Because you are delivering a self-contained application, you must be sure to put everything in the EAR file - code, HTML, CSS, additional components, and so forth. Deploying the application should require as little configuration as possible, both to make it easier for your customer and to reduce the chance of something going wrong.

For interaction with the Web server, the most important issue is that you pick the right context-root. The context-root is the subdirectory under which the application is located. By selecting different context-roots, you can deploy multiple applications on one Website. Putting your application in a subdirectory also enables you to handle uploaded user content gracefully (such as avatars on a forum): you can upload them to a sibling directory of the application so the Web server can process them directly. Don't be greedy and use / as the context-root. Because you don't know if the person who deploys your application is going to use an empty J2EE server instance or not, you should develop your application to always run inside a context-root. All paths in your application should be relative to this context-root. When you create your application, choose a context-root so that the name is unique on the deployment server; don't use any common names, such as "admin."

Some of the challenges require you to think about your application in a whole new way. When you package your application as an EAR file, the J2EE server has to expand the application before it can run it. Some J2EE servers, like JRun, do so automatically, which adds some overhead the first time it starts. Others, like WebSphere, require the server administrator to expand the EAR file manually when deploying on it. J2EE servers that expand the EAR file automatically do so to a temporary directory and start the application from there.

One side-effect of this is that the application no longer knows where the EAR file is located; the application knows only the temporary directory to which it was extracted. As a result, when you change something using the ColdFusion Administrator, it ends up in the temporary directory and not in the EAR file. Therefore, if the server administrator moves the EAR file from one server to another, the application will lose any changes that you have made using the ColdFusion Administrator. Even worse, if the operating system deletes all temporary files upon reboot, you will lose all your changes to the ColdFusion Administrator just by rebooting the system. Luckily, this is largely a theoretical problem. Still, if possible, deploy your application as an expanded EAR file. Be mindful of this issue, because even when deploying an expanded EAR file, it will affect your settings when the server administrator moves the EAR or you release a new version.

Another way this becomes a problem is in the use of ColdFusion mappings. When ColdFusion starts from the temporary directory, it automatically updates its internal mapping to CFIDE to point to the temporary directory from which it is executed. All the other mappings will not be updated, however.


More Stories By Jochem van Dieten

Jochem van Dieten is longtime ColdFusion developer and Adobe Community Expert (formerly Team Macromedia) member for ColdFusion. He is currently working on delivery automation and black-box testing at Prisma IT (www.prisma-it.com).

More Stories By Mark van Hedel

Mark van Hedel is an Advanced Certified ColdFusion MX7 Developer and MCI at Prisma IT. He is currently working on automating the ColdFusion development process and creating object-driven applications.

Comments (1) View Comments

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.


Most Recent Comments
SYS-CON Brazil News Desk 06/28/06 03:43:51 PM EDT

Enterprise Application archive (EAR) files are a standard and portable manner for packaging applications to be deployed on J2EE application servers, such as Adobe JRun, BEA WebLogic, and IBM WebSphere. An EAR file is, in essence, just a big ZIP file with a special layout of the directory tree inside that contains a full application, see the following code. EAR files have a well-defined format and make Java bytecode truly portable. The same EAR file that we compile and build on our i386 Windows laptop can also run on a 64-CPU mainframe running commercial Unix.

@ThingsExpo Stories
"When we talk about cloud without compromise what we're talking about is that when people think about 'I need the flexibility of the cloud' - it's the ability to create applications and run them in a cloud environment that's far more flexible,” explained Matthew Finnie, CTO of Interoute, in this SYS-CON.tv interview at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
The Internet giants are fully embracing AI. All the services they offer to their customers are aimed at drawing a map of the world with the data they get. The AIs from these companies are used to build disruptive approaches that cannot be used by established enterprises, which are threatened by these disruptions. However, most leaders underestimate the effect this will have on their businesses. In his session at 21st Cloud Expo, Rene Buest, Director Market Research & Technology Evangelism at Ara...
No hype cycles or predictions of zillions of things here. IoT is big. 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, Associate Partner at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He discussed the evaluation of communication standards and IoT messaging protocols, data analytics considerations, edge-to-cloud tec...
New competitors, disruptive technologies, and growing expectations are pushing every business to both adopt and deliver new digital services. This ‘Digital Transformation’ demands rapid delivery and continuous iteration of new competitive services via multiple channels, which in turn demands new service delivery techniques – including DevOps. In this power panel at @DevOpsSummit 20th Cloud Expo, moderated by DevOps Conference Co-Chair Andi Mann, panelists examined how DevOps helps to meet the de...
When growing capacity and power in the data center, the architectural trade-offs between server scale-up vs. scale-out continue to be debated. Both approaches are valid: scale-out adds multiple, smaller servers running in a distributed computing model, while scale-up adds fewer, more powerful servers that are capable of running larger workloads. It’s worth noting that there are additional, unique advantages that scale-up architectures offer. One big advantage is large memory and compute capacity...
With major technology companies and startups seriously embracing Cloud strategies, now is the perfect time to attend 21st Cloud Expo October 31 - November 2, 2017, at the Santa Clara Convention Center, CA, and June 12-14, 2018, at the Javits Center in New York City, NY, and learn what is going on, contribute to the discussions, and ensure that your enterprise is on the right path to Digital Transformation.
Amazon started as an online bookseller 20 years ago. Since then, it has evolved into a technology juggernaut that has disrupted multiple markets and industries and touches many aspects of our lives. It is a relentless technology and business model innovator driving disruption throughout numerous ecosystems. Amazon’s AWS revenues alone are approaching $16B a year making it one of the largest IT companies in the world. With dominant offerings in Cloud, IoT, eCommerce, Big Data, AI, Digital Assista...
Artificial intelligence, machine learning, neural networks. We’re in the midst of a wave of excitement around AI such as hasn’t been seen for a few decades. But those previous periods of inflated expectations led to troughs of disappointment. Will this time be different? Most likely. Applications of AI such as predictive analytics are already decreasing costs and improving reliability of industrial machinery. Furthermore, the funding and research going into AI now comes from a wide range of com...
Internet of @ThingsExpo, taking place October 31 - November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 21st Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The Internet of Things (IoT) is the most profound change in personal and enterprise IT since the creation of the Worldwide Web more than 20 years ago. All major researchers estimate there will be tens of billions devic...
We build IoT infrastructure products - when you have to integrate different devices, different systems and cloud you have to build an application to do that but we eliminate the need to build an application. Our products can integrate any device, any system, any cloud regardless of protocol," explained Peter Jung, Chief Product Officer at Pulzze Systems, in this SYS-CON.tv interview at @ThingsExpo, held November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA
SYS-CON Events announced today that Ayehu will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on October 31 - November 2, 2017 at the Santa Clara Convention Center in Santa Clara California. Ayehu provides IT Process Automation & Orchestration solutions for IT and Security professionals to identify and resolve critical incidents and enable rapid containment, eradication, and recovery from cyber security breaches. Ayehu provides customers greater control over IT infras...
SYS-CON Events announced today that MobiDev, a client-oriented software development company, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place October 31-November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. MobiDev is a software company that develops and delivers turn-key mobile apps, websites, web services, and complex software systems for startups and enterprises. Since 2009 it has grown from a small group of passionate engineers and business...
SYS-CON Events announced today that GrapeUp, the leading provider of rapid product development at the speed of business, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place October 31-November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Grape Up is a software company, specialized in cloud native application development and professional services related to Cloud Foundry PaaS. With five expert teams that operate in various sectors of the market acr...
SYS-CON Events announced today that Enzu will exhibit at SYS-CON's 21st Int\ernational Cloud Expo®, which will take place October 31-November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Enzu’s mission is to be the leading provider of enterprise cloud solutions worldwide. Enzu enables online businesses to use its IT infrastructure to their competitive advantage. By offering a suite of proven hosting and management services, Enzu wants companies to focus on the core of their ...
SYS-CON Events announced today that Cloud Academy named "Bronze Sponsor" of 21st International Cloud Expo which will take place October 31 - November 2, 2017 at the Santa Clara Convention Center in Santa Clara, CA. Cloud Academy is the industry’s most innovative, vendor-neutral cloud technology training platform. Cloud Academy provides continuous learning solutions for individuals and enterprise teams for Amazon Web Services, Microsoft Azure, Google Cloud Platform, and the most popular cloud com...
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.
In his session at Cloud Expo, Alan Winters, an entertainment executive/TV producer turned serial entrepreneur, presented a success story of an entrepreneur who has both suffered through and benefited from offshore development across multiple businesses: The smart choice, or how to select the right offshore development partner Warning signs, or how to minimize chances of making the wrong choice Collaboration, or how to establish the most effective work processes Budget control, or how to ma...
SYS-CON Events announced today that CA Technologies has been named "Platinum Sponsor" of SYS-CON's 21st International Cloud Expo®, which will take place October 31-November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. CA Technologies helps customers succeed in a future where every business - from apparel to energy - is being rewritten by software. From planning to development to management to security, CA creates software that fuels transformation for companies in the applic...
Multiple data types are pouring into IoT deployments. Data is coming in small packages as well as enormous files and data streams of many sizes. Widespread use of mobile devices adds to the total. In this power panel at @ThingsExpo, moderated by Conference Chair Roger Strukhoff, panelists looked at the tools and environments that are being put to use in IoT deployments, as well as the team skills a modern enterprise IT shop needs to keep things running, get a handle on all this data, and deliver...
In his session at @ThingsExpo, Eric Lachapelle, CEO of the Professional Evaluation and Certification Board (PECB), provided an overview of various initiatives to certify the security of connected devices and future trends in ensuring public trust of IoT. Eric Lachapelle is the Chief Executive Officer of the Professional Evaluation and Certification Board (PECB), an international certification body. His role is to help companies and individuals to achieve professional, accredited and worldwide re...