https://github.com/coldbox-modules/cbjavaloader
A module that interfaces with the JavaLoader Project
https://github.com/coldbox-modules/cbjavaloader
Last synced: 7 months ago
JSON representation
A module that interfaces with the JavaLoader Project
- Host: GitHub
- URL: https://github.com/coldbox-modules/cbjavaloader
- Owner: coldbox-modules
- Created: 2014-04-13T19:00:32.000Z (almost 12 years ago)
- Default Branch: development
- Last Pushed: 2025-02-19T21:56:49.000Z (11 months ago)
- Last Synced: 2025-06-19T14:53:19.769Z (7 months ago)
- Language: ColdFusion
- Size: 1.01 MB
- Stars: 1
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.YML
- Code of conduct: .github/CODE_OF_CONDUCT.MD
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
Copyright Since 2005 ColdBox Platform by Luis Majano and Ortus Solutions, Corp
www.coldbox.org |
www.ortussolutions.com
----
# Welcome to the cbJavaloader Project
This module will allow your ColdBox applications to class load different Java classes and libraries at runtime via the JavaLoader project. It also registers a WireBox DSL so you can easily inject Java classes into your objects using WireBox.
## License
Apache License, Version 2.0.
## Important Links
- Repository: https://github.com/coldbox-modules/cbjavaloader
- ForgeBox: https://forgebox.io/view/cbjavaloader
- Docs: https://github.com/Ortus-Solutions/JavaLoader
- [Changelog](changelog.md)
## System Requirements
- BoxLang 1+
- Lucee 5+
- ColdFusion 2021+
## Instructions
Just drop into your **modules** folder or use the box-cli to install
`box install cbjavaloader`
The module has a default folder called `lib` where any jars you drop there will be class loaded automatically. However, we recommend using the `loadpaths` setting for selecting an array of locations to class load, so when the module updates you won't lose those files.
## Models
The module registers the following mapping in WireBox: `loader@cbjavaloader`. Which is the class you will use to class load, append paths and much more. Check out the included API Docs for much more information. The main methods of importance of the java loader are:
- `create( class )` - Create a loaded Java class
- `appendPath( dirPath, filter)` - Appends a directory path of *.jar's,*.classes to the current loaded class loader.
- `getLoadedURLs()` - Get all the loaded URLs
## WireBox DSL
The module also registers a new WireBox DSL called `javaloader`. You can then use this custom DSL for injecting direct java class loaded classes very easily:
```js
property name="name" inject="javaloader:{class-path}";
property name="hello" inject="javaloader:HelloWorld";
property name="buffer" inject="javaloader:org.class.path.StringBuffer";
```
## Settings
Here are the module settings you can place in your `ColdBox.cfc` under an `moduleSettings.cbJavaLoader` structure:
```js
moduleSettings = {
cbJavaLoader = {
// A single path, and array of paths or a single Jar
loadPaths = [],
// Load ColdFusion classes with loader
loadColdFusionClassPath = false,
// Attach a custom class loader as a parent
parentClassLoader = "",
// Directories that contain Java source code that are to be dynamically compiled
sourceDirectories = [],
// the directory to build the .jar file for dynamic compilation in, defaults to ./tmp
compileDirectory = "models/javaloader/tmp",
// Whether or not the source is trusted, i.e. it is going to change? Defaults to false, so changes will be recompiled and loaded
trustedSource = false
}
};
```
Below is a simple example:
```js
/**
* My Event Handler Hint
*/
component{
// Inject JavaLoader
property name="javaloader" inject="loader@cbjavaloader";
// Index
any function index( event,rc, prc ){
// creat a java class
prc.hello = javaloader.create( "HelloWorld" ).init().hello();
}
// Run on first init
any function onAppInit( event, rc, prc ){
// on application start, load up more jars
javaloader.appendPaths( getSetting( "ApplicationPath" ) & "jars" );
}
}
```
---
********************************************************************************
Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp
www.ortussolutions.com
********************************************************************************
### HONOR GOES TO GOD ABOVE ALL
Because of His grace, this project exists. If you don't like this, then don't read it, its not for you.
>"Therefore being justified by faith, we have peace with God through our Lord Jesus Christ:
By whom also we have access by faith into this grace wherein we stand, and rejoice in hope of the glory of God.
And not only so, but we glory in tribulations also: knowing that tribulation worketh patience;
And patience, experience; and experience, hope:
And hope maketh not ashamed; because the love of God is shed abroad in our hearts by the
Holy Ghost which is given unto us. ." Romans 5:5
### THE DAILY BREAD
> "I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12