org.codehaus.swizzle.jira

Class Jira

java.lang.Object

org.codehaus.swizzle.jira.Jira

public class Jira
extends Object

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Jira.Call

Constructor Summary

Constructors

Constructor and Description
Jira(String endpoint)

Method Summary

Modifier and Type	Method and Description
boolean	addComment(String issueKey, String comment) Adds a comment to an issue TODO: If someone adds a comment to an issue, we should account for that in our caching
void	autofill(String scheme, boolean enabled) Valid schemes are "issue", "project", "voters", and "attachments" "issues" is enabled by default
Issue	createIssue(Issue issue) Creates an issue in JIRA TODO: If someone creates an issue, we should account for that in our caching
Issue	fill(Issue issue)
List	getComments(Issue issue)
List	getComments(String issueKey) List<Comment>: Returns all comments associated with the issue
Component	getComponent(Project project, int id)
Component	getComponent(Project project, String name)
Component	getComponent(String projectKey, int id)
Component	getComponent(String projectKey, String name)
List<Component>	getComponents(Project project)
List<Component>	getComponents(String projectKey) List<Component>: Returns all components available in the specified project
List	getFavoriteFilters()
Issue	getIssue(String issueKey)
List<Issue>	getIssuesFromFilter(Filter filter)
List<Issue>	getIssuesFromFilter(int filterId)
List<Issue>	getIssuesFromFilter(String filterName)
List<Issue>	getIssuesFromTextSearch(String searchTerms)
List<Issue>	getIssuesFromTextSearchWithProject(List projectKeys, String searchTerms, int maxNumResults)
IssueType	getIssueType(int id)
IssueType	getIssueType(String name)
List<IssueType>	getIssueTypes()
List	getIssueTypesForProject(int projectId)
List	getIssueTypesForProject(String projectKey)
List<Priority>	getPriorities() List<Priority>: Returns all priorities in the system
Priority	getPriority(int id)
Priority	getPriority(String name)
Project	getProject(int id)
Project	getProject(String key)
List<Project>	getProjects() List<Project>: Returns a list of projects available to the user
Resolution	getResolution(int id)
Resolution	getResolution(String name)
List<Resolution>	getResolutions() List<Resolution>: Returns all resolutions in the system
Filter	getSavedFilter(int id)
Filter	getSavedFilter(String name)
List<Filter>	getSavedFilters() List<Filter>: Gets all saved filters available for the currently logged in user
ServerInfo	getServerInfo() Returns the Server information such as baseUrl, version, edition, buildDate, buildNumber.
Status	getStatus(int id)
Status	getStatus(String name)
List<Status>	getStatuses() List<Status>: Returns all statuses in the system
IssueType	getSubTaskIssueType(int id)
IssueType	getSubTaskIssueType(String name)
List<IssueType>	getSubTaskIssueTypes() List<IssueType>: Returns all visible subtask issue types in the system
User	getUser(String username) Returns a user's information given a username
Version	getVersion(Project project, int id)
Version	getVersion(Project project, String name)
Version	getVersion(String projectKey, int id)
Version	getVersion(String projectKey, String name)
List<Version>	getVersions(Project project)
List<Version>	getVersions(String projectKey) List<Version>: Returns all versions available in the specified project
void	login(String username, String password) Logs the user into JIRA
boolean	logout() remove this token from the list of logged in tokens.
Issue	updateIssue(String issueKey, Issue issue) Updates an issue in JIRA from a HashMap object TODO: If someone updates an issue, we should account for that in our caching

Methods inherited from class java.lang.Object

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

Constructor Detail

Jira

public Jira(String endpoint)
     throws MalformedURLException

Throws:

MalformedURLException

Method Detail

autofill

public void autofill(String scheme,
                     boolean enabled)

Valid schemes are "issue", "project", "voters", and "attachments" "issues" is enabled by default

Parameters:

scheme -

enabled -

login

public void login(String username,
                  String password)
           throws Exception

Logs the user into JIRA

Throws:

Exception

logout

public boolean logout()
               throws Exception

remove this token from the list of logged in tokens.

Throws:

Exception

getComments

public List getComments(String issueKey)

List<Comment>: Returns all comments associated with the issue

getComments

