info.ronjenkins.maven.rtr.steps.release

Class AbstractSmartReactorReleaseStep

java.lang.Object

info.ronjenkins.maven.rtr.steps.AbstractSmartReactorStep

info.ronjenkins.maven.rtr.steps.release.AbstractSmartReactorReleaseStep

All Implemented Interfaces:

SmartReactorStep

Direct Known Subclasses:

DoPostReleaseFailure, DoPostReleaseSuccess, RebuildReleaseReactor, TransformProjectsIntoReleases

public abstract class AbstractSmartReactorReleaseStep
extends AbstractSmartReactorStep

Base implementation of a Smart Reactor release step. No-op unless the Smart Reactor's release property is true at runtime.

Author:

Ronald Jack Jenkins Jr.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,org.apache.maven.shared.release.phase.ReleasePhase>	availablePhases
protected org.apache.maven.shared.release.config.ReleaseDescriptor	releaseDescriptor
protected org.apache.maven.shared.release.env.ReleaseEnvironment	releaseEnvironment
protected RTR	rtr

Fields inherited from class info.ronjenkins.maven.rtr.steps.AbstractSmartReactorStep

logger

Constructor Summary

Constructors

Constructor and Description
AbstractSmartReactorReleaseStep()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configureReleaseDescriptor(org.apache.maven.execution.MavenSession session, RTRComponents components) Subclasses can override this method to configure the release descriptor injected by Plexus.
void	execute(org.apache.maven.execution.MavenSession session, RTRComponents components) Executes this step.
protected abstract String	getAnnouncement() Returns the announcement that is logged when this release step begins execution.
protected abstract List<String>	getReleasePhases() Returns the list of phases that should be executed by this release step.
protected abstract List<String>	getRollbackPhases() Returns the list of phases that should be executed by this release step when rollback is required.
protected void	releaseExecute(org.apache.maven.execution.MavenSession session, RTRComponents components) Step logic that is executed if a release was requested.

Methods inherited from class java.lang.Object

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

Field Detail

rtr

@Requirement(role=org.apache.maven.AbstractMavenLifecycleParticipant.class,
             hint="rtr")
protected RTR rtr

availablePhases

@Requirement(role=org.apache.maven.shared.release.phase.ReleasePhase.class)
protected Map<String,org.apache.maven.shared.release.phase.ReleasePhase> availablePhases

releaseDescriptor

@Requirement(hint="rtr-rd")
protected org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor

releaseEnvironment

@Requirement(hint="rtr-re")
protected org.apache.maven.shared.release.env.ReleaseEnvironment releaseEnvironment

Constructor Detail

AbstractSmartReactorReleaseStep

public AbstractSmartReactorReleaseStep()

Method Detail

configureReleaseDescriptor

protected void configureReleaseDescriptor(org.apache.maven.execution.MavenSession session,
                              RTRComponents components)

Subclasses can override this method to configure the release descriptor injected by Plexus. The default implementation does nothing.

Parameters:

session - the session to which this step applies. Not null.

components - that this step may need. May be null.

execute

public final void execute(org.apache.maven.execution.MavenSession session,
           RTRComponents components)
                   throws org.apache.maven.MavenExecutionException

Description copied from interface: SmartReactorStep

Executes this step.

Parameters:

session - the session to which this step applies. Not null.

components - that this step may need. May be null.

Throws:

org.apache.maven.MavenExecutionException - if any unrecoverable error occurs.

getAnnouncement

protected abstract String getAnnouncement()

Returns the announcement that is logged when this release step begins execution.

Returns:

null or empty will prevent the corresponding log entry from occurring.

getReleasePhases

protected abstract List<String> getReleasePhases()

Returns the list of phases that should be executed by this release step.

Returns:

never null or empty.

Throws:

UnsupportedOperationException - if this step does not execute any release phases.

getRollbackPhases

protected abstract List<String> getRollbackPhases()

Returns the list of phases that should be executed by this release step when rollback is required.

Returns:

never null or empty.

Throws:

UnsupportedOperationException - if this step does not execute any release phases.

releaseExecute

protected void releaseExecute(org.apache.maven.execution.MavenSession session,
                  RTRComponents components)
                       throws org.apache.maven.MavenExecutionException

Step logic that is executed if a release was requested.

Parameters:

session - the session to which this step applies. Not null.

components - that this step may need. May be null.

Throws:

org.apache.maven.MavenExecutionException - if any unrecoverable error occurs.