Plus modules

Permeability functionality can be extended using plus plugins which can be easily added to extend any installation.  These modules are very easy to develop, package, deploy and install.

To create a new plus plugin.

1) Create an Eclipse java project

2) Make it depend on the PermeAgility project (if using source) or add the PermeAgility jar to your project

3) Write code (if you need to add Jar libraries, put them in the project's root directory), test, repeat...  you know the drill

4) Export classes into a jar file called plus-<yourJar>.jar (Add ClassPath dependencies to manifest if needed for other external jars).  Note: the name must begin with 'plus-' to be picked up by the PlusClassLoader

5) Create Zip of your jar file, a README and other required jar files (no subdirectories)

The Zip file you created is the plus module you can deploy.

To plug in a module to your server: 

1) Unzip the plus module zip file into your plus directory

2) Restart your server (sorry, no dynamic loading helps ensure stability)

3) Add the menu item for the relevant plus plugin,  check the README for the plus plugin for details

Note: Plus modules will create and use new tables in your database. Plus modules should have an automatic installation when first run which will create the relevant tables.  The installation will also be verified by the module after every server restart.  To configure a module to not check its installation, set the INSTALLED constant in the main Plus module class to true.