io.openliberty.tools.common.plugins.util

Class InstallFeatureUtil

java.lang.Object

io.openliberty.tools.common.plugins.util.AbstractContainerSupportUtil

io.openliberty.tools.common.plugins.util.ServerFeatureUtil

io.openliberty.tools.common.plugins.util.InstallFeatureUtil

public abstract class InstallFeatureUtil
extends ServerFeatureUtil

Utility class to install features from Maven repositories.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InstallFeatureUtil.ProductProperties

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANY_CONFLICT
static String	CONFLICT
static String	CONFLICT_MESSAGE
static Pattern	conflictPattern
static String	DIFF_MODEL_CONFLICT
static String	EE_CONFLICT
static String	INCOMPATIBLE_SINGLETON
static String	INSTALL_MAP_ARTIFACT_ID
static String	MISSING_MULTIPLE_DEPENDENT
static String	OPEN_LIBERTY_GROUP_ID
static String	REPOSITORY_RESOLVER_ARTIFACT_ID
static String	SAME_INDIRECT_MODEL_CONFLICT
static String	SAME_MODEL_CONFLICT

Fields inherited from class io.openliberty.tools.common.plugins.util.ServerFeatureUtil

SERVER_CONFIG_DIR, SHARED_APP_DIR, SHARED_CONFIG_DIR, SHARED_RESOURCES_DIR, SHARED_STACKGROUP_DIR, suppressLogs, USR_EXTENSION_DIR, WLP_INSTALL_DIR, WLP_USER_DIR

Constructor Summary

Constructors

Constructor and Description
InstallFeatureUtil(File installDirectory, String from, String to, Set<String> pluginListedEsas, List<InstallFeatureUtil.ProductProperties> propertiesList, String openLibertyVersion, String containerName, List<String> additionalJsons) Initialize the utility and check for unsupported scenarios.

Method Summary

Modifier and Type	Method and Description
static Set<String>	combineToSet(Collection<String>... collections) Combine the given String collections into a set using case-insensitive matching.
static boolean	containsIgnoreCase(Collection<String> reference, Collection<String> target) Returns whether the reference collection contains all of the strings in the target collection, ignoring case.
abstract void	debug(String msg) Log debug
abstract void	debug(String msg, Throwable e) Log debug
abstract void	debug(Throwable e) Log debug
abstract File	downloadArtifact(String groupId, String artifactId, String type, String version) Download the artifact from the specified Maven coordinates, or retrieve it from the cache if it already exists.
abstract void	error(String msg) Log error
abstract void	error(String msg, Throwable e) Log error
static String	extractSymbolicName(File jar) Extracts the bundle symbolic name from the jar manifest.
static File	getMapBasedInstallKernelJar(File dir) Find latest install map jar from specified directory
static String	getNextProductVersion(String version) Gets the next product version number.
static Set<String>	getOpenLibertyFeatureSet(Set<File> jsons) Gets the set of all Open Liberty features by scanning the product JSONs.
static String	getOpenLibertyVersion(List<InstallFeatureUtil.ProductProperties> propList)
String	getOverrideBundleDescriptor(String groupId, String artifactId) Download the override bundle from the repository with the given groupId and artifactId, corresponding to the latest version in the range between the current Open Liberty version (inclusive) and the next version (exclusive).
abstract void	info(String msg) Log info
void	installFeatures(boolean isAcceptLicense, List<String> featuresList) Resolve, download, and install features from a Maven repository.
abstract boolean	isDebugEnabled() Returns whether debug is enabled by the current logger
static boolean	isOpenLibertyBetaVersion(String olVersion)
static List<InstallFeatureUtil.ProductProperties>	loadProperties(File installDir)
static String	productInfo(File installDirectory, String action) Runs the productInfo command and returns the output Made public static for tests to use in LMP/LGP
abstract void	warn(String msg) Log warning

Methods inherited from class io.openliberty.tools.common.plugins.util.ServerFeatureUtil

getServerFeatures, getServerFeatures, getServerFeatures, getServerXmlFeatures, setLowerCaseFeatures, setSuppressLogs

