org.jahia.utils

Class PomUtils

java.lang.Object

org.jahia.utils.PomUtils

public final class PomUtils
extends Object

Utility class for reading and manipulating Maven project files (pom.xml).

Author:

Sergiy Shyrkov

Method Summary

Modifier and Type	Method and Description
static File	extractPomFromJar(JarFile jar, String groupId, String artifactId)
static String	getGroupId(org.apache.maven.model.Model model) Gets the artifact group ID from the provided model.
static String	getVersion(File pomXmlFile) Reads the artifact version from the provided pom.xml file.
static String	getVersion(org.apache.maven.model.Model model) Gets the artifact version from the provided model.
static org.apache.maven.model.Model	read(File pomXmlFile) Parses the Maven project model from the specified pom.xml file.
static org.apache.maven.model.Model	read(InputStream pomXmlStream) Parses the Maven project model from the specified pom.xml input stream.
static void	updateDistributionManagement(File pomXmlFile, String repositoryId, String repositoryUrl) Updates the distribution management repository in the specified Maven project file.
static void	updateForgeUrl(File pomXmlFile, String forgeUrl)
static void	updateJahiaDepends(File pomXmlFile, String depends, boolean useProperties) Updates the Jahia-Depends information in the maven-bundle-plugin to reflect the new list of dependencies.
static void	updateScm(File pomXmlFile, String scmUrl) Updates the SCM connection URL in the specified Maven project file.
static void	updateVersion(File pomXmlFile, String version) Updates the project version in the specified Maven project file.
static void	write(org.apache.maven.model.Model model, File targetPomXmlFile) Serializes Maven project model into a specified file.

Methods inherited from class java.lang.Object

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

Method Detail

getGroupId

public static String getGroupId(org.apache.maven.model.Model model)

Gets the artifact group ID from the provided model. If the artifact group ID is not specified, takes the group ID of the parent, if present. Otherwise returns null.

Parameters:

model - the Maven project model

Returns:

the artifact group ID from the provided model. If the artifact group ID is not specified, takes the group ID of the parent, if present. Otherwise returns null

getVersion

public static String getVersion(File pomXmlFile)
                         throws IOException,
                                org.codehaus.plexus.util.xml.pull.XmlPullParserException

Reads the artifact version from the provided pom.xml file. If the artifact version is not specified, takes the version of the parent, if present. Otherwise returns null.

Parameters:

pomXmlFile - the Maven project descriptor file to read

Returns:

the artifact version from the provided pom.xml file. If the artifact version is not specified, takes the version of the parent, if present. Otherwise returns null

Throws:

IOException - in case of a reading problem

org.codehaus.plexus.util.xml.pull.XmlPullParserException - in case of a parsing error

getVersion

public static String getVersion(org.apache.maven.model.Model model)

Gets the artifact version from the provided model. If the artifact version is not specified, takes the version of the parent, if present. Otherwise returns null.

Parameters:

model - the Maven project model

Returns:

the artifact version from the provided model. If the artifact version is not specified, takes the version of the parent, if present. Otherwise returns null

read

public static org.apache.maven.model.Model read(File pomXmlFile)
                                         throws IOException,
                                                org.codehaus.plexus.util.xml.pull.XmlPullParserException

Parses the Maven project model from the specified pom.xml file.

Parameters:

pomXmlFile - the Maven project descriptor to read model from

Returns:

the Maven project model from the specified pom.xml file

Throws:

IOException - in case of a reading problem

org.codehaus.plexus.util.xml.pull.XmlPullParserException - in case of a parsing error

read

public static org.apache.maven.model.Model read(InputStream pomXmlStream)
                                         throws IOException,
                                                org.codehaus.plexus.util.xml.pull.XmlPullParserException

Parses the Maven project model from the specified pom.xml input stream.

Parameters:

pomXmlStream - the Maven project descriptor input stream to read model from

Returns:

the Maven project model from the specified pom.xml input stream

Throws:

IOException - in case of a reading problem

org.codehaus.plexus.util.xml.pull.XmlPullParserException - in case of a parsing error

Since:

7.2.2.0

updateDistributionManagement

public static void updateDistributionManagement(File pomXmlFile,
                                                String repositoryId,
                                                String repositoryUrl)
                                         throws IOException,
                                                org.codehaus.plexus.util.xml.pull.XmlPullParserException

Updates the distribution management repository in the specified Maven project file.

Parameters:

pomXmlFile - the Maven project descriptor file to update

repositoryId - the server ID for the distribution repository

repositoryUrl - the URL of the target distribution repository

Throws:

IOException - in case of a reading problem

org.codehaus.plexus.util.xml.pull.XmlPullParserException - in case of a parsing error

updateForgeUrl

public static void updateForgeUrl(File pomXmlFile,
                                  String forgeUrl)
                           throws IOException,
                                  org.codehaus.plexus.util.xml.pull.XmlPullParserException

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

updateJahiaDepends

public static void updateJahiaDepends(File pomXmlFile,
                                      String depends,
                                      boolean useProperties)
                               throws IOException,
                                      org.codehaus.plexus.util.xml.pull.XmlPullParserException

Updates the Jahia-Depends information in the maven-bundle-plugin to reflect the new list of dependencies.

Parameters:

pomXmlFile - the Maven project descriptor file to update

depends - comma-separated list of dependencies

useProperties -

Throws:

IOException - in case of a reading problem

org.codehaus.plexus.util.xml.pull.XmlPullParserException - in case of a parsing error

updateScm

public static void updateScm(File pomXmlFile,
                             String scmUrl)
                      throws IOException,
                             org.codehaus.plexus.util.xml.pull.XmlPullParserException

Updates the SCM connection URL in the specified Maven project file.

Parameters:

pomXmlFile - the Maven project descriptor file to update

scmUrl - the SCM connection URL to set

Throws:

IOException - in case of a reading problem

org.codehaus.plexus.util.xml.pull.XmlPullParserException - in case of a parsing error

updateVersion

public static void updateVersion(File pomXmlFile,
                                 String version)
                          throws IOException,
                                 org.codehaus.plexus.util.xml.pull.XmlPullParserException

Updates the project version in the specified Maven project file.

Parameters:

pomXmlFile - the Maven project descriptor file to update

version - the new version to set

Throws:

IOException - in case of a reading problem

org.codehaus.plexus.util.xml.pull.XmlPullParserException - in case of a parsing error

write

public static void write(org.apache.maven.model.Model model,
                         File targetPomXmlFile)
                  throws IOException

Serializes Maven project model into a specified file.

Parameters:

model - the Maven project model to serialize

targetPomXmlFile - the target file to write the provided model into

Throws:

IOException - in case of a serialization error

extractPomFromJar

public static File extractPomFromJar(JarFile jar,
                                     String groupId,
                                     String artifactId)
                              throws IOException

Throws:

IOException