JarCasting
JarCasting JarCasting

Limbus API

This module only contains interfaces that are needed to develop plugins for the Limbus Engine.

License

License
GroupId

GroupId

com.remondis.limbus
ArtifactId

ArtifactId

limbus-engine-api
Last Version

Last Version

3.0.1
Release Date

Release Date
Type

Type

jar
Description

Description

Limbus API
This module only contains interfaces that are needed to develop plugins for the Limbus Engine.

Download limbus-engine-api

Filename Size
limbus-engine-api-3.0.1.pom
limbus-engine-api-3.0.1.jar 11 KB
limbus-engine-api-3.0.1-sources.jar 9 KB
limbus-engine-api-3.0.1-javadoc.jar 78 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/com.remondis.limbus/limbus-engine-api/ -->
<dependency>
    <groupId>com.remondis.limbus</groupId>
    <artifactId>limbus-engine-api</artifactId>
    <version>3.0.1</version>
</dependency>
// https://jarcasting.com/artifacts/com.remondis.limbus/limbus-engine-api/
implementation 'com.remondis.limbus:limbus-engine-api:3.0.1'
// https://jarcasting.com/artifacts/com.remondis.limbus/limbus-engine-api/
implementation ("com.remondis.limbus:limbus-engine-api:3.0.1")
'com.remondis.limbus:limbus-engine-api:jar:3.0.1'
<dependency org="com.remondis.limbus" name="limbus-engine-api" rev="3.0.1">
  <artifact name="limbus-engine-api" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.remondis.limbus', module='limbus-engine-api', version='3.0.1')
)
libraryDependencies += "com.remondis.limbus" % "limbus-engine-api" % "3.0.1"
[com.remondis.limbus/limbus-engine-api "3.0.1"]

Dependencies

test (3)

Group / Artifact Type Version
junit : junit jar 4.12
org.assertj : assertj-core jar 3.14.0
org.mockito : mockito-core jar 3.1.0

Project Modules

There are no modules declared in this project.

Limbus Engine - A multi classloader hot-deploy container

Table of Contents

  1. Overview
  2. Modules
  3. Compatibility with Java 9 and later

Overview

The Limbus Engine is a hot-deployment runtime container that enables Java applications to load isolated classpaths at runtime. The Limbus Engine is an implementation of a plugin mechanism but even more: The Limbus Engine supports loading and unloading of a classpaths at runtime, sandboxing of the code in a way that loaded code cannot just do everything like System.exit();, flexible routing of plugin output like logging or System.out, a test library that can be used to (un)deploy classpaths in a JUnit tests and features like system monitoring, file-system abstraction and more.

The Limbus Engine uses the same hierarchy of classloaders like the most popular servlet container Apache Tomcat but enables the application to sandbox any code from a classpath. This way the plugin code can be restricted and the rest of the application remains isolated. The Java Security API is used to restrict the code running in a sandbox. A security manager keeps track of what a plugin is doing (read here for more information). The access to a plugin or from a plugin to it's host application is restricted by an interface designed by the host application.

The Limbus Engine provides a framework for developing host applications as well as plugin interfaces and implementations. This is useful for all applications that want to implement a plugin feature.

Modules

The Limbus Engine consists of many different components that are managed as Maven modules. This is an overview of the Limbus modules with a short description of what they are doing:

  • limbus-depchain-host Dependency Chain for developing a host application
  • limbus-depchain-plugin Dependency Chain for developing plugins
  • limbus-engine-api Interfaces and structures for developing plugins as well as the Limbus Engine itself
  • limbus-engine-impl Core-Module providing the Limbus Engine implementation
  • limbus-showcase-plugin Demonstration of a plugin.
  • limbus-showcase-launcher Module for bootstrapping a Limbus Engine to demonstrate the (un)deploy feature using limbus-showcase-plugin.
  • limbus-event-multicaster Core component for multicasting of method calls
  • limbus-jsse System component for initializing the Java Secure Socket Extension
  • limbus-logging-api Interface definitions for system components integrating logging frameworks.
  • limbus-logging-jdk System component integrating the Java Utils Logging Framework
  • limbus-logging-log4j System component integrating Log4J Logging Framework.
  • limbus-properties Core component to access property configurations
  • limbus-utils Util module providing features for accessing ZIP archives and reflective operations.
  • limbus-staging Module for developing integration tests and bootstrapping of an embedded Limbus Engine instance
  • limbus-system Core component managing system componentents as well as an implementation of a Dependency Injection (CDI) mechanism.
  • limbus-task-scheduler System component managing periodically called tasks supporting adaptive scheduling intervals.
  • limbus-vfs System component providing an API for the file system abstraction. Provides an implementation to access the real filesystem and an implementation providing an in-memory file system for easy support of integrations tests

Compatibility with Java 9 and later

Currently the Limbus Engine performs a few class-leak prevention operations like scanning the ThreadLocals that were created but not freed by plugin code. Those operations use reflective access to 'java.base' module. By default this is not allowed in Java 9 and later.

Currently there is no switch to disable this features in Limbus Engine. So currently use the following argument when starting a JVM:

--add-opens java.base/java.lang=com.remondis.limbus.engine.implementation

Leak Prevention notes

Currently ThreadLocal and ClassLoaders are scanned for possible classloader-leaks. Maybe some of those hacks are not necessary.

  • ThreadLocals are held using a WeakReference. Those references should clear themselves if no other stronger reference is existent. Maybe the operation in com.remondis.limbus.engine.LimbusUtil.getCurrentThreadLocals() is not needed anymore.
com.remondis.limbus

REMONDIS IT Services GmbH & Co. KG

Versions

Version
3.0.1
2.0.1