org.apache.maven.shared.release.phase

Class AbstractRewritePomsPhase

java.lang.Object

org.apache.maven.shared.release.phase.AbstractReleasePhase

org.apache.maven.shared.release.phase.AbstractRewritePomsPhase

All Implemented Interfaces:

ReleasePhase, ResourceGenerator

Direct Known Subclasses:

RewritePomsForBranchPhase, RewritePomsForDevelopmentPhase, RewritePomsForReleasePhase, RewritePomVersionsPhase

public abstract class AbstractRewritePomsPhase
extends AbstractReleasePhase
implements ResourceGenerator

Base class for rewriting phases.

Author:

Brett Porter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRewritePomsPhase(ScmRepositoryConfigurator scmRepositoryConfigurator, Map<String,ModelETLFactory> modelETLFactories, Map<String,ScmTranslator> scmTranslators)

Method Summary

Modifier and Type	Method and Description
ReleaseResult	clean(List<org.apache.maven.project.MavenProject> reactorProjects)
ReleaseResult	execute(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects)
static String	extractPropertyFromExpression(String expression) Extracts the Maven property name from a given expression.
protected abstract String	getNextVersion(ReleaseDescriptor releaseDescriptor, String key) getNextVersion.
protected String	getOriginalResolvedSnapshotVersion(String artifactVersionlessKey, ReleaseDescriptor releaseDescriptor) getOriginalResolvedSnapshotVersion.
protected abstract String	getOriginalVersion(ReleaseDescriptor releaseDescriptor, String projectKey, boolean simulate) getOriginalVersion.
protected abstract String	getPomSuffix() getPomSuffix.
protected abstract String	getResolvedSnapshotVersion(String artifactVersionlessKey, ReleaseDescriptor releaseDscriptor) getResolvedSnapshotVersion.
protected Map<String,ScmTranslator>	getScmTranslators() Getter for the field scmTranslators.
static boolean	isCiFriendlyVersion(String version)
protected boolean	isUpdateScm() isUpdateScm.
void	setModelETL(String modelETL) Setter for the field modelETL.
void	setStartTime(long startTime) Setter for the field startTime.
ReleaseResult	simulate(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects)
protected abstract void	transformScm(org.apache.maven.project.MavenProject project, org.apache.maven.model.Model modelTarget, ReleaseDescriptor releaseDescriptor, String projectId, org.apache.maven.scm.repository.ScmRepository scmRepository, ReleaseResult result) transformScm.
protected static String	translateUrlPath(String trunkPath, String tagPath, String urlPath) Determines the relative path from trunk to tag, and adds this relative path to the url.

Methods inherited from class org.apache.maven.shared.release.phase.AbstractReleasePhase

getLogger, getReleaseResultSuccess, logDebug, logDebug, logError, logInfo, logWarn

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRewritePomsPhase

protected AbstractRewritePomsPhase(ScmRepositoryConfigurator scmRepositoryConfigurator,
                                   Map<String,ModelETLFactory> modelETLFactories,
                                   Map<String,ScmTranslator> scmTranslators)

Method Detail

getScmTranslators

protected final Map<String,ScmTranslator> getScmTranslators()

Getter for the field scmTranslators.

Returns:

a Map object

setModelETL

public void setModelETL(String modelETL)

Setter for the field modelETL.

Parameters:

modelETL - a String object

setStartTime

public void setStartTime(long startTime)

Setter for the field startTime.

Parameters:

startTime - a long

getPomSuffix

protected abstract String getPomSuffix()

getPomSuffix.

Returns:

a String object

execute

public ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
                             ReleaseEnvironment releaseEnvironment,
                             List<org.apache.maven.project.MavenProject> reactorProjects)
                      throws ReleaseExecutionException,
                             ReleaseFailureException

Specified by:

execute in interface ReleasePhase

Throws:

ReleaseExecutionException

ReleaseFailureException

simulate

public ReleaseResult simulate(ReleaseDescriptor releaseDescriptor,
                              ReleaseEnvironment releaseEnvironment,
                              List<org.apache.maven.project.MavenProject> reactorProjects)
                       throws ReleaseExecutionException,
                              ReleaseFailureException

Specified by:

simulate in interface ReleasePhase

Throws:

ReleaseExecutionException

ReleaseFailureException

clean

public ReleaseResult clean(List<org.apache.maven.project.MavenProject> reactorProjects)

Specified by:

clean in interface ResourceGenerator

extractPropertyFromExpression

public static String extractPropertyFromExpression(String expression)

Extracts the Maven property name from a given expression.

Parameters:

expression - the expression

Returns:

either null if value is no expression otherwise the property referenced in the expression

isCiFriendlyVersion

public static boolean isCiFriendlyVersion(String version)

getResolvedSnapshotVersion

protected abstract String getResolvedSnapshotVersion(String artifactVersionlessKey,
                                                     ReleaseDescriptor releaseDscriptor)

getResolvedSnapshotVersion.

Parameters:

artifactVersionlessKey - a String object

releaseDscriptor - a ReleaseDescriptor object

Returns:

a String object

getOriginalVersion

protected abstract String getOriginalVersion(ReleaseDescriptor releaseDescriptor,
                                             String projectKey,
                                             boolean simulate)

getOriginalVersion.

Parameters:

releaseDescriptor - a ReleaseDescriptor object

projectKey - a String object

simulate - a boolean

Returns:

a String object

getNextVersion

protected abstract String getNextVersion(ReleaseDescriptor releaseDescriptor,
                                         String key)

getNextVersion.

Parameters:

releaseDescriptor - a ReleaseDescriptor object

key - a String object

Returns:

a String object

transformScm

protected abstract void transformScm(org.apache.maven.project.MavenProject project,
                                     org.apache.maven.model.Model modelTarget,
                                     ReleaseDescriptor releaseDescriptor,
                                     String projectId,
                                     org.apache.maven.scm.repository.ScmRepository scmRepository,
                                     ReleaseResult result)
                              throws ReleaseExecutionException

transformScm.

Parameters:

project - a MavenProject object

modelTarget - a Model object

releaseDescriptor - a ReleaseDescriptor object

projectId - a String object

scmRepository - a ScmRepository object

result - a ReleaseResult object

Throws:

ReleaseExecutionException - if any.

isUpdateScm

protected boolean isUpdateScm()

isUpdateScm.

Returns:

true if the SCM-section should be updated, otherwise false

Since:

2.4

getOriginalResolvedSnapshotVersion

protected String getOriginalResolvedSnapshotVersion(String artifactVersionlessKey,
                                                    ReleaseDescriptor releaseDescriptor)

getOriginalResolvedSnapshotVersion.

Parameters:

artifactVersionlessKey - a String object

releaseDescriptor - a ReleaseDescriptor object

Returns:

a String object

translateUrlPath

protected static String translateUrlPath(String trunkPath,
                                         String tagPath,
                                         String urlPath)

Determines the relative path from trunk to tag, and adds this relative path to the url.

Parameters:

trunkPath - - The trunk url

tagPath - - The tag base

urlPath - - scm.url or scm.connection

Returns:

The url path for the tag.