For Java-based extensions, first use the Server SDK to create and build the extension bundle as described in the Server SDK documentation.

  • Use the manage-extension tool to install it.
    $ bin/manage-extension --install/path/to/

    The Java-based extension can then be configured for use in the server using dsconfig or the Administrative Console. Create a new Third Party HTTP Servlet Extension, specifying the fully-qualified name for the HTTPServletExtension subclass in the extension-class property, and providing any appropriate arguments in the extension-argument property.


    Web application and Servlet extensions run in a shared embedded web application server environment. Incompatibilities or conflicts might arise from use of different versions of commonly used JARs or including frameworks such as loggers, Spring components, JAX-RS implementations or other resources that might require a dedicated Java virtual machine (JVM) environment. After introducing a custom extension, check the server error log for an indication that the extension loaded successfully. The error log might also contain debug information if the extension failed to load with an initialization exception or did not complete initialization.