org.apache.maven.shared.release.phase

Class AbstractScmCommitPhase

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

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

org.apache.maven.shared.release.phase.AbstractScmCommitPhase

All Implemented Interfaces:

ReleasePhase, org.codehaus.plexus.logging.LogEnabled

Direct Known Subclasses:

ScmCommitDevelopmentPhase, ScmCommitPreparationPhase

public abstract class AbstractScmCommitPhase
extends AbstractReleasePhase

Holds the basic concept of committing changes to the current working copy.

Author:

Brett Porter, Lars Corneliussen

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	afterBranchOrTag
protected boolean	beforeBranchOrTag
protected String	descriptorCommentGetter The getter in the descriptor for the comment.
protected ScmRepositoryConfigurator	scmRepositoryConfigurator Tool that gets a configured SCM repository from release configuration.

Constructor Summary

Constructors

Constructor and Description
AbstractScmCommitPhase()

Method Summary

Modifier and Type	Method and Description
protected String	createMessage(List<MavenProject> reactorProjects, ReleaseDescriptor releaseDescriptor) createMessage.
protected static List<File>	createPomFiles(ReleaseDescriptor releaseDescriptor, List<MavenProject> reactorProjects) createPomFiles.
protected static List<File>	createPomFiles(ReleaseDescriptor releaseDescriptor, MavenProject project) createPomFiles.
ReleaseResult	execute(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<MavenProject> reactorProjects)
protected void	performCheckins(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<MavenProject> reactorProjects, String message) performCheckins.
protected abstract void	runLogic(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<MavenProject> reactorProjects, ReleaseResult result, boolean simulating) runLogic.
ReleaseResult	simulate(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<MavenProject> reactorProjects)
protected void	simulateCheckins(ReleaseDescriptor releaseDescriptor, List<MavenProject> reactorProjects, ReleaseResult result, String message) simulateCheckins.
protected void	validateConfiguration(ReleaseDescriptor releaseDescriptor) validateConfiguration.

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

getReleaseResultSuccess, logDebug, logDebug, logError, logInfo, logWarn

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

beforeBranchOrTag

protected boolean beforeBranchOrTag

afterBranchOrTag

protected boolean afterBranchOrTag

scmRepositoryConfigurator

protected ScmRepositoryConfigurator scmRepositoryConfigurator

Tool that gets a configured SCM repository from release configuration.

descriptorCommentGetter

protected String descriptorCommentGetter

The getter in the descriptor for the comment.

Constructor Detail

AbstractScmCommitPhase

public AbstractScmCommitPhase()

Method Detail

execute

public ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
                             ReleaseEnvironment releaseEnvironment,
                             List<MavenProject> reactorProjects)
                      throws ReleaseExecutionException,
                             ReleaseFailureException

Throws:

ReleaseExecutionException

ReleaseFailureException

simulate

public ReleaseResult simulate(ReleaseDescriptor releaseDescriptor,
                              ReleaseEnvironment releaseEnvironment,
                              List<MavenProject> reactorProjects)
                       throws ReleaseExecutionException,
                              ReleaseFailureException

Throws:

ReleaseExecutionException

ReleaseFailureException

runLogic

protected abstract void runLogic(ReleaseDescriptor releaseDescriptor,
                                 ReleaseEnvironment releaseEnvironment,
                                 List<MavenProject> reactorProjects,
                                 ReleaseResult result,
                                 boolean simulating)
                          throws ReleaseScmCommandException,
                                 ReleaseExecutionException,
                                 ReleaseScmRepositoryException

runLogic.

Parameters:

releaseDescriptor - a ReleaseDescriptor object

releaseEnvironment - a ReleaseEnvironment object

reactorProjects - a List object

result - a ReleaseResult object

simulating - a boolean

Throws:

ReleaseScmCommandException - if any.

ReleaseExecutionException - if any.

ReleaseScmRepositoryException - if any.

performCheckins

protected void performCheckins(ReleaseDescriptor releaseDescriptor,
                               ReleaseEnvironment releaseEnvironment,
                               List<MavenProject> reactorProjects,
                               String message)
                        throws ReleaseScmRepositoryException,
                               ReleaseExecutionException,
                               ReleaseScmCommandException

performCheckins.

Parameters:

releaseDescriptor - a ReleaseDescriptor object

releaseEnvironment - a ReleaseEnvironment object

reactorProjects - a List object

message - a String object

Throws:

ReleaseScmRepositoryException - if any.

ReleaseExecutionException - if any.

ReleaseScmCommandException - if any.

simulateCheckins

protected void simulateCheckins(ReleaseDescriptor releaseDescriptor,
                                List<MavenProject> reactorProjects,
                                ReleaseResult result,
                                String message)

simulateCheckins.

Parameters:

releaseDescriptor - a ReleaseDescriptor object

reactorProjects - a List object

result - a ReleaseResult object

message - a String object

validateConfiguration

protected void validateConfiguration(ReleaseDescriptor releaseDescriptor)
                              throws ReleaseFailureException

validateConfiguration.

Parameters:

releaseDescriptor - a ReleaseDescriptor object

Throws:

ReleaseFailureException - if any.

createMessage

protected String createMessage(List<MavenProject> reactorProjects,
                               ReleaseDescriptor releaseDescriptor)
                        throws ReleaseExecutionException

createMessage.

Parameters:

reactorProjects - a List object

releaseDescriptor - a ReleaseDescriptor object

Returns:

a String object

Throws:

ReleaseExecutionException - if any.

createPomFiles

protected static List<File> createPomFiles(ReleaseDescriptor releaseDescriptor,
                                           MavenProject project)

createPomFiles.

Parameters:

releaseDescriptor - a ReleaseDescriptor object

project - a MavenProject object

Returns:

a List object

createPomFiles

protected static List<File> createPomFiles(ReleaseDescriptor releaseDescriptor,
                                           List<MavenProject> reactorProjects)

createPomFiles.

Parameters:

releaseDescriptor - a ReleaseDescriptor object

reactorProjects - a List object

Returns:

a List object