Friday, September 2, 2016

Using the JRebel class loading tool with ADF projects

The JRebel tool, available from Zeroturnaround, is a class loading tool. It allows java class file changes to be loaded without any redeploys or restarts; it does this by extending the class loader and instrumenting classes. It not only will load changes to method bodies, but new methods, changes to interfaces, adding fields and enum values, and even property bundle changes.

It is a "java agent" plugin, available for Java 5+. They have many plugins for various frameworks (e.g. Groovy, Hibernate, myfaces, RESTEasy, Spring, Struts, Velocity), but it is the ADF one that caught my interest. I'll be focusing on how to install on a Windows desktop with JDeveloper, using the Integrated Weblogic. Other setups can likely be accommodated with little changes.

The really cool part for ADF developers though is that is also has the ability to handle changes to things like pagedef files, Application Module definitions and View Object definitions. This obviously comes in extremely handy. It is not free, but the licenses are pretty cheap. One important thing to note: JRebel doesn't magically know that you changed a java source file - it works by comparing dates on monitored folders. This means that you have to do a 'make' on your project so the .class file is updated. Usually this is relatively fast.

Is it a new idea? No, not at all. Existing methods have been around for quite some time now, but the JRebel solution is more comprehensive.

Existing method 1: Hot Deploy
When an application server (e.g. JBoss, Weblogic’s "Fast Swap") will redeploy upon code changes. Decent sized app could be 30 to 45 seconds.

Existing method 2: Hot Swap
Since Java 1.4, you can redefine classes inside a debugger session. However, this only works for method bodies.

Existing method 3: Throwaway class loaders
E.g. Apache jackrabbit, various schemes available with many containers including Spring, ATG, WebSphere, WL. Only works for Managed Components, and has other problems.

Firstly, JRebel can work from within JDeveloper and provides simple buttons to turn on and off. However, this only works with JDev 11.1.2 and above.  We are still using earlier versions so I opted for the "standalone" version. This simply means that you get it running with some JVM parameters rather than a more point-and-click configuration.

Prerequisites:
  • JDeveloper installed, 
  • JRebel standalone version downloaded
  • JRebel license file

Installation

1. Install the JRebel standalone product somewhere, e.g. C:\Programs\jrebel-6.1.0-nosetup.

2. Open a command window, and run the setup.

cd c:\Programs\jrebel-6.1.0-nosetup\jrebel
bin\setup.cmd

This should create a .jrebel folder in your home directory, e.g. C:\Users\jjames\.jrebel.

Activation

Put the license file in the .jrebel folder. In a cmd window, run the activate script:

cd C:\Programs\jrebel-6.1.0-nosetup\jrebel
bin\activate.cmd jrebel.lic

Modify Weblogic

Add to JAVA_OPTIONS:

-noverify -javaagent:C:\path_to_jar\jrebel.jar -Drebel.adf_core_plugin=true -Drebel.adf_faces_plugin=true

Note: you will need to boost your PermGen from default 64m to at least 128m. You may also need to boost your max heap size. If you still have problems, switch to a 64bit JVM.

-Xms512m -Xmx1536m -XX:PermSize=512m -XX:MaxPermSize=512m

Project Configuration

Apart from the JVM params, the only other configuration you really need is one rebel.xml file per JDev project that you want monitored. For your typical ADF application, that usually means a "Model" project and a "View Controller" project. You are simply pointing to the folders where the class files pagedef's, and JSP's live.

Here is a sample from one of my ADF projects. There is documentation on this here.

The Model project rebel.xml:

<?xml version = '1.0' encoding = 'UTF-8'?>
<application
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.zeroturnaround.com/alderaan/rebel-2_0.xsd"
    xmlns="http://www.zeroturnaround.com">
  <classpath>
    <dir name="C:\Projects\HelloWorldApp\ADF\HelloWorld\Model\classes">
      <include name="*.class"/>
      <exclude name=".wlsjsps/**"/>
    </dir>
    <dir name="C:\Projects\HelloWorldApp\ADF\HelloWorld\Model\src">
      <exclude name="*.java"/>
    </dir>
  </classpath>
