Install or remove a plugin

Deploy runs on the Java Virtual Machine (JVM) and has two classloaders: one for the server itself, and one for the plugins and extensions. A plugin can have an .xldp or a .jar extension. The XLDP format is a ZIP archive that bundles a plugin with all of its dependencies.

To install or remove a plugin, you must stop the Deploy server. Plugins that are installed or removed while the server is running will not take effect until it is restarted.

Server classloader

The Deploy server classpath contains resources, configuration files, and libraries that the server needs to work. The default Deploy server classloader will use the following classpath:

Directory Description
XL_DEPLOY_SERVER_HOME/conf For configuration files.
XL_DEPLOY_SERVER_HOME/hotfix/lib/* For server hotfix JARs.
XL_DEPLOY_SERVER_HOME/lib/* For server library JARs.

You can configure these directories in XL_DEPLOY_SERVER_HOME/conf/xld-wrapper-(linux|win).conf.

Plugin classloader

In addition to the Deploy server classloader, there is a plugin classloader. The plugin includes the classpath of the server classloader. It also includes:

Directory Description
ext Directly added to the classpath and can contain classes and resources that are not in a JAR file.

The plugin classloader also scans the following directories and adds all *.jar and *.xldp files to the classpath:

Directory Description
XL_DEPLOY_SERVER_HOME/hotfix/plugins/* Can contain hotfix JARs for plugins.
XL_DEPLOY_SERVER_HOME/plugins/* Contains installed plugins.

These paths are not configurable. The directories are loaded in the order that they are listed. This order is important. For example, hotfixes must be loaded before the code so that it can override the server behavior.

Install a plugin

To install a plugin:

  1. Shut down the Deploy server.
  2. Copy the plugin XLDP or JAR file to the XL_DEPLOY_SERVER_HOME/plugins directory.
  3. Start the Deploy server. Depending on your system, execute one of the following:

    • Unix-based system: run.sh
    • Microsoft Windows: run.cmd For more information, see Start Deploy.
  4. Refresh the Deploy GUI in your browser.

Remove a plugin

To remove a plugin:

  1. Shut down the Deploy server.
  2. Delete the plugin XLDP or JAR file from the XL_DEPLOY_SERVER_HOME/plugins directory.
  3. Start the Deploy server. Depending on your system, execute one of the following:

    • Unix-based system: run.sh
    • Microsoft Windows: run.cmd For more information, see Start Deploy.
  4. Refresh the Deploy GUI in your browser.