Methods inherited from class io.openliberty.tools.common.plugins.util.AbstractContainerSupportUtil

execDockerCmd, readStdOut

Methods inherited from class java.lang.Object

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

Field Detail

OPEN_LIBERTY_GROUP_ID

public static final String OPEN_LIBERTY_GROUP_ID

See Also:

Constant Field Values

REPOSITORY_RESOLVER_ARTIFACT_ID

public static final String REPOSITORY_RESOLVER_ARTIFACT_ID

See Also:

Constant Field Values

INSTALL_MAP_ARTIFACT_ID

public static final String INSTALL_MAP_ARTIFACT_ID

See Also:

Constant Field Values

CONFLICT

public static final String CONFLICT

See Also:

Constant Field Values

INCOMPATIBLE_SINGLETON

public static final String INCOMPATIBLE_SINGLETON

See Also:

Constant Field Values

MISSING_MULTIPLE_DEPENDENT

public static final String MISSING_MULTIPLE_DEPENDENT

See Also:

Constant Field Values

SAME_MODEL_CONFLICT

public static final String SAME_MODEL_CONFLICT

See Also:

Constant Field Values

DIFF_MODEL_CONFLICT

public static final String DIFF_MODEL_CONFLICT

See Also:

Constant Field Values

SAME_INDIRECT_MODEL_CONFLICT

public static final String SAME_INDIRECT_MODEL_CONFLICT

See Also:

Constant Field Values

EE_CONFLICT

public static final String EE_CONFLICT

See Also:

Constant Field Values

ANY_CONFLICT

public static final String ANY_CONFLICT

See Also:

Constant Field Values

conflictPattern

public static final Pattern conflictPattern

CONFLICT_MESSAGE

public static final String CONFLICT_MESSAGE

See Also:

Constant Field Values

Constructor Detail

InstallFeatureUtil

public InstallFeatureUtil(File installDirectory,
                          String from,
                          String to,
                          Set<String> pluginListedEsas,
                          List<InstallFeatureUtil.ProductProperties> propertiesList,
                          String openLibertyVersion,
                          String containerName,
                          List<String> additionalJsons)
                   throws PluginScenarioException,
                          PluginExecutionException

Initialize the utility and check for unsupported scenarios.

Parameters:

installDirectory - The install directory

from - The "from" parameter specified in the plugin configuration, or null if not specified

to - The "to" parameter specified in the plugin configuration, or null if not specified

pluginListedEsas - The list of ESAs specified in the plugin configuration, or null if not specified

propertiesList - The list of product properties installed with the Open Liberty runtime

openLibertyVersion - The version of the Open Liberty runtime

containerName - The container name if the features should be installed in a container. Otherwise null.

additionalJsons - The list of additional JSONS to search for features from

Throws:

PluginScenarioException - If the current scenario is not supported

PluginExecutionException - If properties files cannot be found in the installDirectory/lib/versions

Method Detail

debug

public abstract void debug(String msg)

Log debug

Specified by:

debug in class ServerFeatureUtil

Parameters:

msg -

debug

public abstract void debug(String msg,
                           Throwable e)

Log debug

Specified by:

debug in class ServerFeatureUtil

Parameters:

msg -

e -

debug

public abstract void debug(Throwable e)

Log debug

Specified by:

debug in class ServerFeatureUtil

Parameters:

e -

warn

public abstract void warn(String msg)

Log warning

Specified by:

warn in class ServerFeatureUtil

Parameters:

msg -

info

public abstract void info(String msg)

Log info

Specified by:

info in class ServerFeatureUtil

Parameters:

msg -

error

public abstract void error(String msg)

Log error

Parameters:

msg -

error

public abstract void error(String msg,
                           Throwable e)

Log error

Specified by:

error in class AbstractContainerSupportUtil

Parameters:

msg -

e -

isDebugEnabled

public abstract boolean isDebugEnabled()

Returns whether debug is enabled by the current logger

Returns:

whether debug is enabled

downloadArtifact