public List getComments(Issue issue)

addComment

public boolean addComment(String issueKey,
                          String comment)
                   throws Exception

Adds a comment to an issue TODO: If someone adds a comment to an issue, we should account for that in our caching

Throws:

Exception

createIssue

public Issue createIssue(Issue issue)
                  throws Exception

Creates an issue in JIRA TODO: If someone creates an issue, we should account for that in our caching

Throws:

Exception

updateIssue

public Issue updateIssue(String issueKey,
                         Issue issue)
                  throws Exception

Updates an issue in JIRA from a HashMap object TODO: If someone updates an issue, we should account for that in our caching

Throws:

Exception

getIssue

public Issue getIssue(String issueKey)

getIssuesFromFilter

public List<Issue> getIssuesFromFilter(Filter filter)
                                throws Exception

Throws:

Exception

getIssuesFromFilter

public List<Issue> getIssuesFromFilter(String filterName)
                                throws Exception

Throws:

Exception

getIssuesFromFilter

public List<Issue> getIssuesFromFilter(int filterId)
                                throws Exception

Throws:

Exception

getIssuesFromTextSearch

public List<Issue> getIssuesFromTextSearch(String searchTerms)
                                    throws Exception

Throws:

Exception

getIssuesFromTextSearchWithProject

public List<Issue> getIssuesFromTextSearchWithProject(List projectKeys,
                                                      String searchTerms,
                                                      int maxNumResults)
                                               throws Exception

Throws:

Exception

getIssueTypes

public List<IssueType> getIssueTypes()

getIssueType

public IssueType getIssueType(String name)

getIssueType

public IssueType getIssueType(int id)

getIssueTypesForProject

public List getIssueTypesForProject(int projectId)

getIssueTypesForProject

public List getIssueTypesForProject(String projectKey)

getPriorities

public List<Priority> getPriorities()

List<Priority>: Returns all priorities in the system

getPriority

public Priority getPriority(String name)

getPriority

public Priority getPriority(int id)

getProjects

public List<Project> getProjects()

List<Project>: Returns a list of projects available to the user

getProject

public Project getProject(String key)

getProject

public Project getProject(int id)

getResolutions

public List<Resolution> getResolutions()

List<Resolution>: Returns all resolutions in the system

getResolution

public Resolution getResolution(String name)

getResolution

public Resolution getResolution(int id)

getStatuses

public List<Status> getStatuses()

List<Status>: Returns all statuses in the system

getStatus

public Status getStatus(String name)

getStatus

public Status getStatus(int id)

getSavedFilters

public List<Filter> getSavedFilters()

List<Filter>: Gets all saved filters available for the currently logged in user

getSavedFilter

public Filter getSavedFilter(String name)

getSavedFilter

public Filter getSavedFilter(int id)

getServerInfo

public ServerInfo getServerInfo()

Returns the Server information such as baseUrl, version, edition, buildDate, buildNumber.

getSubTaskIssueTypes

public List<IssueType> getSubTaskIssueTypes()

List<IssueType>: Returns all visible subtask issue types in the system

Returns:

list of IssueType

getSubTaskIssueType

public IssueType getSubTaskIssueType(String name)

getSubTaskIssueType

public IssueType getSubTaskIssueType(int id)

getUser

public User getUser(String username)

Returns a user's information given a username

getComponents

public List<Component> getComponents(String projectKey)

List<Component>: Returns all components available in the specified project

getComponents

public List<Component> getComponents(Project project)

getComponent

public Component getComponent(String projectKey,
                              String name)

getComponent

public Component getComponent(Project project,
                              String name)

getComponent

public Component getComponent(String projectKey,
                              int id)

getComponent

public Component getComponent(Project project,
                              int id)

getVersions

public List<Version> getVersions(String projectKey)

List<Version>: Returns all versions available in the specified project

getVersions

public List<Version> getVersions(Project project)

getVersion

public Version getVersion(String projectKey,
                          String name)

getVersion

public Version getVersion(Project project,
                          String name)

getVersion

public Version getVersion(String projectKey,
                          int id)

getVersion

public Version getVersion(Project project,
                          int id)

getFavoriteFilters

public List getFavoriteFilters()

fill

public Issue fill(Issue issue)