Module org.tentackle.update

Package org.tentackle.update

Class ClientUpdateUtilities

java.lang.Object

org.tentackle.update.ClientUpdateUtilities

@Service(ClientUpdateUtilities.class)
public class ClientUpdateUtilities
extends java.lang.Object

Utility methods to implement the application update.

Constructor Summary

Constructors

Constructor	Description
ClientUpdateUtilities()

Method Summary

Modifier and Type	Method	Description
InstallationType	determineInstallationType()	Determines the installation type of the running application.
java.io.File	determineJPackageRoot()	Determines the jpackage's root installation directory.
java.io.File	dowloadZip(UpdateInfo updateInfo, java.io.File updateDir, java.util.function.Consumer<java.lang.Double> progressConsumer)	Downloads the zipfile.
static ClientUpdateUtilities	getInstance()	The singleton.
java.security.MessageDigest	getMessageDigest()	Gets the message digest to create the checksum of the downloaded zip file.
UpdateService	getUpdateService(java.lang.String serviceName, java.rmi.server.RMIClientSocketFactory csf)	Gets the remote update service object.
boolean	isUpdatableJlinkDirectory(java.io.File dir)	Checks whether given directory an updatable jlink image.
boolean	isUpdatableJPackageApplication()	Checks whether
boolean	isUpdateableJlinkApplication()	Checks whether the application is running in an updatable jlink directory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientUpdateUtilities

public ClientUpdateUtilities()

Method Detail

getInstance

public static ClientUpdateUtilities getInstance()

The singleton.

Returns:

the singleton

isUpdatableJlinkDirectory

public boolean isUpdatableJlinkDirectory(java.io.File dir)

Checks whether given directory an updatable jlink image.

Parameters:

dir - the directory to check

Returns:

true if updatable jlink structure found

isUpdateableJlinkApplication

public boolean isUpdateableJlinkApplication()

Checks whether the application is running in an updatable jlink directory.

Returns:

true if current workling directory contains an updatable jlink image

isUpdatableJPackageApplication

public boolean isUpdatableJPackageApplication()

Checks whether

Returns:

true if jlink structure and updatable

determineJPackageRoot

public java.io.File determineJPackageRoot()

Determines the jpackage's root installation directory.

Returns:

the installation directory, null if not a jpackage installation

determineInstallationType

public InstallationType determineInstallationType()

Determines the installation type of the running application.

Returns:

the installation type, null if not an updatable installation

getUpdateService

public UpdateService getUpdateService(java.lang.String serviceName,
                                      java.rmi.server.RMIClientSocketFactory csf)

Gets the remote update service object.

Parameters:

serviceName - the service name, for ex. "rmi://localhost/Update:33002"

csf - the optional socket factory, null if default

Returns:

the update service

getMessageDigest

public java.security.MessageDigest getMessageDigest()
                                             throws java.security.NoSuchAlgorithmException

Gets the message digest to create the checksum of the downloaded zip file.

Returns:

the message digest

Throws:

java.security.NoSuchAlgorithmException - if no such digest

dowloadZip

public java.io.File dowloadZip(UpdateInfo updateInfo,
                               java.io.File updateDir,
                               java.util.function.Consumer<java.lang.Double> progressConsumer)

Downloads the zipfile.

Parameters:

updateInfo - the update info

updateDir - the directory to create for the update process

progressConsumer - the consumer receiving the progress from 0.0 to 1.0, null if none

Returns:

the downloaded ZIP file in the created update directory