io.openliberty.tools.maven.utils

Class MavenProjectUtil

java.lang.Object

io.openliberty.tools.maven.utils.MavenProjectUtil

public class MavenProjectUtil
extends Object

Constructor Summary

Constructors

Constructor and Description
MavenProjectUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	doesPluginGoalExecutionExist(org.apache.maven.project.MavenProject project, String pluginKey, String goal) Checks that the plugin exists for the given pluginKey.
static int	getMajorPluginVersion(org.apache.maven.project.MavenProject project, String pluginKey) Get major plugin version
static File	getManifestFile(org.apache.maven.project.MavenProject proj, String pluginArtifactId) Get manifest file from plugin configuration
static String	getPluginConfiguration(org.apache.maven.project.MavenProject proj, String pluginGroupId, String pluginArtifactId, String key) Get a configuration value from a plugin
static String	getPluginExecutionConfiguration(org.apache.maven.project.MavenProject proj, String pluginGroupId, String pluginArtifactId, String executionId, String key) Get a configuration value from an execution of a plugin
static String	getPluginGoalConfigurationString(org.apache.maven.project.MavenProject project, String pluginKey, String goal, String configName) Get a configuration value from a goal from a plugin
static org.apache.maven.model.PluginExecution	getPluginGoalExecution(org.apache.maven.project.MavenProject project, String pluginKey, String goal) Get an execution of a plugin
static org.apache.maven.model.PluginExecution	getPluginGoalExecution(org.apache.maven.model.Plugin plugin, String goal) Get an execution of a plugin
static Map<String,String>	getWebResourcesConfiguration(org.apache.maven.project.MavenProject proj) Get directory and targetPath configuration values from the Maven WAR plugin

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenProjectUtil

public MavenProjectUtil()

Method Detail

getPluginConfiguration

public static String getPluginConfiguration(org.apache.maven.project.MavenProject proj,
                                            String pluginGroupId,
                                            String pluginArtifactId,
                                            String key)

Get a configuration value from a plugin

Parameters:

proj - the Maven project

pluginGroupId - the plugin group id

pluginArtifactId - the plugin artifact id

key - the configuration key to get from

Returns:

the value corresponding to the configuration key

getPluginExecutionConfiguration

public static String getPluginExecutionConfiguration(org.apache.maven.project.MavenProject proj,
                                                     String pluginGroupId,
                                                     String pluginArtifactId,
                                                     String executionId,
                                                     String key)

Get a configuration value from an execution of a plugin

Parameters:

proj - the Maven project

pluginGroupId - the plugin group id

pluginArtifactId - the plugin artifact id

executionId - the plugin execution id

key - the configuration key to get from

Returns:

the value corresponding to the configuration key

getWebResourcesConfiguration

public static Map<String,String> getWebResourcesConfiguration(org.apache.maven.project.MavenProject proj)

Get directory and targetPath configuration values from the Maven WAR plugin

Parameters:

proj - the Maven project

Returns:

a Map of source and target directories corresponding to the configuration keys or null if the war plugin or its webResources or resource elements are not used. The map will be empty if the directory element is not used. The value field of the map is null when the targetPath element is not used.

getPluginGoalConfigurationString

public static String getPluginGoalConfigurationString(org.apache.maven.project.MavenProject project,
                                                      String pluginKey,
                                                      String goal,
                                                      String configName)
                                               throws io.openliberty.tools.common.plugins.util.PluginScenarioException

Get a configuration value from a goal from a plugin

Parameters:

project -

pluginKey -

goal -

configName -

Returns:

the value of the configuration parameter

Throws:

io.openliberty.tools.common.plugins.util.PluginScenarioException

doesPluginGoalExecutionExist

public static boolean doesPluginGoalExecutionExist(org.apache.maven.project.MavenProject project,
                                                   String pluginKey,
                                                   String goal)

Checks that the plugin exists for the given pluginKey.

getPluginGoalExecution

public static org.apache.maven.model.PluginExecution getPluginGoalExecution(org.apache.maven.model.Plugin plugin,
                                                                            String goal)
                                                                     throws io.openliberty.tools.common.plugins.util.PluginScenarioException

Get an execution of a plugin

Parameters:

plugin -

goal -

Returns:

the execution object

Throws:

io.openliberty.tools.common.plugins.util.PluginScenarioException

getPluginGoalExecution

public static org.apache.maven.model.PluginExecution getPluginGoalExecution(org.apache.maven.project.MavenProject project,
                                                                            String pluginKey,
                                                                            String goal)
                                                                     throws io.openliberty.tools.common.plugins.util.PluginScenarioException

Get an execution of a plugin

Parameters:

project -

pluginKey -

goal -

Returns:

the execution object

Throws:

io.openliberty.tools.common.plugins.util.PluginScenarioException

getManifestFile

public static File getManifestFile(org.apache.maven.project.MavenProject proj,
                                   String pluginArtifactId)

Get manifest file from plugin configuration

Parameters:

proj -

pluginArtifactId -

Returns:

the manifest file

getMajorPluginVersion

public static int getMajorPluginVersion(org.apache.maven.project.MavenProject project,
                                        String pluginKey)
                                 throws io.openliberty.tools.common.plugins.util.PluginScenarioException

Get major plugin version

Parameters:

project -

pluginKey -

Returns:

the major plugin version

Throws:

io.openliberty.tools.common.plugins.util.PluginScenarioException