Plug and Play into an NSF the org.openntf.domino way

The latest build of org.openntf.domino - in Nathan's or my branch - has a plugin, feature and update site to deploy org.openntf.domino system-wide. It's a work in progress, so I'll document the steps below. These will become easier, more automated. But for those early adopters, here you go.

The latest Git repository holds four projects:

• org.openntf.domino
• org.openntf.domino.xsp
• org.openntf.domino.feature
• org.openntf.domino.update If you have already downloaded the repository, you just need to import the three new projects into Eclipse.

First off, if you build, you may find some errors. That's because Eclipse sees org.openntf.domino as a forbidden package and throws errors. Two easy steps will rectify that:

1. Select Window > Preferences and in the tree navigation go to Java > Compiler > Errors/Warnings. Now in the Deprecated and restricted API section (you may need to collapse the current section or scroll down a long way!) change the option for Forbidden reference (access rules) to Warning.

2. Build All (or at least the org.openntf.domino.xsp package).

Now you're ready to just update the update site. If you haven't done that before, it's really easy, especially as the site.xml is already configured.

1. Go to org.openntf.domino.xsp.update and open site.xml.

2. Click the Build All button.

3. Right-click on org.openntf.domino.xsp.update and select Export.... Export using the File System option and click Next. Select your desired location and click Finish.

You now have an update site ready for installation into Domino or Designer. Install the same way you would normally (Chapter 2 of XPages Extension Library, if in any doubt).

There is one more step. The update site references org.openntf.domino, but doesn't package it. That's because the update site can only be used from XPages, not all the other contexts that org.openntf.domino can be used from. So you need the jar file.

Right-click on the src folder of the org.openntf.domino project and choose Export.... This time export using the JAR file option and click Next. If you want to debug, you'll need the .java files as well as the compiled .class files. So in the checkboxes, select the following:

• Export generated class files and resources - DESELECT
• Export all output folders for checked projects - SELECT
• Export Java source files and resources - SELECT
• Export refactorings for checked projects - DESELECT Select your desired location and click Finish.

Now you just need to put the jar file in a location accessible to your Domino server and Designer.

• For Designer, that's your PC's /jvm/lib/ext folder.
• For the Domino server, that the server's /jvm/lib/ext folder (Windows file structure).

I restarted my server - not a problem because I'm running a local development server. At the very least you'll need to issue a restart task http command to the server to load the OSGi plugin.

But because Nathan has made the plugin global, it's automatically available for any NSF on the server. No need to add it into the xsp.properties.