AbstractMavenReleaseMojo (wso2-release-helper-plugin 5.2.30 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.wso2.maven.AbstractMavenReleaseMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

PrepareReleasedArtifactsMojo, PrepareSnapshotArtifactsMojo, RollbackReleaseMojo
```
public abstract class AbstractMavenReleaseMojo
extends org.apache.maven.plugin.AbstractMojo
```
Abstract Mojo for wso2 maven release plugin.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`ARTIFACT`
`protected static String`	`ARTIFACT_XML` String constants
`protected static String`	`ARTIFACT_XML_REGEX`
`protected static String`	`ARTIFACT_XML_TMP_FILE`
`protected static String`	`EMPTY_STRING`
`protected static String`	`GOAL_CHECK_IN`
`protected org.apache.maven.plugin.logging.Log`	`log` Logger for mojo.
`protected static String`	`MAVEN_PLUGINS_GROUP` maven scm plugin meta data
`protected static String`	`MAVEN_SCM_PLUGIN`
`protected org.apache.maven.project.MavenProject`	`mavenProject` The project currently being build.
`protected org.apache.maven.execution.MavenSession`	`mavenSession` The current Mjava.lang.Stringaven session.
`protected static String`	`PARAM_INCLUDES`
`protected static String`	`PARAM_PASSWORD`
`protected static String`	`PARAM_USERNAME`
`protected static String`	`PARAMETER_BASEDIR` maven scm plugin params
`protected static String`	`PARAMETER_MESSAGE`
`protected org.apache.maven.plugin.BuildPluginManager`	`pluginManager` The Maven BuildPluginManager component.
`protected static String`	`POM_XML`
`protected static String`	`PROJECT_PREFIX`
`protected static String`	`PROP_SCM_PASSWORD`
`protected static String`	`PROP_SCM_TAG` release plugin scm properties
`protected static String`	`PROP_SCM_USERNAME`
`protected static String`	`RELEASE_PROPERTIES`
`protected Properties`	`releaseProperties` Properties loaded from release.properties file.
`protected static String`	`SCM_PLUGIN_VERSION`
`protected static String`	`VERSION`
`protected static String`	`WSO2_RELEASE_PLUGIN_PREFIX`

Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE

Constructor Summary

Constructors
Constructor and Description

AbstractMavenReleaseMojo()

Constructors
Constructor and Description
`AbstractMavenReleaseMojo()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`execute()`
`protected abstract String`	`getCommitMessage(Properties releaseProperties)` Method to get the customised commit message for each goal.
`protected abstract String`	`getDryRunFilePrefix()` Method to retrieve the file prefix to be used in dryRunMode of current goal.
`protected abstract String`	`getGoal()` Method to indicate current goal.
`protected org.apache.maven.project.MavenProject`	`getMavenProject(File pomFile)` Method to instantiate a Maven project model from a pom file.
`protected abstract String`	`getNewVersion(File artifactXml)` Method to get the new version for the artifacts.
`protected org.twdata.maven.mojoexecutor.MojoExecutor.Element[]`	`getScmPluginProperties(File parentProjectBaseDir)` Method to generate configuration for maven scm plugin.
`protected boolean`	`isInDryRunMode()` Method to check whether release plugin is running in dryRunMode.
`protected void`	`updateArtifactVersions(File artifactXml, String newVersion)` Update versions in the given artifact.xml file of a ESB/DSS project.

Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ARTIFACT_XML
```
protected static final String ARTIFACT_XML
```
    String constants
    
    See Also:
    
    Constant Field Values
  - ARTIFACT_XML_REGEX
```
protected static final String ARTIFACT_XML_REGEX
```
    See Also:
    
    Constant Field Values
  - EMPTY_STRING
```
protected static final String EMPTY_STRING
```
    See Also:
    
    Constant Field Values
  - POM_XML
```
protected static final String POM_XML
```
    See Also:
    
    Constant Field Values
  - PROJECT_PREFIX
```
protected static final String PROJECT_PREFIX
```
    See Also:
    
    Constant Field Values
  - ARTIFACT_XML_TMP_FILE
```
protected static final String ARTIFACT_XML_TMP_FILE
```
    See Also:
    
    Constant Field Values
  - RELEASE_PROPERTIES
```
protected static final String RELEASE_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - WSO2_RELEASE_PLUGIN_PREFIX
```
protected static final String WSO2_RELEASE_PLUGIN_PREFIX
```
    See Also:
    
    Constant Field Values
  - ARTIFACT
```
protected static final String ARTIFACT
```
    See Also:
    
    Constant Field Values
  - VERSION
```
protected static final String VERSION
```
    See Also:
    
    Constant Field Values
  - MAVEN_PLUGINS_GROUP
```
protected static final String MAVEN_PLUGINS_GROUP
```
    maven scm plugin meta data
    
    See Also:
    
    Constant Field Values
  - MAVEN_SCM_PLUGIN
```
protected static final String MAVEN_SCM_PLUGIN
```
    See Also:
    
    Constant Field Values
  - SCM_PLUGIN_VERSION
```
protected static final String SCM_PLUGIN_VERSION
```
    See Also:
    
    Constant Field Values
  - GOAL_CHECK_IN
```
protected static final String GOAL_CHECK_IN
```
    See Also:
    
    Constant Field Values
  - PARAMETER_BASEDIR
```
protected static final String PARAMETER_BASEDIR
```
    maven scm plugin params
    
    See Also:
    
    Constant Field Values
  - PARAMETER_MESSAGE
```
protected static final String PARAMETER_MESSAGE
```
    See Also:
    
    Constant Field Values
  - PARAM_INCLUDES
```
protected static final String PARAM_INCLUDES
```
    See Also:
    
    Constant Field Values
  - PARAM_USERNAME
```
protected static final String PARAM_USERNAME
```
    See Also:
    
    Constant Field Values
  - PARAM_PASSWORD
```
protected static final String PARAM_PASSWORD
```
    See Also:
    
    Constant Field Values
  - PROP_SCM_TAG
```
protected static final String PROP_SCM_TAG
```
    release plugin scm properties
    
    See Also:
    
    Constant Field Values
  - PROP_SCM_USERNAME
```
protected static final String PROP_SCM_USERNAME
```
    See Also:
    
    Constant Field Values
  - PROP_SCM_PASSWORD
```
protected static final String PROP_SCM_PASSWORD
```
    See Also:
    
    Constant Field Values
  - mavenProject
```
protected org.apache.maven.project.MavenProject mavenProject
```
    The project currently being build.
  - mavenSession
```
protected org.apache.maven.execution.MavenSession mavenSession
```
    The current Mjava.lang.Stringaven session.
  - pluginManager
```
protected org.apache.maven.plugin.BuildPluginManager pluginManager
```
    The Maven BuildPluginManager component.
  - releaseProperties
```
protected Properties releaseProperties
```
    Properties loaded from release.properties file.
  - log
```
protected final org.apache.maven.plugin.logging.Log log
```
    Logger for mojo.
- Constructor Detail
  - AbstractMavenReleaseMojo
```
public AbstractMavenReleaseMojo()
```
- Method Detail
  - getGoal
```
protected abstract String getGoal()
```
    Method to indicate current goal.
    
    Returns:
    
    Current Goal.
  - getDryRunFilePrefix
```
protected abstract String getDryRunFilePrefix()
```
    Method to retrieve the file prefix to be used in dryRunMode of current goal.
    
    Returns:
    
    File prefix for dryRunMode.
  - getCommitMessage
```
protected abstract String getCommitMessage(Properties releaseProperties)
```
    Method to get the customised commit message for each goal.
    
    Parameters:
    
    releaseProperties - Properties generated by maven release plugin.
    
    Returns:
    
    Commit message for current goal.
  - getNewVersion
```
protected abstract String getNewVersion(File artifactXml)
                                 throws IOException,
                                        org.codehaus.plexus.util.xml.pull.XmlPullParserException
```
    Method to get the new version for the artifacts. Implementation depends on the goals(prepare-release, prepare-snapshots and rollback).
    
    Parameters:
    
    artifactXml - artifact.xml file of the project.
    
    Returns:
    
    new version.
    
    Throws:
    
    IOException
    
    org.codehaus.plexus.util.xml.pull.XmlPullParserException
  - execute
```
public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException
```
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
    
    org.apache.maven.plugin.MojoFailureException
  - updateArtifactVersions
```
protected void updateArtifactVersions(File artifactXml,
                                      String newVersion)
                               throws Exception
```
    Update versions in the given artifact.xml file of a ESB/DSS project.
    
    Parameters:
    
    artifactXml - artifact.xml file of a ESB/DSS project.
    
    newVersion - new version to which, the artifacts should be updated.
    
    Throws:
    
    Exception
  - isInDryRunMode
```
protected boolean isInDryRunMode()
```
    Method to check whether release plugin is running in dryRunMode.
    
    Returns:
    
    true, if running in dryRun mode.
  - getScmPluginProperties
```
protected org.twdata.maven.mojoexecutor.MojoExecutor.Element[] getScmPluginProperties(File parentProjectBaseDir)
```
    Method to generate configuration for maven scm plugin.
    
    Parameters:
    
    parentProjectBaseDir - root of the repository.
    
    Returns:
    
    configuration for maven scm plugin.
  - getMavenProject
```
protected org.apache.maven.project.MavenProject getMavenProject(File pomFile)
                                                         throws IOException,
                                                                org.codehaus.plexus.util.xml.pull.XmlPullParserException
```
    Method to instantiate a Maven project model from a pom file.
    
    Parameters:
    
    pomFile - Path to pom file.
    
    Returns:
    
    Project model
    
    Throws:
    
    IOException
    
    org.codehaus.plexus.util.xml.pull.XmlPullParserException

Class AbstractMavenReleaseMojo

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Field Detail

ARTIFACT_XML

ARTIFACT_XML_REGEX

EMPTY_STRING

POM_XML

PROJECT_PREFIX

ARTIFACT_XML_TMP_FILE

RELEASE_PROPERTIES

WSO2_RELEASE_PLUGIN_PREFIX

ARTIFACT

VERSION

MAVEN_PLUGINS_GROUP

MAVEN_SCM_PLUGIN

SCM_PLUGIN_VERSION

GOAL_CHECK_IN

PARAMETER_BASEDIR

PARAMETER_MESSAGE

PARAM_INCLUDES

PARAM_USERNAME

PARAM_PASSWORD

PROP_SCM_TAG

PROP_SCM_USERNAME

PROP_SCM_PASSWORD

mavenProject

mavenSession

pluginManager

releaseProperties

log

Constructor Detail

AbstractMavenReleaseMojo

Method Detail

getGoal

getDryRunFilePrefix

getCommitMessage

getNewVersion

execute

updateArtifactVersions

isInDryRunMode

getScmPluginProperties

getMavenProject