com.atlassian.jira.rpc.xmlrpc
Interface XmlRpcService

All Known Implementing Classes:

JiraXmlRpcService

public interface XmlRpcService

The XmlRpcService provides an XML-RPC interface into JIRA. All available methods are documented here. For the latest on the plugin, visit http://confluence.atlassian.com/display/JIRAEXT/JIRA+RPC+plugin

Method Summary

boolean	addComment(String token, String issueKey, String comment) Adds a comment to an issue
Hashtable	createIssue(String token, Hashtable rIssueStruct) Creates an issue in JIRA from a Hashtable object.
Vector	getComments(String token, String issueKey) Returns all comments associated with the issue
Vector	getComponents(String token, String projectKey) Returns all components available in the specified project
Vector	getFavouriteFilters(String token) Gets all favourite filters available for the currently logged in user
Hashtable	getIssue(String token, String issueKey) Gets an issue from a given issue key.
Vector	getIssuesFromFilter(String token, String filterId) Executes a saved filter
Vector	getIssuesFromTextSearch(String token, String searchTerms) Find issues using a free text search
Vector	getIssuesFromTextSearchWithProject(String token, Vector projectKeys, String searchTerms, int maxNumResults) Find issues using a free text search, limited to certain projects
Vector	getIssueTypes(String token) Returns all visible issue types in the system
Vector	getIssueTypesForProject(String token, String projectId) Returns all visible (non-sub task) issue types for the specified project id
Vector	getPriorities(String token) Returns all priorities in the system
Vector	getProjectsNoSchemes(String token) Returns a list of projects available to the user
Vector	getResolutions(String token) Returns all resolutions in the system
Vector	getSavedFilters(String token) Deprecated. since v3.13. Please use getFavouriteFilters(String)
Hashtable	getServerInfo(String token) Returns the Server information such as baseUrl, version, edition, buildDate, buildNumber.
Vector	getStatuses(String token) Returns all statuses in the system
Vector	getSubTaskIssueTypes(String token) Returns all visible subtask issue types in the system
Vector	getSubTaskIssueTypesForProject(String token, String projectId) Returns all visible sub task issue types for the specified project id.
Hashtable	getUser(String token, String username) Returns a user's information given a username
Vector	getVersions(String token, String projectKey) Returns all versions available in the specified project
String	login(String username, String password) Logs the user into JIRA.
boolean	logout(String token) Logs the user out of JIRA
Hashtable	updateIssue(String token, String issueKey, Hashtable fieldValues) Updates an issue in JIRA from a Hashtable object.

Method Detail

login

String login(String username,
             String password)
             throws Exception

Logs the user into JIRA. The security token which is returned is used in all subsequent method calls.

Parameters:

username - username of the person logged in in as

password - the appropriate password

Returns:

A string which is a security token to be used in all subsequent calls

Throws:

Exception

logout

boolean logout(String token)

Logs the user out of JIRA

Parameters:

token -

Returns:

whether the logging out was successful or not

getServerInfo

Hashtable getServerInfo(String token)

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

Parameters:

token -

Returns:

Hashtable with fields from RemoteServerInfo.

getProjectsNoSchemes

Vector getProjectsNoSchemes(String token)
                            throws Exception

Returns a list of projects available to the user

Parameters:

token -

Returns:

Vector of Hashtables with fields from RemoteProject

Throws:

Exception

getVersions

Vector getVersions(String token,
                   String projectKey)
                   throws Exception

Returns all versions available in the specified project

Parameters:

token -

projectKey - The key of project

Returns:

Vector of Hashtables with fields from RemoteVersion

Throws:

Exception

getComponents

Vector getComponents(String token,
                     String projectKey)
                     throws Exception

Returns all components available in the specified project

Parameters:

token -

projectKey - The key of the project

Returns:

Vector of Hashtables with fields from RemoteComment

Throws:

Exception

getIssueTypesForProject

Vector getIssueTypesForProject(String token,
                               String projectId)
                               throws Exception

Returns all visible (non-sub task) issue types for the specified project id

Parameters:

token -

projectId -

Returns:

Vector of Hashtables with fields from RemoteIssueType

Throws:

Exception

getSubTaskIssueTypesForProject

Vector getSubTaskIssueTypesForProject(String token,
                                      String projectId)
                                      throws Exception

Returns all visible sub task issue types for the specified project id.

Parameters:

token -

projectId -

Returns:

Vector of Hashtables with fields from RemoteIssueType

Throws:

Exception

getIssueTypes

Vector getIssueTypes(String token)
                     throws Exception

Returns all visible issue types in the system

Parameters:

token -

Returns:

Vector of Hashtables with fields from RemoteIssueType

Throws:

Exception

getSubTaskIssueTypes

Vector getSubTaskIssueTypes(String token)
                            throws Exception