public abstract File downloadArtifact(String groupId,
                                      String artifactId,
                                      String type,
                                      String version)
                               throws PluginExecutionException

Download the artifact from the specified Maven coordinates, or retrieve it from the cache if it already exists.

Parameters:

groupId - The group ID

artifactId - The artifact ID

type - The type e.g. esa

version - The version

Returns:

The file corresponding to the downloaded artifact

Throws:

PluginExecutionException - If the artifact could not be downloaded

combineToSet

@SafeVarargs
public static Set<String> combineToSet(Collection<String>... collections)

Combine the given String collections into a set using case-insensitive matching. If there are multiple instances of the same string but with different capitalization, only the first one found will be included.

Parameters:

collections - a collection of strings

Returns:

the combined set of strings, ignoring case

loadProperties

public static List<InstallFeatureUtil.ProductProperties> loadProperties(File installDir)
                                                                 throws PluginExecutionException

Throws:

PluginExecutionException

getOpenLibertyVersion

public static String getOpenLibertyVersion(List<InstallFeatureUtil.ProductProperties> propList)

isOpenLibertyBetaVersion

public static boolean isOpenLibertyBetaVersion(String olVersion)

getOpenLibertyFeatureSet

public static Set<String> getOpenLibertyFeatureSet(Set<File> jsons)
                                            throws PluginExecutionException

Gets the set of all Open Liberty features by scanning the product JSONs.

Parameters:

jsons - The set of product JSON files to scan

Returns:

set of all Open Liberty features

Throws:

PluginExecutionException - if any of the JSONs could not be found

containsIgnoreCase

public static boolean containsIgnoreCase(Collection<String> reference,
                                         Collection<String> target)

Returns whether the reference collection contains all of the strings in the target collection, ignoring case.

Parameters:

reference - The reference collection

target - The target collection

Returns:

true if reference contains all Strings from target, ignoring case

installFeatures

public void installFeatures(boolean isAcceptLicense,
                            List<String> featuresList)
                     throws PluginExecutionException

Resolve, download, and install features from a Maven repository. This method calls the resolver with the given JSONs and feature list, downloads the ESAs corresponding to the resolved features, then installs those features.

Parameters:

jsonRepos - JSON files, each containing an array of metadata for all features in a Liberty release.

featuresList - The list of features to install.

Throws:

PluginExecutionException - if any of the features could not be installed

getOverrideBundleDescriptor

public String getOverrideBundleDescriptor(String groupId,
                                          String artifactId)
                                   throws PluginExecutionException

Download the override bundle from the repository with the given groupId and artifactId, corresponding to the latest version in the range between the current Open Liberty version (inclusive) and the next version (exclusive). Returns a string in the format "filepath;BundleName" where BundleName is the bundle symbolic name from its manifest.

Parameters:

groupId - the groupId of the bundle to download

artifactId - the artifactId of the bundle to download

Returns:

a String representing the bundle in filepath;BundleName format

Throws:

PluginExecutionException

getNextProductVersion

public static String getNextProductVersion(String version)
                                    throws PluginExecutionException

Gets the next product version number.

Parameters:

version - the product version

Returns:

the String representation of the next product version

Throws:

PluginExecutionException

extractSymbolicName

public static String extractSymbolicName(File jar)
                                  throws PluginExecutionException

Extracts the bundle symbolic name from the jar manifest.

Parameters:

jar - the jar from which the symbolic name will be extracted

Returns:

the Bundle-SymbolicName

Throws:

PluginExecutionException

getMapBasedInstallKernelJar

public static File getMapBasedInstallKernelJar(File dir)

Find latest install map jar from specified directory

Returns:

the install map jar file

productInfo

public static String productInfo(File installDirectory,
                                 String action)
                          throws PluginExecutionException

Runs the productInfo command and returns the output Made public static for tests to use in LMP/LGP

Parameters:

installDirectory - The directory of the installed runtime

action - The action to perform for the productInfo command

Returns:

The command output

Throws:

PluginExecutionException - if the exit value of the command was not 0