org.apache.maven.plugins.patchtracker
Class AbstractPatchMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugins.patchtracker.AbstractPatchMojo
All Implemented Interfaces:
ContextEnabled, Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
Direct Known Subclasses:
CreatePatchMojo, PatchToIssueMojo, UpdatePatchMojo

public abstract class AbstractPatchMojo
extends AbstractMojo
implements org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Author:
Olivier Lamy

Field Summary
protected  File baseDir
           
protected  String description
           
protected  String issueSystem
           
protected  String password
           
protected  String patchPriority
          the priority of the patch tracker entry to load: default 3 for jira major
protected  String patchSystem
           
protected  String patchType
          the type of the patch tracker entry to load: default 1 for jira bug
protected  org.codehaus.plexus.PlexusContainer plexusContainer
           
protected  MavenProject project
          The Maven Project Object.
protected  org.codehaus.plexus.components.interactivity.Prompter prompter
          Component used to prompt for input.
protected  String providerType
           
protected  ScmManager scmManager
           
protected  String serverId
          if user/password are stored in your settings.xml in a server
protected  String serverUrl
          if path tracker url is not stored in the pom.
protected  org.apache.maven.settings.Settings settings
           
protected  String summary
           
protected  String user
           
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractPatchMojo()
           
 
Method Summary
protected  PatchTrackerRequest buidPatchTrackerRequest(boolean creation)
           
 void contextualize(org.codehaus.plexus.context.Context context)
           
protected  String getPatchContent()
           
protected  PatchRepository getPatchRepository()
           
protected  String getPatchRepositorySystem()
           
protected  PatchTracker getPatchTracker()
           
protected  String getPatchTrackerDescription()
           
protected  String getPatchTrackerPassword()
           
protected  String getPatchTrackerSummary()
           
protected  String getPatchTrackerSystem()
           
protected  String getPatchTrackerUrl()
           
protected  String getPatchTrackerUsername()
           
protected  org.apache.maven.settings.Server getServer(String id)
           
protected  String getServerId()
           
protected  String getValue(String currentValue, String message, List<String> possibleValues, boolean mandatory, String errorMessage, String defaultValue, boolean passwordPrompt)
           
 
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
 
Methods inherited from interface org.apache.maven.plugin.Mojo
execute
 

Field Detail

project

protected MavenProject project
The Maven Project Object.

Is defined by:
default-value:
${project}
Is readonly.
Is required.

baseDir

protected File baseDir
Is defined by:
default-value:
${basedir}
Is readonly.
Is required.

providerType

protected String providerType
Is defined by:
expression:
${scm.providerType}
default-value:

settings

protected org.apache.maven.settings.Settings settings
Is defined by:
default-value:
${settings}
Is readonly.
Is required.

serverId

protected String serverId
if user/password are stored in your settings.xml in a server

Is defined by:
expression:
${patch.serverId}
default-value:

serverUrl

protected String serverUrl
if path tracker url is not stored in the pom. For jira, url must include project key!: http://jira.codehaus.org/browse/MNG

Is defined by:
expression:
${patch.serverUrl}
default-value:

user

protected String user
Is defined by:
expression:
${patch.user}
default-value:

password

protected String password
Is defined by:
expression:
${patch.password}
default-value:

issueSystem

protected String issueSystem
Is defined by:
expression:
${patch.issueSystem}
default-value:

patchSystem

protected String patchSystem
Is defined by:
expression:
${patch.patchSystem}
default-value:
${project.patchManagement.system}

summary

protected String summary
Is defined by:
expression:
${patch.summary}
default-value:

description

protected String description
Is defined by:
expression:
${patch.description}
default-value:

patchType

protected String patchType
the type of the patch tracker entry to load: default 1 for jira bug

Is defined by:
expression:
${patch.patchType}
default-value:
1

patchPriority

protected String patchPriority
the priority of the patch tracker entry to load: default 3 for jira major

Is defined by:
expression:
${patch.priority}
default-value:
3

prompter

protected org.codehaus.plexus.components.interactivity.Prompter prompter
Component used to prompt for input.

Is a Plexus component defined by:

plexusContainer

protected org.codehaus.plexus.PlexusContainer plexusContainer

scmManager

protected ScmManager scmManager
Is a Plexus component defined by:
Constructor Detail

AbstractPatchMojo

public AbstractPatchMojo()
Method Detail

getPatchContent

protected String getPatchContent()
                          throws MojoExecutionException
Throws:
MojoExecutionException

buidPatchTrackerRequest

protected PatchTrackerRequest buidPatchTrackerRequest(boolean creation)
                                               throws MojoExecutionException
Throws:
MojoExecutionException

getPatchTrackerUrl

protected String getPatchTrackerUrl()
                             throws org.codehaus.plexus.components.interactivity.PrompterException,
                                    MojoExecutionException
Throws:
org.codehaus.plexus.components.interactivity.PrompterException
MojoExecutionException

getPatchTrackerSummary

protected String getPatchTrackerSummary()
                                 throws org.codehaus.plexus.components.interactivity.PrompterException,
                                        MojoExecutionException
Throws:
org.codehaus.plexus.components.interactivity.PrompterException
MojoExecutionException

getPatchTrackerDescription

protected String getPatchTrackerDescription()
                                     throws org.codehaus.plexus.components.interactivity.PrompterException,
                                            MojoExecutionException
Throws:
org.codehaus.plexus.components.interactivity.PrompterException
MojoExecutionException

getServerId

protected String getServerId()

getPatchTrackerUsername

protected String getPatchTrackerUsername()
                                  throws org.codehaus.plexus.components.interactivity.PrompterException,
                                         MojoExecutionException
Throws:
org.codehaus.plexus.components.interactivity.PrompterException
MojoExecutionException

getPatchTrackerPassword

protected String getPatchTrackerPassword()
                                  throws org.codehaus.plexus.components.interactivity.PrompterException,
                                         MojoExecutionException
Throws:
org.codehaus.plexus.components.interactivity.PrompterException
MojoExecutionException

getPatchTrackerSystem

protected String getPatchTrackerSystem()
                                throws MojoExecutionException
Throws:
MojoExecutionException

getPatchRepositorySystem

protected String getPatchRepositorySystem()
                                   throws MojoExecutionException
Throws:
MojoExecutionException

getValue

protected String getValue(String currentValue,
                          String message,
                          List<String> possibleValues,
                          boolean mandatory,
                          String errorMessage,
                          String defaultValue,
                          boolean passwordPrompt)
                   throws org.codehaus.plexus.components.interactivity.PrompterException,
                          MojoExecutionException
Throws:
org.codehaus.plexus.components.interactivity.PrompterException
MojoExecutionException

getServer

protected org.apache.maven.settings.Server getServer(String id)

getPatchTracker

protected PatchTracker getPatchTracker()
                                throws MojoExecutionException,
                                       org.codehaus.plexus.component.repository.exception.ComponentLookupException
Throws:
MojoExecutionException
org.codehaus.plexus.component.repository.exception.ComponentLookupException

getPatchRepository

protected PatchRepository getPatchRepository()
                                      throws MojoExecutionException,
                                             org.codehaus.plexus.component.repository.exception.ComponentLookupException
Throws:
MojoExecutionException
org.codehaus.plexus.component.repository.exception.ComponentLookupException

contextualize

public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException
Specified by:
contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
Throws:
org.codehaus.plexus.context.ContextException


Copyright © 2002-2011 The Apache Software Foundation. All Rights Reserved.