public class UpdateChecker
extends java.lang.Object
In order to use this class in your application, please include resource/i4jruntime.jar
from your
install4j installation into your class path. You do not need to distribute this file
along with your application, install4j will do this automatically for you.
UpdateDescriptor
Constructor and Description |
---|
UpdateChecker() |
Modifier and Type | Method and Description |
---|---|
static void |
executeScheduledUpdate(java.util.List<java.lang.String> arguments,
boolean restartLauncher,
java.lang.Runnable shutdownRunnable)
If an update is scheduled for installation execute the update installer and shutdown the current launcher.
|
static UpdateDescriptor |
getUpdateDescriptor(java.lang.String urlSpec,
ApplicationDisplayMode displayMode)
Convenience method for
getUpdateDescriptor(UpdateCheckRequest) . |
static UpdateDescriptor |
getUpdateDescriptor(java.lang.String urlSpec,
ApplicationDisplayMode displayMode,
ErrorHandlingCallback errorHandlingCallback)
Convenience method for
getUpdateDescriptor(UpdateCheckRequest) . |
static UpdateDescriptor |
getUpdateDescriptor(UpdateCheckRequest updateCheckRequest)
Download an
updates.xml file programatically from a given URL and returns an
UpdateDescriptor instance. |
static boolean |
isUpdateScheduled()
Checks if the "Schedule update installation" action has registered a downloaded update for installation.
|
public static UpdateDescriptor getUpdateDescriptor(java.lang.String urlSpec, ApplicationDisplayMode displayMode) throws UserCanceledException, java.io.IOException
getUpdateDescriptor(UpdateCheckRequest)
.urlSpec
- see UpdateCheckRequest.urlSpec(String)
displayMode
- see UpdateCheckRequest.applicationDisplayMode(ApplicationDisplayMode)
UserCanceledException
- if the user cancels the proxy dialogjava.io.IOException
- if the download failspublic static UpdateDescriptor getUpdateDescriptor(java.lang.String urlSpec, ApplicationDisplayMode displayMode, ErrorHandlingCallback errorHandlingCallback) throws UserCanceledException, java.io.IOException
getUpdateDescriptor(UpdateCheckRequest)
.urlSpec
- see UpdateCheckRequest.urlSpec(String)
displayMode
- see UpdateCheckRequest.applicationDisplayMode(ApplicationDisplayMode)
errorHandlingCallback
- see UpdateCheckRequest.errorHandlingCallback(ErrorHandlingCallback)
UserCanceledException
- if the user cancels the proxy dialogjava.io.IOException
- if the download failspublic static UpdateDescriptor getUpdateDescriptor(UpdateCheckRequest updateCheckRequest) throws UserCanceledException, java.io.IOException
updates.xml
file programatically from a given URL and returns an
UpdateDescriptor
instance. The UpdateCheckRequest
specifies the URL and other connection options.updateCheckRequest
- the update check requestUserCanceledException
- if the user cancels the proxy dialogjava.io.IOException
- if the download failspublic static boolean isUpdateScheduled()
true
if scheduled and ready to be executedpublic static void executeScheduledUpdate(java.util.List<java.lang.String> arguments, boolean restartLauncher, java.lang.Runnable shutdownRunnable)
arguments
- arguments to be passed to the updater.restartLauncher
- if true a GUI or a console launcher will be restarted after the installation. If called from a service launcher the
installer must take care of starting the service again. It can use context.getBooleanVariable("sys.automaticUpdate") if restart should be done conditionally.shutdownRunnable
- if you want to invoke a custom routine for shutting down the current JVM, you can pass in a Runnable. Otherwise, System.exit(0) will be called.
If you pass in a Runnable. you must call System.exit at the end of your shutdown procedure.