com.denova.JExpress.Updater
Interface UpdatePropertyNames

public interface UpdatePropertyNames

The list of properties available during an update.

Author:

DeNova © 1997-2012 DeNova Last modified: 2012-04-30

Field Summary

static java.lang.String	AutoUpdateCheck The command line parameter if the auto updater should check for updates.
static java.lang.String	AutoUpdateExec The full path to the executable if auto-updating a non-java app.
static java.lang.String	AutoUpdateFull The command line parameter if the auto updater should check and run if updates found.
static java.lang.String	CommandLineArgs Command line arguments as defined in the launcher.
static java.lang.String	CustomAfterFilesCompared Classname(s) of any custom commands to be executed after Updater determines which files need to be updated.
static java.lang.String	CustomAfterFilesDownloaded Classname(s) of any custom commands to be executed after files are updated in the temporary update directory.
static java.lang.String	CustomAfterGetFileList Classname(s) of any custom commands to be executed after the Updater gets the list of update files.
static java.lang.String	CustomAfterUpdate Classname(s) of any custom commands to be executed after the updated files are copied to the programDir.
static java.lang.String	CustomBeforeUpdate Classname(s) of any custom commands to be executed before any other Java panels appear in the updater.
static java.lang.String	DeleteObsoleteFiles If you want the updater to remove files that are not in the new manifest.
static java.lang.String	ErrorInPanel The name of the wizard panel where a fatal error occurred.
static java.lang.String	FilesUpdatedOk The status of updating the files.
static java.lang.String	FinishedUpdate The status of the update.
static java.lang.String	FollowPermanentRedirections If you want the updater to follow permanent redirections, then set this to true.
static java.lang.String	FollowRedirections If you want the updater to follow permanent and temporary redirections, then set this to true.
static java.lang.String	FullAutoUpdateName The name of the full autoupdater if autoupdater needs 2 launchers (one for checking if updates available and the other that requires user enter credentials).
static java.lang.String	FullUpdateOk The final status of the update.
static java.lang.String	HostName The URL for the host system (e.g., http://denova.com).
static java.lang.String	JavaMenus List of filenames for the Java menus.
static java.lang.String	JvmParameters Parameters used to launch JVM for the updated program.
static java.lang.String	LastError Last error in updater.
static java.lang.String	MaxMinsToDownloadFile Maximum time to wait in minutes for a file to download.
static java.lang.String	NewManifestFilename The name of the manifest file with all filenames in the update.
static java.lang.String	NewUpdater Determines whether a new JExpressUpdater.jar was downloaded.
static java.lang.String	OldManifestFilename The name of the manifest file before the update is applied.
static java.lang.String	ProgramArg None standard arguments passed on the command line.
static java.lang.String	ProgramClass The Java program to start after an autoupdate finishes.
static java.lang.String	ProgramDir The full pathname for the directory where the is program being update resides on the user's local system.
static java.lang.String	ProgramIcon The fullpath to the Mac icns file.
static java.lang.String	ProgramName The name of Java program to start after an autoupdate finishes.
static java.lang.String	ProgramStarted True if updater started program.
static java.lang.String	ShowFileProgress True if the progress bar shows the progress of each file.
static java.lang.String	ShowOverallProgress True if the progress bar shows the overall progress of the update.
static java.lang.String	StartNonJavaApp True if updater started with a non-java app flag set.
static java.lang.String	TotalFileCount The total number of files distributed.
static java.lang.String	TotalFileSize The total size of all the distributed files uncompressed.
static java.lang.String	TotalNewFiles The number of files that are new or modified.
static java.lang.String	TotalObsoleteFiles The number of files that are obsolete, if DeleteObsoleteFile is true.
static java.lang.String	UpdateButtonsPosition The position where the updater's buttons appear.
static java.lang.String	UpdateDir The full pathname for the temporary directory where updates are stored on the user's local system.
static java.lang.String	UpdateImageFilename Filename for the image used during the update.
static java.lang.String	UpdateImagePosition The position where the updater's image appears.
static java.lang.String	UpdatePassword The user name's password for the update subdirectory on the host system.
static java.lang.String	UpdaterStarted True if verifying license and CopyCheq server knows updater started.
static java.lang.String	UpdateUrl The full URL where the updates reside on the host system (e.g., http://www.denova.com/HelloWorld/updates).
static java.lang.String	UpdateUserName The user name for the update subdirectory on the host system.
static java.lang.String	UseJavaConsole True if the updated app uses a Java console.
static java.lang.String	UserClasspath Classpath on target system relative to the application's directory.
static java.lang.String	WebAuthorizationFailed True if authorization from the website failed.
static java.lang.String	WebUpdate True if updating from web site.

Field Detail

UpdateUserName

static final java.lang.String UpdateUserName

The user name for the update subdirectory on the host system. Optional.

See Also:

Constant Field Values

UpdatePassword

static final java.lang.String UpdatePassword

The user name's password for the update subdirectory on the host system. Optional.

See Also:

Constant Field Values

HostName

static final java.lang.String HostName

The URL for the host system (e.g., http://denova.com).

See Also:

Constant Field Values

UpdateUrl

static final java.lang.String UpdateUrl

The full URL where the updates reside on the host system (e.g., http://www.denova.com/HelloWorld/updates).

See Also:

Constant Field Values

UpdateDir

static final java.lang.String UpdateDir

The full pathname for the temporary directory where updates are stored on the user's local system.

See Also:

Constant Field Values

ProgramArg

static final java.lang.String ProgramArg

None standard arguments passed on the command line. Each argument is stored in its own property so the first argument is in programArg0, the next one in programArg1, etc.

Command line arguments may change in future versions so if you utilize the programArg properties you may need to adapt your custom classes with those releases.

See Also:

Constant Field Values

CommandLineArgs

static final java.lang.String CommandLineArgs

Command line arguments as defined in the launcher.

See Also:

Constant Field Values

ProgramDir

static final java.lang.String ProgramDir

The full pathname for the directory where the is program being update resides on the user's local system.

See Also:

Constant Field Values

ProgramClass

static final java.lang.String ProgramClass

The Java program to start after an autoupdate finishes. This field is blank if this is an on-demand update.

See Also:

Constant Field Values

ProgramName

static final java.lang.String ProgramName

The name of Java program to start after an autoupdate finishes. This field is blank if this is an on-demand update.

See Also:

Constant Field Values

ProgramIcon

static final java.lang.String ProgramIcon

The fullpath to the Mac icns file. This field is not set by the installer, but can be set by a custom class during installation so when the Updater is run on Mac, the program's icon displays in the dock.

See Also:

Constant Field Values

TotalObsoleteFiles

static final java.lang.String TotalObsoleteFiles

The number of files that are obsolete, if DeleteObsoleteFile is true.

Returns an int.

See Also:

Constant Field Values

TotalNewFiles

static final java.lang.String TotalNewFiles

The number of files that are new or modified.

Returns an int.

See Also:

Constant Field Values

OldManifestFilename

static final java.lang.String OldManifestFilename

The name of the manifest file before the update is applied.

See Also:

Constant Field Values

NewManifestFilename

static final java.lang.String NewManifestFilename

The name of the manifest file with all filenames in the update.

See Also:

Constant Field Values

TotalFileCount

static final java.lang.String TotalFileCount

The total number of files distributed.

Property's value is an int.

See Also:

Constant Field Values

TotalFileSize

static final java.lang.String TotalFileSize

The total size of all the distributed files uncompressed.

Property's value is a long.

See Also:

Constant Field Values

FullUpdateOk

static final java.lang.String FullUpdateOk

The final status of the update.

Returns true iff the full update was successfull.

See Also:

Constant Field Values

FilesUpdatedOk

static final java.lang.String FilesUpdatedOk

The status of updating the files.

Returns true iff the files update was successfull.

See Also:

Constant Field Values

FinishedUpdate

static final java.lang.String FinishedUpdate

The status of the update.

Returns true iff the update finished, whether successful or not.

See Also:

Constant Field Values

NewUpdater

static final java.lang.String NewUpdater

Determines whether a new JExpressUpdater.jar was downloaded.

The JAR file is not updated until the user clicks the Finished button on the FinalPanel. If this is an autoupdate, the user is warned that they must restart the app so the Updater can be updated.

Returns true if there is a new JExpressUpdater.jar.

See Also:

Constant Field Values

MaxMinsToDownloadFile

static final java.lang.String MaxMinsToDownloadFile

Maximum time to wait in minutes for a file to download.

Default is 5 minutes. It is strongly recommended that you only adjust this if your customers are using a dial-up connection and are having trouble downloading the updates. Some browsers have difficulty if this value is set too high.

Customers can add a new property to the update.control property file in the JExpress subdirectory to increase, or decrease, the maximum time to wait. Or, you can add a custom class to the installer to change the setting for this value. Be sure that your custom class is included "After install" and it modifies the existing update.control file.

See Also:

Constant Field Values

UpdateImageFilename

static final java.lang.String UpdateImageFilename

Filename for the image used during the update.

Returns a String.

See Also:

Constant Field Values

UpdateImagePosition

static final java.lang.String UpdateImagePosition

The position where the updater's image appears.

Returns a String(North, South, East, or West) .

See Also:

Constant Field Values

UpdateButtonsPosition

static final java.lang.String UpdateButtonsPosition

The position where the updater's buttons appear.

Returns a String (North, South, East, or West) .

See Also:

Constant Field Values

JavaMenus

static final java.lang.String JavaMenus

List of filenames for the Java menus. The filenames contain the relative path from the installation/application directory.

Returns a comma separated list of strings.

See Also:

Constant Field Values

StartNonJavaApp

static final java.lang.String StartNonJavaApp

True if updater started with a non-java app flag set.

Returns a boolean.

See Also:

Constant Field Values

AutoUpdateExec

static final java.lang.String AutoUpdateExec

The full path to the executable if auto-updating a non-java app.

Returns a String.

See Also:

Constant Field Values

ErrorInPanel

static final java.lang.String ErrorInPanel

The name of the wizard panel where a fatal error occurred.

See Also:

Constant Field Values

JvmParameters

static final java.lang.String JvmParameters

Parameters used to launch JVM for the updated program.

Returns a String.

See Also:

Constant Field Values

UserClasspath

static final java.lang.String UserClasspath

Classpath on target system relative to the application's directory.

Returns a String.

See Also:

Constant Field Values

UseJavaConsole

static final java.lang.String UseJavaConsole

True if the updated app uses a Java console.

Returns a boolean.

See Also:

Constant Field Values

LastError

static final java.lang.String LastError

Last error in updater.

Returns a string.

See Also:

Constant Field Values

WebAuthorizationFailed

static final java.lang.String WebAuthorizationFailed

True if authorization from the website failed.

See Also:

Constant Field Values

WebUpdate

static final java.lang.String WebUpdate

True if updating from web site.

See Also:

Constant Field Values

ShowOverallProgress

static final java.lang.String ShowOverallProgress

True if the progress bar shows the overall progress of the update.

See Also:

Constant Field Values

ShowFileProgress

static final java.lang.String ShowFileProgress

True if the progress bar shows the progress of each file.

See Also:

Constant Field Values

CustomBeforeUpdate

static final java.lang.String CustomBeforeUpdate

Classname(s) of any custom commands to be executed before any other Java panels appear in the updater.

Returns a String.

See Also:

Constant Field Values

CustomAfterGetFileList

static final java.lang.String CustomAfterGetFileList

Classname(s) of any custom commands to be executed after the Updater gets the list of update files.

Returns a String.

See Also:

Constant Field Values

CustomAfterFilesCompared

static final java.lang.String CustomAfterFilesCompared

Classname(s) of any custom commands to be executed after Updater determines which files need to be updated.

Returns a String.

See Also:

Constant Field Values

CustomAfterFilesDownloaded

static final java.lang.String CustomAfterFilesDownloaded

Classname(s) of any custom commands to be executed after files are updated in the temporary update directory.

Returns a String.

See Also:

Constant Field Values

CustomAfterUpdate

static final java.lang.String CustomAfterUpdate

Classname(s) of any custom commands to be executed after the updated files are copied to the programDir. The class(es) in this field are executed before the "Final" panel appears if this is an "On-demand" update or before the Java program is launched if the Updater starts before a Java app.

Returns a String.

See Also:

Constant Field Values

FollowRedirections

static final java.lang.String FollowRedirections

If you want the updater to follow permanent and temporary redirections, then set this to true. Otherwise, set it to false. Default is true.

Property's value is a boolean.

See Also:

Constant Field Values

FollowPermanentRedirections

static final java.lang.String FollowPermanentRedirections

If you want the updater to follow permanent redirections, then set this to true. Otherwise, set it to false. Default is true.

Property's value is a boolean.

See Also:

Constant Field Values

DeleteObsoleteFiles

static final java.lang.String DeleteObsoleteFiles

If you want the updater to remove files that are not in the new manifest. Default is true.

Property's value is a boolean.

See Also:

Constant Field Values

UpdaterStarted

static final java.lang.String UpdaterStarted

True if verifying license and CopyCheq server knows updater started.

See Also:

Constant Field Values

ProgramStarted

static final java.lang.String ProgramStarted

True if updater started program.

See Also:

Constant Field Values

FullAutoUpdateName

static final java.lang.String FullAutoUpdateName

The name of the full autoupdater if autoupdater needs 2 launchers (one for checking if updates available and the other that requires user enter credentials). If updates found, then get the updates. Otherwise, start the app.

Returns a String.

See Also:

Constant Field Values

AutoUpdateFull

static final java.lang.String AutoUpdateFull

The command line parameter if the auto updater should check and run if updates found.

Returns a boolean.

See Also:

Constant Field Values

AutoUpdateCheck

static final java.lang.String AutoUpdateCheck

The command line parameter if the auto updater should check for updates. If updates found, then get the updates. Otherwise, start the app.

Returns a boolean.

See Also:

Constant Field Values