Returns all visible subtask issue types in the system

Parameters:

token -

Returns:

Vector of Hashtables with fields from RemoteIssueType

Throws:

Exception

getPriorities

Vector getPriorities(String token)
                     throws Exception

Returns all priorities in the system

Parameters:

token -

Returns:

Vector of Hashtables with fields from RemotePriority

Throws:

Exception

getStatuses

Vector getStatuses(String token)
                   throws Exception

Returns all statuses in the system

Parameters:

token -

Returns:

Vector of Hashtables with fields from RemoteStatus

Throws:

Exception

getResolutions

Vector getResolutions(String token)
                      throws Exception

Returns all resolutions in the system

Parameters:

token -

Returns:

Vector of Hashtables with fields from RemoteResolution

Throws:

Exception

getUser

Hashtable getUser(String token,
                  String username)
                  throws Exception

Returns a user's information given a username

Parameters:

token -

username - the username of the user being retrieved

Returns:

Vector of Hashtables with fields from RemoteUser

Throws:

Exception

getSavedFilters

Vector getSavedFilters(String token)
                       throws Exception

Deprecated. since v3.13. Please use getFavouriteFilters(String)

Gets all favourite filters available for the currently logged in user

Parameters:

token -

Returns:

Vector of Hashtables with fields from RemoteFilter

Throws:

Exception

getFavouriteFilters

Vector getFavouriteFilters(String token)
                           throws Exception

Gets all favourite filters available for the currently logged in user

Parameters:

token -

Returns:

Vector of Hashtables with fields from RemoteFilter

Throws:

Exception

getIssue

Hashtable getIssue(String token,
                   String issueKey)
                   throws Exception

Gets an issue from a given issue key. The Hashtable returned have nested Hashtables for keys, components, affectsVersions, fixVersions and customFieldValues.

Parameters:

token -

issueKey - the key of an issue (e.g. JRA-111)

Returns:

Hashtable with fields from RemoteIssue. This has nested Hashtables for components RemoteComponent, affectsVersions, fixVersions RemoteVersion and customFieldValues RemoteCustomFieldValue.

Throws:

Exception

createIssue

Hashtable createIssue(String token,
                      Hashtable rIssueStruct)
                      throws Exception

Creates an issue in JIRA from a Hashtable object. The Hashtable must be in same structure that's returned by createIssue(String, Hashtable). That is components, affectsVersions, fixVersions and customFieldValues must be blank or be Hashtables with the appropriate data structures. Issues must not have the fields id, key or reporter set, in addition to any standard rules of issue creation (e.g. permissions, not null summary)

Parameters:

token -

rIssueStruct - Hashtable of issue fields with the appropriate structure for RemoteIssue.

Returns:

Hashtable with fields for the generated issue.

Throws:

Exception

updateIssue

Hashtable updateIssue(String token,
                      String issueKey,
                      Hashtable fieldValues)
                      throws Exception

Updates an issue in JIRA from a Hashtable object. The Hashtable must be in same structure that's returned by createIssue(String, Hashtable). That is components, affectsVersions, fixVersions and customFieldValues must be blank or be Hashtables with the appropriate data structures. Issues must not have the fields id, key or reporter set, in addition to any standard rules of issue creation (e.g. permissions, not null summary)

Parameters:

token -

fieldValues - Hashtable of issue fields with the appropriate structure for RemoteIssue.

Returns:

Hashtable with fields for the generated issue.

Throws:

Exception

addComment

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

Adds a comment to an issue

Parameters:

token -

issueKey - he key of an issue (e.g. JRA-111)

comment - the text string for the comment

Throws:

Exception

getIssuesFromFilter

Vector getIssuesFromFilter(String token,
                           String filterId)
                           throws Exception

Executes a saved filter

Parameters:

token -

filterId - id of the saved filter

Returns:

Vector of Hashtables representing the issue

Throws:

Exception

getIssuesFromTextSearch

Vector getIssuesFromTextSearch(String token,
                               String searchTerms)
                               throws Exception

Find issues using a free text search

Parameters:

token -

searchTerms - The terms to search for

Returns:

Vector of Hashtables representing the issue

Throws:

Exception

getIssuesFromTextSearchWithProject

Vector getIssuesFromTextSearchWithProject(String token,
                                          Vector projectKeys,
                                          String searchTerms,
                                          int maxNumResults)
                                          throws Exception

Find issues using a free text search, limited to certain projects

Parameters:

token -

projectKeys -

searchTerms -

Returns:

Throws:

Exception

getComments

Vector getComments(String token,
                   String issueKey)
                   throws Exception

Returns all comments associated with the issue

Parameters:

token -

issueKey - the key of an issue (e.g. JRA-111)

Returns:

Vector of Hashtables with fields from RemoteComment

Throws:

Exception