com.github.sbugat.rundeckmonitor

Class VersionChecker

java.lang.Object

com.github.sbugat.rundeckmonitor.VersionChecker

All Implemented Interfaces:

Runnable

public final class VersionChecker
extends Object
implements Runnable

Simple generic version checker on GitHub, inpect target jar and local jar build date to determinated if an update is available. If one is found, download the full jar and replace the original jar via a double restart. The checker use an independant thread to check and download the file. The main thread have to check is the download is done and order to restart the program.

Author:

Sylvain Bugat

Field Summary

Fields

Modifier and Type	Field and Description
private static String	BIN_DIRECTORY_AND_JAVA bin subdirectory and java executable.
private boolean	downloadDone Indicate if the download is completed.
private String	downloadedJar Name of the downloaded jar.
private String	gitHubRepository GitHub repository.
private String	gitHubUser Root URL of the GitHub project to update.
private static String	JAR_ARGUMENT Jar argument for java reloading.
private static String	JAR_EXTENSION Jar extension.
private String	jarWithDependenciesSuffix Suffix of the full jar including all dependencies.
private static String	JAVA_HOME_PROPERTY Java home property.
private static org.slf4j.ext.XLogger	LOG SLF4J XLogger.
private String	mavenArtifactId Maven artifact identifier.
private static int	ONE_MEGABYTE Precalculated one megabyte for indicating download size.
private static String	TARGET_DIRECTORY Target directory in zipball releases.
private static String	TMP_EXTENSION Tmp extension.
private boolean	versionCheckerDisabled Indicate if the version checker is disabled.
private static String	WINDOWS_EXE_EXTENSION Executable extension on Windows.

Constructor Summary

Constructors

Constructor and Description
VersionChecker(String gitHubUserArg, String gitHubRepositoryArg, String mavenArtifactIdArg, String jarWithDependenciesSuffixArg) Initialize the version checker with jar artifact and suffixnames and path to GitHub.

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanOldAndTemporaryJar() Clean the old jar and any existing temporary file.
private String	currentJar() Return the current executed jar.
private static void	deleteJar(Path jarFileToDelete) Delete a jar file.
private static void	downloadFile(InputStream inputStream, String destinationFile) Download a file/URL and write it to a destination file.
private boolean	findAndDownloadReleaseJar(org.eclipse.egit.github.core.RepositoryTag release, boolean withDependenciesSuffix) Find a jar in release and if it is a newer version, ask to download it.
private static String	getJavaExecutable() Get the java executable.
boolean	isDownloadDone() Get the download status.
boolean	isversionCheckerDisabled() Get the state of the version checker.
void	resetVersionCheckerDisabled() Enable the version checker.
boolean	restart() Restart the RunDeck monitor and use the newer jar file.
void	run() Background thread launched to check the version on GitHub.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.ext.XLogger LOG

SLF4J XLogger.

ONE_MEGABYTE

private static final int ONE_MEGABYTE

Precalculated one megabyte for indicating download size.

See Also:

Constant Field Values

JAR_EXTENSION

private static final String JAR_EXTENSION

Jar extension.

See Also:

Constant Field Values

TMP_EXTENSION

private static final String TMP_EXTENSION

Tmp extension.

See Also:

Constant Field Values

WINDOWS_EXE_EXTENSION

private static final String WINDOWS_EXE_EXTENSION

Executable extension on Windows.

See Also:

Constant Field Values

JAVA_HOME_PROPERTY

private static final String JAVA_HOME_PROPERTY

Java home property.

See Also:

Constant Field Values

TARGET_DIRECTORY

private static final String TARGET_DIRECTORY

Target directory in zipball releases.

See Also:

Constant Field Values

BIN_DIRECTORY_AND_JAVA

private static final String BIN_DIRECTORY_AND_JAVA

bin subdirectory and java executable.

JAR_ARGUMENT

private static final String JAR_ARGUMENT

Jar argument for java reloading.

See Also:

Constant Field Values

gitHubUser

private final String gitHubUser

Root URL of the GitHub project to update.

gitHubRepository

private final String gitHubRepository

GitHub repository.

mavenArtifactId

private final String mavenArtifactId

Maven artifact identifier.

jarWithDependenciesSuffix

private final String jarWithDependenciesSuffix

Suffix of the full jar including all dependencies.

downloadDone

private boolean downloadDone

Indicate if the download is completed.

versionCheckerDisabled

private boolean versionCheckerDisabled

Indicate if the version checker is disabled.

downloadedJar

private String downloadedJar

Name of the downloaded jar.

Constructor Detail

VersionChecker

public VersionChecker(String gitHubUserArg,
              String gitHubRepositoryArg,
              String mavenArtifactIdArg,
              String jarWithDependenciesSuffixArg)

Initialize the version checker with jar artifact and suffixnames and path to GitHub.

Parameters:

gitHubUserArg - GitHub user

gitHubRepositoryArg - GitHub repository

mavenArtifactIdArg - maven artifact id

jarWithDependenciesSuffixArg - suffix of the full jar including all dependencies

Method Detail

run

public void run()

Background thread launched to check the version on GitHub.

Specified by:

run in interface Runnable

findAndDownloadReleaseJar

private boolean findAndDownloadReleaseJar(org.eclipse.egit.github.core.RepositoryTag release,
                                boolean withDependenciesSuffix)
                                   throws IOException

Find a jar in release and if it is a newer version, ask to download it.

Parameters:

release - GitHub last release to use

withDependenciesSuffix - indicate if the jar to download have a dependencies suffix

Returns:

true if a new release jar has been found

Throws:

IOException - in case of reading error

restart

public boolean restart()

Restart the RunDeck monitor and use the newer jar file.

Returns:

true if a java file has been launched on the new jar file

cleanOldAndTemporaryJar

public void cleanOldAndTemporaryJar()

Clean the old jar and any existing temporary file.

deleteJar

private static void deleteJar(Path jarFileToDelete)

Delete a jar file.

Parameters:

jarFileToDelete - file to delete

currentJar

private String currentJar()

Return the current executed jar.

Returns:

the name of the current executed jar

isDownloadDone

public boolean isDownloadDone()

Get the download status.

Returns:

true if the download has been done

resetVersionCheckerDisabled

public void resetVersionCheckerDisabled()

Enable the version checker.

isversionCheckerDisabled

public boolean isversionCheckerDisabled()

Get the state of the version checker. True, if the user have disabled it.

Returns:

true if the version checker is disabled

downloadFile

private static void downloadFile(InputStream inputStream,
                String destinationFile)
                          throws IOException

Download a file/URL and write it to a destination file.

Parameters:

inputStream - source stream

destinationFile - destination file

Throws:

IOException - in case of copy error

getJavaExecutable

private static String getJavaExecutable()
                                 throws NoSuchFileException

Get the java executable.

Returns:

absolte path to the java executable

Throws:

NoSuchFileException - if the java executable is not found