Blog

Michael Born

June 14, 2022

Spread the word


Share your thoughts

CFML makes it simple to instantiate and use native Java classes without leaving CFML-land. For example, we can use Java's SimpleDateFormat library to format a date object:

var dateFormatter = createObject( "java", "java.text.SimpleDateFormat" );
var formattedDate = dateFormatter.init( "yyyy-MM-dd'T'HH:mm: ssXXX" ).format( now() );

In order to use a third-party java library, however, such as the Jsoup HTML parser, you will need to load the jar into the CFML engine first.

There are two main ways to load a Java jar into CFML app:

  1. Using native CFML
  2. Using Javaloader

Loading Jars with native CFML

Add this to your web root's Application.cfc:

// Java Integration
this.javaSettings = {
   loadPaths               : [ expandPath( "./lib" ) ],
   loadColdFusionClassPath : true,
   reloadOnChange          : false
};

Then add the .jar file to the lib/ directory.

Once this is done, you can use the jar like this:

function getWikipediaPage(){
   var Jsoup = createObject( "java", "org.jsoup.Jsoup" );
   return Jsoup
      .connect( "https://en.wikipedia.org/wiki/The_Lord_of_the_Rings_(film_series)" )
      .get()
      .body()
      .text();
}

Loading Jars with JavaLoader

Javaloader is a CFML tool for loading java .jar files into your CFML application. Javaloader offers an improved developer experience, as there is no need to adjust application settings or restart the server after installation. With Javaloader, you can ship your dependencies with a module or library, and it "just works" without requiring further configuration.

box install cbjavaloader

Once javaloader installs, you can inject the Jsoup library into your components using the custom Javaloader syntax for Wirebox:

component{
    property name="Jsoup" inject="javaloader:org.jsoup.Jsoup";
    // ...
}

Once we’ve injected Jsoup, we can use Jsoup to fetch and parse the Wikipedia page for the LOTR film series:

function getWikipediaPage(){
   return Jsoup
      .connect( "https://en.wikipedia.org/wiki/The_Lord_of_the_Rings_(film_series)" )
      .get()
      .body()
      .text();
}

And that's how you use the Java "Jsoup" library in CFML!

Add Your Comment

(5)

Jun 15, 2022 00:42:47 UTC

by Charlie Arehart

Thanks, Michael. Always helpful for folks to be reminded of such things. That said, you could/should mention how lucee offers yet another option, in that you can name the library/jar as an arg to the createobject/cfobject. I do hope that someday Adobe will adopt that. Finally, somehow in the formatting of the code examples, the first one for application.cfc has the this.javasetting mashed into the opening comment: // Java Integrationthis.javaSettings (If anyone corrects that, feel free to delete this part of my comment, starting with "finally".)

Jun 15, 2022 00:49:45 UTC

by Anthony Ehrhardt

Which is better? And why would one use javaLoader over native CFML?

Jun 15, 2022 01:44:09 UTC

by Anthony Ehrhardt

Which is better? And why would one use javaLoader over native CFML?

Jun 16, 2022 14:21:33 UTC

by Michael Born

@anthony > Which is better? And why would one use javaLoader over native CFML? Read the paragraph under "Loading Jars with JavaLoader": > ...Javaloader offers an improved developer experience, as there is no need to adjust application settings or restart the server after installation. With Javaloader, you can ship your dependencies with a module or library, and it "just works" without requiring further configuration.

Jun 16, 2022 14:29:44 UTC

by Michael Born

@charlie - Good catch, thank you! I fixed the formatting on that code snippet. Yes, the post should probably mention Lucee's createObject() jar parameter. I avoided that to keep it simple, and because Ortus tends to focus on writing cross-engine compatible code. But agencies and companies building on Lucee only would certainly benefit from such a feature.

Recent Entries

Partner with BoxLang and Ortus at Into the Box 2025: Empowering the Future of Modern Software Development!

Partner with BoxLang and Ortus at Into the Box 2025: Empowering the Future of Modern Software Development!

At Ortus Solutions, we’ve always been at the forefront of innovation in the ColdFusion ecosystem. From pioneering modern ColdFusion practices to developing cutting-edge tools and frameworks, we’ve been passionate to help and sup[port the community into shaping the future of web development.That’s why we decided to build BoxLang, our new JVM programming language that not only builds on the strengths of ColdFusion but takes modern software development to the next level.

Maria Jose Herrera
Maria Jose Herrera
December 23, 2024
Why BoxLang When You Have Kotlin, Groovy, Scala, and more…

Why BoxLang When You Have Kotlin, Groovy, Scala, and more…

As we approach a stable release of BoxLang and our continued marketing reaches more folks, many have asked about its purpose. Why create a new language when the JVM ecosystem already includes established languages like Kotlin, Groovy, and Scala, to name a few.

Luis Majano
Luis Majano
December 18, 2024