io.openliberty.tools.maven

Class InstallFeatureSupport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.pluginsupport.MojoSupport

io.openliberty.tools.maven.AbstractLibertySupport

io.openliberty.tools.maven.BasicSupport

io.openliberty.tools.maven.InstallFeatureSupport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Direct Known Subclasses:

CompileJspMojo, InstallFeatureMojo

public class InstallFeatureSupport
extends BasicSupport

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	InstallFeatureSupport.InstallFeatureMojoUtil

Nested classes/interfaces inherited from class io.openliberty.tools.maven.BasicSupport

BasicSupport.InstallType

Field Summary

Fields

Modifier and Type	Field and Description
protected Features	features Define a set of features to install in the server and the configuration to be applied for all instances.
boolean	installFromAnt
boolean	noFeaturesSection

Fields inherited from class io.openliberty.tools.maven.BasicSupport

assemblyArchive, assemblyArtifact, assemblyInstallDirectory, configDirectory, defaultOutputDirSet, install, installDirectory, installType, isInstall, libertyRuntimeVersion, licenseArtifact, mergeServerEnv, messages, outputDirectory, refresh, serverDirectory, serverEnvFile, serverName, skip, START_APP_MESSAGE_REGEXP, userDirectory

Fields inherited from class io.openliberty.tools.maven.AbstractLibertySupport

ant, artifactRepository, mavenProjectBuilder, project, reactorProjects, repoSession, repositories, repositorySystem, session, settings

Fields inherited from class org.codehaus.mojo.pluginsupport.MojoSupport

container, log

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
InstallFeatureSupport()

Method Summary

Modifier and Type	Method and Description
protected Set<String>	getDependencyFeatures()
protected io.openliberty.tools.common.plugins.util.InstallFeatureUtil	getInstallFeatureUtil(Set<String> pluginListedEsas, List<io.openliberty.tools.common.plugins.util.InstallFeatureUtil.ProductProperties> propertiesList, String openLibertyVerion, String containerName) Get a new instance of InstallFeatureUtil
protected Set<String>	getPluginListedFeatures(boolean findEsaFiles)
protected Set<String>	getSpecifiedFeatures(String containerName) Get the current specified Liberty features.
protected boolean	initialize()

Methods inherited from class io.openliberty.tools.maven.BasicSupport

checkServerDirectoryExists, checkServerHomeExists, deleteApplication, deleteApplication, getLibertyDirectoryPropertyFiles, getLibertyDirectoryPropertyFiles, init, installFromArchive, installFromFile, installLicense, installServerAssembly, stripVersionFromName

Methods inherited from class io.openliberty.tools.maven.AbstractLibertySupport

createArtifact, createArtifactItem, dependencyTrailContainsArtifact, findTransitiveDependencies, getArtifact, getArtifact, getArtifactRepository, getProject, getReactorMavenProject, getResolvedDependencyWithTransitiveDependencies, isReactorMavenProject

Methods inherited from class org.codehaus.mojo.pluginsupport.MojoSupport

contextualize, doExecute, execute, getArtifactFactory, getArtifactResolver, getProjectArtifacts, getProjectArtifacts, getProjectArtifacts, resolveArtifact, resolveArtifact

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

features

@Parameter
protected Features features

Define a set of features to install in the server and the configuration to be applied for all instances.

noFeaturesSection

public boolean noFeaturesSection

installFromAnt

public boolean installFromAnt

Constructor Detail

InstallFeatureSupport

public InstallFeatureSupport()

Method Detail

getPluginListedFeatures

protected Set<String> getPluginListedFeatures(boolean findEsaFiles)

getDependencyFeatures

protected Set<String> getDependencyFeatures()

initialize

protected boolean initialize()
                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getSpecifiedFeatures

protected Set<String> getSpecifiedFeatures(String containerName)
                                    throws io.openliberty.tools.common.plugins.util.PluginExecutionException

Get the current specified Liberty features.

Parameters:

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

Returns:

Set of Strings containing the specified Liberty features

Throws:

io.openliberty.tools.common.plugins.util.PluginExecutionException

getInstallFeatureUtil

protected io.openliberty.tools.common.plugins.util.InstallFeatureUtil getInstallFeatureUtil(Set<String> pluginListedEsas,
                                                                                            List<io.openliberty.tools.common.plugins.util.InstallFeatureUtil.ProductProperties> propertiesList,
                                                                                            String openLibertyVerion,
                                                                                            String containerName)
                                                                                     throws io.openliberty.tools.common.plugins.util.PluginExecutionException

Get a new instance of InstallFeatureUtil

Parameters:

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.

Returns:

instance of InstallFeatureUtil

Throws:

io.openliberty.tools.common.plugins.util.PluginExecutionException