org.apache.maven.continuum.release
Interface ContinuumReleaseManager

All Known Implementing Classes:

DefaultContinuumReleaseManager

public interface ContinuumReleaseManager

The Continuum Release Manager is responsible for performing releases based on a release descriptor that has been received by the Maven Release Plugin.

Version:

$Id: ContinuumReleaseManager.java 1392390 2012-10-01 15:25:24Z brett $

Author:

Jason van Zyl

ROLE

static final String ROLE

prepare

String prepare(Project project,
               Properties releaseProperties,
               Map<String,String> releaseVersions,
               Map<String,String> developmentVersions,
               ContinuumReleaseManagerListener listener,
               String workingDirectory)
               throws ContinuumReleaseException

Prepare a project for release

Parameters:

project -

releaseProperties -

releaseVersions -

developmentVersions -

listener -

workingDirectory -

Returns:

Throws:

ContinuumReleaseException

prepare

String prepare(Project project,
               Properties releaseProperties,
               Map<String,String> releaseVersions,
               Map<String,String> developmentVersions,
               ContinuumReleaseManagerListener listener,
               String workingDirectory,
               Map<String,String> environments,
               String executable)
               throws ContinuumReleaseException

Prepare a project for release

Parameters:

project -

releaseProperties -

releaseVersions -

developmentVersions -

listener -

workingDirectory -

environments -

executable -

Returns:

Throws:

ContinuumReleaseException

perform

void perform(String releaseId,
             File buildDirectory,
             String goals,
             String arguments,
             boolean useReleaseProfile,
             ContinuumReleaseManagerListener listener)
             throws ContinuumReleaseException

Deprecated. to remove as not used anymore

Perform a release based on a given releaseId

Parameters:

releaseId -

buildDirectory -

goals -

useReleaseProfile -

listener -

Throws:

ContinuumReleaseException

perform

void perform(String releaseId,
             String workingDirectory,
             File buildDirectory,
             String goals,
             String arguments,
             boolean useReleaseProfile,
             ContinuumReleaseManagerListener listener)
             throws ContinuumReleaseException

Deprecated. to remove as not used anymore

Perform a release based on a release descriptor received by the Maven Release Plugin.

Parameters:

releaseId -

workingDirectory -

buildDirectory -

goals -

useReleaseProfile -

listener -

Throws:

ContinuumReleaseException

perform

void perform(String releaseId,
             File buildDirectory,
             String goals,
             String arguments,
             boolean useReleaseProfile,
             ContinuumReleaseManagerListener listener,
             LocalRepository repository)
             throws ContinuumReleaseException

FIXME use a bean to replace such very huge parameter number (ContinuumReleaseRequest)

Parameters:

releaseId -

buildDirectory -

goals -

arguments -

useReleaseProfile -

listener -

repository -

Throws:

ContinuumReleaseException

rollback

void rollback(String releaseId,
              String workingDirectory,
              ContinuumReleaseManagerListener listener)
              throws ContinuumReleaseException

Rollback changes made by a previous release.

Parameters:

releaseId -

workingDirectory -

listener -

Throws:

ContinuumReleaseException

getPreparedReleases

Map<String,org.apache.maven.shared.release.config.ReleaseDescriptor> getPreparedReleases()

getPreparedReleasesForProject

Map<String,String> getPreparedReleasesForProject(String groupId,
                                                 String artifactId)

getReleaseResults

Map getReleaseResults()

getListeners

Map getListeners()

sanitizeTagName

String sanitizeTagName(String scmUrl,
                       String tagName)
                       throws Exception

Clean up the tagname to respect the scm provider policy.

Parameters:

scmUrl - The scm url

tagName - The tag name

Returns:

The cleaned tag name

Throws:

Exception

getListener

ReleaseListenerSummary getListener(String releaseId)

Parameters:

releaseId -

Returns:

isExecutingRelease

boolean isExecutingRelease()
                           throws Exception

Determines if there is an ongoing release

Returns:

true if there is an ongoing release; false otherwise

Throws:

Exception - if unable to determine if release is ongoing

getPerformReleaseTaskQueueExecutor

org.codehaus.plexus.taskqueue.execution.TaskQueueExecutor getPerformReleaseTaskQueueExecutor()
                                                                                             throws TaskQueueManagerException

Retrieve the Release TaskQueueExecutor instance

Returns:

Release TaskQueueExecutor instance

Throws:

TaskQueueManagerException - if unable to retrieve the Release TaskQueueExecutor instance

getPrepareReleaseTaskQueueExecutor

org.codehaus.plexus.taskqueue.execution.TaskQueueExecutor getPrepareReleaseTaskQueueExecutor()
                                                                                             throws TaskQueueManagerException

Retrieve the PrepareRelease TaskQueueExecutor instance

Returns:

PrepareRelease TaskQueueExecutor instance

Throws:

TaskQueueManagerException - if unable to retrieve the PrepareRelease TaskQueueExecutor instance

getRollbackReleaseTaskQueueExecutor

org.codehaus.plexus.taskqueue.execution.TaskQueueExecutor getRollbackReleaseTaskQueueExecutor()
                                                                                              throws TaskQueueManagerException

Retrieve the RollbackRelease TaskQueueExecutor instance

Returns:

RollbackRelease TaskQueueExecutor instance

Throws:

TaskQueueManagerException - if unable to retrieve the RollbackRelease TaskQueueExecutor instance