</application>

The View Controller project rebel.xml:

<?xml version = '1.0' encoding = 'UTF-8'?>
<application
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.zeroturnaround.com/alderaan/rebel-2_0.xsd"
      xmlns="http://www.zeroturnaround.com">
   <classpath>
      <dir name="C:\Projects\HelloWorldApp\ADF\HelloWorld\ViewController\adfmsrc"/>
      <dir name="C:\Projects\HelloWorldApp\ADF\HelloWorld\ViewController\classes">
         <include name="**/*.class"/>
         <exclude name=".wlsjsps/**"/>
      </dir>
      <dir name="C:\Projects\HelloWorldApp\ADF\HelloWorld\ViewController\src">
         <exclude name="**/*.java"/>
      </dir>
      <dir name="C:\Projects\HelloWorldApp\ADF\HelloWorld\Model\classes">
         <include name="**/*.class"/>
         <exclude name=".wlsjsps/**"/>
      </dir>
   </classpath>
   <web>
      <link target="/">
         <dir name="C:\Projects\HelloWorldApp\ADF\HelloWorld\ViewController\public_html"/>
      </link>
   </web>
</application>

Starting Up

During the WLS startup, you should see some startup messages like the following:

2015-03-03 14:52:12 JRebel: ############################################################# 2015-03-03 14:52:12 JRebel: JRebel Legacy Agent 6.1.0 (201502250834) 2015-03-03 14:52:12 JRebel: (c) Copyright ZeroTurnaround AS, Estonia, Tartu. 2015-03-03 14:52:12 JRebel: 2015-03-03 14:52:12 JRebel: Over the last 1 days JRebel prevented 2015-03-03 14:52:12 JRebel: at least 0 redeploys/restarts saving you about 0 hours. 2015-03-03 14:52:12 JRebel: 2015-03-03 14:52:12 JRebel: Licensed to Jonathan James 2015-03-03 14:52:12 JRebel: ############################################################# .... <11-Mar-2015 3:45:40 o'clock PM EDT> <Notice> <WebLogicServer> <BEA-000365> <Server state changed to STANDBY> <11-Mar-2015 3:45:40 o'clock PM EDT> <Notice> <WebLogicServer> <BEA-000365> <Server state changed to STARTING> 2015-03-11 15:45:50 JRebel: Directory 'C:\CVS_RCeds\RCeds\ADF\RCeds\ViewController\adfmsrc' will be monitored for changes. 2015-03-11 15:45:50 JRebel: Directory 'C:\CVS_RCeds\RCeds\ADF\RCeds\ViewController\classes' will be monitored for changes. 2015-03-11 15:45:50 JRebel: Directory 'C:\CVS_RCeds\RCeds\ADF\RCeds\ViewController\src' will be monitored for changes. 2015-03-11 15:45:50 JRebel: Directory 'C:\CVS_RCeds\RCeds\ADF\RCeds\Model\classes' will be monitored for changes. 2015-03-11 15:45:50 JRebel: Directory 'C:\CVS_RCeds\RCeds\ADF\RCeds\ViewController\public_html' will be monitored for changes. 2015-03-11 15:45:50 JRebel: Directory 'C:\CVS_RCeds\RCeds\ADF\RCeds\Model\classes' will be monitored for changes. 2015-03-11 15:45:50 JRebel: Directory 'C:\CVS_RCeds\RCeds\ADF\RCeds\Model\src' will be monitored for changes.

When a class or other file is reloaded, you'll see something like:

2015-03-11 16:04:32 JRebel: Reloading class 'edu.rcpsc.eds.view.backing.ItemWorkList'.
or:
2015-03-11 16:13:31 JRebel-Mojarra: Reloading configuration


Saturday, March 5, 2016

