update4j: A Java repository from garzy

Read the documentation, explore the JavaDoc, or see it in action

Create a framework: design the environment and lifecycle (—bootstrap) to make your own auto-update framework and hack it to the core, or use the built-in default bootstrap.

Screenshots

Headless

Using the default bootstrap, downloads 4 files then launches hello-world.jar. You can see that subsequent runs won't download again.

JavaFX

Using a custom bootstrap implemented to report progress in JavaFX, downloads 4 files then launches hello-world.jar.

Overview

Update4j is the first auto-update and launcher library designed for Java 9+. Easily host your application files anywhere (even Google Drive, Dropbox, Amazon S3, or Maven Central) and you can synchronize them with all your distributed applications. You can use any protocol you wish to retrieve those files and may be protected under authenticated API.

In update4j you have ultimate control of every process, from startup - update - launch - shutdown, since it's a library (you call the 3rd party code) not a framework (3rd party calls your code outside your control). In addition, every single piece of code is completely updatable; even update4j itself, once a new version is released!

Installation & Usage

You can download or install using Maven:

<dependency>
    <groupId>org.update4j</groupId>
    <artifactId>update4j</artifactId>
    <version>1.4.4</version>
</dependency>

You can use it as a regular dependency, or you may run it as a runnable JAR file.

To run it in the modulepath, use either of:

$ java -p update4j-1.4.4.jar -m org.update4j
$ java -p . -m org.update4j

To run it in the classpath, use either of:

$ java -jar update4j-1.4.4.jar
$ java -cp * org.update4j.Bootstrap

For more information refer to Starting the Application in the wiki.

What's New in 1.4.x — Migration Guide

Changed warning suppression system property key from suppress.warning to update4j.suppress.warning.
Restricted passing the same command to DefaultBootstrap twice.
Increased download byte buffer to 8kb. UpdateHandler.updateDownloadFileProgress() will be called less frequently.
Added UpdateHandler.shouldCheckForUpdate(). Returning false will skip that file from being updated.
Pass arguments and system properties from the config when using the DefaultLauncher.
DefaultLauncher is now aware of JavaFX and will start javafx.application.Application even if missing a main method in class defined in default.launcher.main.class.
Reduced system dependencies to java.xml and added warnings if system module is not properly resolved. (breaking change in some cases).
Added dependency injection framework to communicate between the bootstrap and service provider.
Consequently, removed provider consumers at update and launch, and passing args at launch.
Removed many confusing getXxxProperty() methods in Configuration class.
You can now add properties to a config dynamically at runtime.
Locate explicit service providers even if not properly registered as required by ServiceLoader.
Made many service methods default.
Added osFromFilename() method in FileMetadata builder.
Changed how --delegate argument in Bootstrap works.

Contributors

@mordechaim — lead contributor.
@ChristianCiach — tested and inspired many features and bugfixes.
@edvin — original author of edvin/FXLauncher which highly influenced the design of update4j.

License

This project is licensed under the Apache Software License 2.0

garzy/update4j