co.codewizards.cloudstore.core.updater

Class CloudStoreUpdaterCore

java.lang.Object

co.codewizards.cloudstore.core.updater.CloudStoreUpdaterCore

Direct Known Subclasses:

CloudStoreUpdater

public class CloudStoreUpdaterCore
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_KEY_DOWNGRADE Configuration property key controlling whether we do a downgrade.
static String	CONFIG_KEY_ENABLED Configuration property key controlling whether the updater is enabled.
static String	CONFIG_KEY_FORCE Configuration property key controlling whether to force the update.
static String	CONFIG_KEY_REMOTE_VERSION_CACHE_VALIDITY_PERIOD Configuration property key controlling how long a queried remote version is cached (and thus how often the server is asked for it).
static long	DEFAULT_REMOTE_VERSION_CACHE_VALIDITY_PERIOD
protected FileFilter	fileFilterIgnoringBackupAndUpdaterDir
protected FileFilter	fileFilterIgnoringBackupDir
static String	INSTALLATION_PROPERTIES_ARTIFACT_ID
static String	INSTALLATION_PROPERTIES_FILE_NAME
static String	INSTALLATION_PROPERTIES_VERSION
static String	PROTOCOL_FILE
static String	PROTOCOL_JAR
static String	remoteUpdatePropertiesURL
static String	remoteVersionURL

Constructor Summary

Constructors

Constructor and Description
CloudStoreUpdaterCore()

Method Summary

Methods

Modifier and Type	Method and Description
void	createUpdaterDirIfUpdateNeeded() Creates the updaterDir, if an update is necessary.
protected File	getBackupDir()
protected File	getInstallationDir() Gets the installation directory.
protected Properties	getInstallationProperties()
protected Version	getLocalVersion()
protected Version	getRemoteVersion()
protected File	getUpdaterDir()
protected String	resolve(String template) Resolves the given template by replacing all its variables with their actual values.

Methods inherited from class java.lang.Object

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

Field Detail

PROTOCOL_FILE

public static final String PROTOCOL_FILE

See Also:

Constant Field Values

PROTOCOL_JAR

public static final String PROTOCOL_JAR

See Also:

Constant Field Values

INSTALLATION_PROPERTIES_FILE_NAME

public static final String INSTALLATION_PROPERTIES_FILE_NAME

See Also:

Constant Field Values

INSTALLATION_PROPERTIES_ARTIFACT_ID

public static final String INSTALLATION_PROPERTIES_ARTIFACT_ID

See Also:

Constant Field Values

INSTALLATION_PROPERTIES_VERSION

public static final String INSTALLATION_PROPERTIES_VERSION

See Also:

Constant Field Values

remoteVersionURL

public static final String remoteVersionURL

See Also:

Constant Field Values

remoteUpdatePropertiesURL

public static final String remoteUpdatePropertiesURL

See Also:

Constant Field Values

CONFIG_KEY_DOWNGRADE

public static final String CONFIG_KEY_DOWNGRADE

Configuration property key controlling whether we do a downgrade. By default, only an upgrade is done. If this configuration property is set to true and the local version is newer than the version on the server a downgrade is done, too.

The configuration can be overridden by a system property - see Config.SYSTEM_PROPERTY_PREFIX.

See Also:

Constant Field Values

CONFIG_KEY_ENABLED

public static final String CONFIG_KEY_ENABLED

Configuration property key controlling whether the updater is enabled.

If it is enabled, it periodically checks whether an update is available, and if so, performs the update. Note, that CONFIG_KEY_FORCE (or its corresponding system property "cloudstore.updater.force") have no effect, if the updater is disabled!

The configuration can be overridden by a system property - see Config.SYSTEM_PROPERTY_PREFIX.

See Also:

Constant Field Values

CONFIG_KEY_FORCE

public static final String CONFIG_KEY_FORCE

Configuration property key controlling whether to force the update. If this property is set, an update is done even if the versions locally and remotely are already the same.

This is only designed as configuration key for consistency reasons - usually, you likely don't want to write this into a configuration file! Instead, you probably want to pass this as a system property - see Config.SYSTEM_PROPERTY_PREFIX (and the example below).

Note, that forcing an update has no effect, if the updater is disabled! Thus, if you want to force an update under all circumstances (whether the updater is enabled or not), you should pass both. As system properties, this looks as follows:

-Dcloudstore.updater.force=true -Dcloudstore.updater.enabled=true

See Also:

Constant Field Values

DEFAULT_REMOTE_VERSION_CACHE_VALIDITY_PERIOD

public static final long DEFAULT_REMOTE_VERSION_CACHE_VALIDITY_PERIOD

See Also:

Constant Field Values

CONFIG_KEY_REMOTE_VERSION_CACHE_VALIDITY_PERIOD

public static final String CONFIG_KEY_REMOTE_VERSION_CACHE_VALIDITY_PERIOD

Configuration property key controlling how long a queried remote version is cached (and thus how often the server is asked for it).

The configuration can be overridden by a system property - see Config.SYSTEM_PROPERTY_PREFIX.

See Also:

Constant Field Values

fileFilterIgnoringBackupDir

protected final FileFilter fileFilterIgnoringBackupDir

fileFilterIgnoringBackupAndUpdaterDir

protected final FileFilter fileFilterIgnoringBackupAndUpdaterDir

Constructor Detail

CloudStoreUpdaterCore

public CloudStoreUpdaterCore()

Method Detail

getRemoteVersion

protected Version getRemoteVersion()

getLocalVersion

protected Version getLocalVersion()

getInstallationProperties

protected Properties getInstallationProperties()

resolve

protected String resolve(String template)

Resolves the given template by replacing all its variables with their actual values.

Variables are written as "${variable}" similarly to Ant and Maven. See IOUtil.replaceTemplateVariables(String, Map) for further details.

The variable values are obtained from the installationProperties.

Parameters:

template - the template to be resolved. Must not be null.

Returns:

getInstallationDir

protected File getInstallationDir()
                           throws IllegalStateException

Gets the installation directory.

The implementation in CloudStoreUpdaterCore assumes that this class is located in a library (i.e. a JAR file) inside the installation directory.

Returns:

the installation directory. Never null.

Throws:

IllegalStateException - if the installation directory cannot be determined.

createUpdaterDirIfUpdateNeeded

public void createUpdaterDirIfUpdateNeeded()

Creates the updaterDir, if an update is necessary.

If an update is not necessary, this method returns silently without doing anything.

The check, whether an update is needed, is not done every time. The result is cached for a certain time period to reduce HTTP queries.

This method does not throw any exception. In case of an exception, it is only logged and this method returns normally.

getUpdaterDir

protected File getUpdaterDir()

getBackupDir

protected File getBackupDir()