Development Tools - beyond JDeveloper and SQLDeveloper

Environment / assumptions for this post:
  • Windows 7+ desktop

Here are a few tools I've been using day to day that have come in very useful during normal development activities. I'm sure there are many alternatives to each of these, but these are either my favourites or maybe just what I've gotten used to.

Note: for useful programs equivalent to those below, checkout my post on the Linux Desktop in the workplace.

Cygwin

Cygwin is a collection of GNU and Open Source tools - basically Linux on Windows. If you have to use Windows for development and your servers are Linux based, then Cygwin can be greatly helpful. I love to use it for troubleshooting remote JVMs with JConsole, and use it for ssh shell access to the servers.
Cygwin terminal on Windows 7 - remotely connected to Linux
server with SSH and showing JConsole

Notepad++

Runner-up: Textpad
This is a great text editor - free, governed by GPL. Every day I take advantage of features like:

  • all the usual multiple tabs, syntax highlighting, multiple encodings, etc.
  • good regex support
  • if you close the program, you can restart with all your files/tabs intact even if they weren't saved 
  • even for searching the contents of files in a directory hierarchy
Notepadd++ - multiple tabs, and lots more


WinMerge

This is an Open Source diff / merge tools for Windows. Very nice, you can compare individual files or whole directories, ignoring certain files if you like. You can also just cut&paste into left/right windows.
WinMerge - diff / merge tool for Windows

WinDirStat

Open Source directory statistics viewer. Similar to KDirStat or QDirStat on Linux. Comes in really handy when you have a small SSD drive and are running out of space.
WinDirStat - directory statistics viewer

DJ Java Decompiler

Sometime you have to go to greater lengths than normal to troubleshoot issues. In those cases, being able to decompile classes is very useful, and this is probably the best program to do it. An earlier release is free, but the latest is $20US although it has a trial version.
DJ Java Decompiler

LdapAdmin

The Ldap Admin tool is also free, and allow you to connect to any Ldap server including Oracle OID. It is a nice way to search and verify things if OIDDAS isn't available, or you don't feel like using command-line tools.
Ldap Admin tool - connect to Ldap directories

VLC Media Player

Every developer needs to drown out their co-workers occasionally.  :)  For such times, VLC comes in handy - it is open source and multi-platform.
VLC Media Player

Snipping Tool

Believe it or not, even some people who have been using Windows for years may not realize that a very useful accessory tool is included with Windows - the Snipping Tool. There are better tools out there but this one is right there ready to go.
Microsoft's Snipping Tool

IrfanView

This is freeware, so free for personal or educational use but otherwise $12US. I suppose there are newer free image viewers, but I've been using this for a long time and I'm used to it. Very small and fast, easy to do simple manipulations. It is found here.
IfranView - nice little fast image viewer


Wednesday, February 24, 2016

ADF 12.2.1 - ExportCollectionActionListener exports column headings incorrectly after ordering columns

Update March 2017: this bug is still NOT FIXED. The Oracle Bug does not have a Fix Version.

Environment / assumptions for this post:

  • JDeveloper 12.2.1.0
  • Windows 7
  • Custom Fusion Web Application
This is admittedly a fairly low priority issue for us, but under the right circumstances it could be a big deal - if you export data from tables a lot.

In a nutshell: if you reorder a column in an af:table and then export the data via ExportCollectionActionListener, the data will be correct but the column headers will be the original header order.

To illustrate, I created a simple Test Case to submit to Oracle. 

Step 1 - simple table using a ViewObject that points to a simple basic database Table

Original table of data with Export button


Step 2 - Export the data and open in Microsoft Excel, looks fine

Data looks fine in Microsoft Excel

Step 3 - Re-order a column by dragging

Drag the order of columns - swap Firstname and Lastname

Step 4 - Export again - column headers wrong!

Second Export to Excel - data is correct but column headers are same as original

For reference, the Oracle BUG is #22791014.