org.apache.maven.plugin.jira
Class AbstractJiraDownloader

java.lang.Object
  org.apache.maven.plugin.jira.AbstractJiraDownloader

Direct Known Subclasses:

JiraDownloader

public abstract class AbstractJiraDownloader
extends Object

Gets relevant issues in RSS from a given JIRA installation.

Based on version 1.1.2 and patch by Dr. Spock (MPJIRA-8).

Version:

$Id: AbstractJiraDownloader.html 816603 2012-05-08 12:53:30Z hboutemy $

Author:

mfranken@xebia.com, jruiz@exist.com

Field Summary

protected String	jiraDatePattern The pattern used to parse dates from the JIRA xml file.
protected org.apache.maven.plugin.logging.Log	log Log for debug output.
protected Map<String,String>	priorityMap Mapping containing all allowed JIRA priority values.
protected Map<String,String>	resolutionMap Mapping containing all allowed JIRA resolution values.
protected Map<String,String>	statusMap Mapping containing all allowed JIRA status values.
protected Map<String,String>	typeMap Mapping containing all allowed JIRA type values.

Constructor Summary

AbstractJiraDownloader()

Method Summary

void	doExecute() Execute the query on the JIRA server.
protected String	getFixFor() Override this method if you need to get issues for a specific Fix For.
List<Issue>	getIssueList()
File	getOutput()
void	setComponent(String theseComponents) Sets the component(s) to apply to query JIRA.
void	setFilter(String thisFilter) Sets the filter to apply to query to JIRA.
void	setFixVersionIds(String theseFixVersionIds) Sets the fix version id(s) to apply to query JIRA.
void	setJiraDatePattern(String jiraDatePattern)
void	setJiraPassword(String thisJiraPassword) Sets the password to log into a secured JIRA.
void	setJiraUser(String thisJiraUser) Sets the username to log into a secured JIRA.
void	setLog(org.apache.maven.plugin.logging.Log log)
void	setMavenProject(Object thisProject) Sets the project.
void	setNbEntries(int nbEntries) Sets the maximum number of Issues to show.
void	setOutput(File thisOutput) Set the output file for the log.
void	setPriorityIds(String thisPriorityIds) Sets the priorityIds.
void	setResolutionIds(String thisResolutionIds) Sets the resolutionIds.
void	setSettings(org.apache.maven.settings.Settings settings)
void	setSortColumnNames(String thisSortColumnNames) Sets the sort column names.
void	setStatusIds(String thisStatusIds) Sets the statusIds.
void	setTypeIds(String theseTypeIds) Sets the typeIds.
void	setWebPassword(String thisWebPassword) Sets the password for authentication against the webserver.
void	setWebUser(String thisWebUser) Sets the username for authentication against the webserver.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.maven.plugin.logging.Log log

Log for debug output.

statusMap

protected final Map<String,String> statusMap

Mapping containing all allowed JIRA status values.

resolutionMap

protected final Map<String,String> resolutionMap

Mapping containing all allowed JIRA resolution values.

priorityMap

protected final Map<String,String> priorityMap

Mapping containing all allowed JIRA priority values.

typeMap

protected final Map<String,String> typeMap

Mapping containing all allowed JIRA type values.

jiraDatePattern

protected String jiraDatePattern

The pattern used to parse dates from the JIRA xml file.

Constructor Detail

AbstractJiraDownloader

public AbstractJiraDownloader()

Method Detail

doExecute

public void doExecute()
               throws Exception

Execute the query on the JIRA server.

Throws:

Exception - on error

getFixFor

protected String getFixFor()

Override this method if you need to get issues for a specific Fix For.

Returns:

A Fix For id or null if you don't have that need

getIssueList

public List<Issue> getIssueList()
                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

setJiraDatePattern

public void setJiraDatePattern(String jiraDatePattern)

setOutput

public void setOutput(File thisOutput)

Set the output file for the log.

Parameters:

thisOutput - the output file

getOutput

public File getOutput()

setMavenProject

public void setMavenProject(Object thisProject)

Sets the project.

Parameters:

thisProject - The project to set

setNbEntries

public void setNbEntries(int nbEntries)

Sets the maximum number of Issues to show.

Parameters:

nbEntries - The maximum number of Issues

setStatusIds

public void setStatusIds(String thisStatusIds)

Sets the statusIds.

Parameters:

thisStatusIds - The id(s) of the status to show, as comma separated string

setPriorityIds

public void setPriorityIds(String thisPriorityIds)

Sets the priorityIds.

Parameters:

thisPriorityIds - The id(s) of the priority to show, as comma separated string

setResolutionIds

public void setResolutionIds(String thisResolutionIds)

Sets the resolutionIds.

Parameters:

thisResolutionIds - The id(s) of the resolution to show, as comma separated string

setSortColumnNames

public void setSortColumnNames(String thisSortColumnNames)

Sets the sort column names.

Parameters:

thisSortColumnNames - The column names to sort by

setWebPassword

public void setWebPassword(String thisWebPassword)

Sets the password for authentication against the webserver.

Parameters:

thisWebPassword - The password of the webserver

setWebUser

public void setWebUser(String thisWebUser)

Sets the username for authentication against the webserver.

Parameters:

thisWebUser - The username of the webserver

setJiraPassword

public void setJiraPassword(String thisJiraPassword)

Sets the password to log into a secured JIRA.

Parameters:

thisJiraPassword - The password for JIRA

setJiraUser

public void setJiraUser(String thisJiraUser)

Sets the username to log into a secured JIRA.

Parameters:

thisJiraUser - The username for JIRA

setFilter

public void setFilter(String thisFilter)

Sets the filter to apply to query to JIRA.

Parameters:

thisFilter - The filter to query JIRA

setComponent

public void setComponent(String theseComponents)

Sets the component(s) to apply to query JIRA.

Parameters:

theseComponents - The id(s) of components to show, as comma separated string

setFixVersionIds

public void setFixVersionIds(String theseFixVersionIds)

Sets the fix version id(s) to apply to query JIRA.

Parameters:

theseFixVersionIds - The id(s) of fix versions to show, as comma separated string

setTypeIds

public void setTypeIds(String theseTypeIds)

Sets the typeIds.

Parameters:

theseTypeIds - The id(s) of the types to show, as comma separated string

setLog

public void setLog(org.apache.maven.plugin.logging.Log log)

setSettings

public void setSettings(org.apache.maven.settings.Settings settings)