com.compuware.jenkins.common.utils

Class CLIVersionUtils

java.lang.Object

com.compuware.jenkins.common.utils.CLIVersionUtils

public class CLIVersionUtils
extends Object

Utility class used to check the version of the installed Topaz CLI.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOST_CONNECTION_PROTOCOL_MINIMUM_VERSION

Method Summary

Modifier and Type	Method and Description
static void	checkCLICompatibility(hudson.FilePath cliDirectory, String minimumVersion) Checks if the version of the installed Topaz CLI is greater or equal to the Jenkins plugins required version.
static void	checkCLICompatibility(String version, String minimumVersion) Checks if the version of the installed Topaz CLI is greater or equal to the Jenkins plugins required version.
static void	checkProtocolSupported(String cliVersion) Checks if encryption protocol is supported on a host connection for the specified CLI version.
static String	getCLIVersion(hudson.FilePath cliDirectory, String minimumVersion) Reads the version.xml file from the CLI directory and gets the version number.

Methods inherited from class java.lang.Object

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

Field Detail

HOST_CONNECTION_PROTOCOL_MINIMUM_VERSION

public static final String HOST_CONNECTION_PROTOCOL_MINIMUM_VERSION

See Also:

Constant Field Values

Method Detail

getCLIVersion

public static String getCLIVersion(hudson.FilePath cliDirectory,
                                   String minimumVersion)
                            throws IOException,
                                   InterruptedException

Reads the version.xml file from the CLI directory and gets the version number.

Parameters:

cliDirectory - FilePath of the Topaz CLI install directory

minimumVersion - Minimum required CLI version of the Jenkins plugin

Returns:

the CLI version

Throws:

IOException - if the CLI directory or the version file do not exist

InterruptedException - if retrieval of CLI version is interrupted by another thread

checkCLICompatibility

public static void checkCLICompatibility(String version,
                                         String minimumVersion)
                                  throws IOException,
                                         InterruptedException

Checks if the version of the installed Topaz CLI is greater or equal to the Jenkins plugins required version. This will abort the Jenkins job if CLI is not compatible.

Parameters:

version - current CLI version

minimumVersion - minimum required CLI version of the Jenkins plugin

Throws:

IOException - if an I/O error occurs checking directory existence or getting the CLI version

InterruptedException - if checking directory existence or getting the CLI version is interrupted by another thread

checkCLICompatibility

public static void checkCLICompatibility(hudson.FilePath cliDirectory,
                                         String minimumVersion)
                                  throws IOException,
                                         InterruptedException

Checks if the version of the installed Topaz CLI is greater or equal to the Jenkins plugins required version. This will abort the Jenkins job if CLI is not compatible.

Parameters:

cliDirectory - FilePath of the Topaz CLI install directory

minimumVersion - minimum required CLI version of the Jenkins plugin

Throws:

IOException - if an I/O error occurs checking directory existence or getting the CLI version

InterruptedException - if checking directory existence or getting the CLI version is interrupted by another thread

checkProtocolSupported

public static void checkProtocolSupported(String cliVersion)
                                   throws hudson.AbortException

Checks if encryption protocol is supported on a host connection for the specified CLI version.

The Jenkins job will be aborted if the CLI does not support encryption protocol.

Parameters:

cliVersion - the CLI version to check

Throws:

hudson.AbortException - if the encryption protocol is not supported