ClientUpdateUtilities (Tentackle Update 11.6.1.0 API)

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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.
`UpdateService`	`getUpdateService(java.lang.String serviceName, java.rmi.server.RMIClientSocketFactory csf)`	Gets the remote update service object.
`boolean`	`isApplicationUpdatable()`	Checks whether the application is running in an updatable 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
  - isApplicationUpdatable
```
public boolean isApplicationUpdatable()
```
    Checks whether the application is running in an updatable directory.
    
    Returns:
    
    true if updatable
  - 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
  - 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