com.atlassian.jira.rpc.soap
Interface JiraSoapService

All Known Implementing Classes:

JiraSoapServiceImpl

public interface JiraSoapService

Method Summary

void	addActorsToProjectRole(String token, String[] actors, RemoteProjectRole projectRole, RemoteProject project, String actorType)
boolean	addAttachmentsToIssue(String token, String issueKey, String[] fileNames, byte[][] attachments)
void	addComment(String token, String issueKey, RemoteComment remoteComment)
void	addDefaultActorsToProjectRole(String token, String[] actors, RemoteProjectRole projectRole, String type)
RemotePermissionScheme	addPermissionTo(String token, RemotePermissionScheme permissionScheme, RemotePermission permission, RemoteEntity remoteEntity)
void	addUserToGroup(String token, RemoteGroup group, RemoteUser ruser)
RemoteVersion	addVersion(String token, String projectKey, RemoteVersion remoteVersion)
RemoteWorklog	addWorklogAndAutoAdjustRemainingEstimate(String token, String issueKey, RemoteWorklog remoteWorklog) Adds a worklog to the given issue and sets the issue's remaining estimate field to the given value.
RemoteWorklog	addWorklogAndRetainRemainingEstimate(String token, String issueKey, RemoteWorklog remoteWorklog) Adds a worklog to the given issue but leaves the issue's remaining estimate field unchanged.
RemoteWorklog	addWorklogWithNewRemainingEstimate(String token, String issueKey, RemoteWorklog remoteWorklog, String newRemainingEstimate) Adds a worklog to the given issue and sets the issue's remaining estimate field to the given value.
void	archiveVersion(String token, String projectKey, String versionName, boolean archive)
RemoteGroup	createGroup(String token, String groupName, RemoteUser firstUser) Creates a group with the given name optionally adding the given user to it.
RemoteIssue	createIssue(String token, RemoteIssue rIssue)
RemotePermissionScheme	createPermissionScheme(String token, String name, String description)
RemoteProject	createProject(String token, String key, String name, String description, String url, String lead, RemotePermissionScheme permissionScheme, RemoteScheme notificationScheme, RemoteScheme issueSecurityScheme)
RemoteProject	createProjectFromObject(String token, RemoteProject rproject)
RemoteProjectRole	createProjectRole(String token, RemoteProjectRole projectRole)
RemoteUser	createUser(String token, String username, String password, String fullName, String email) Creates a user in JIRA with the specified user details.
void	deleteGroup(String token, String groupName, String swapGroupName)
void	deleteIssue(String token, String issueKey)
RemotePermissionScheme	deletePermissionFrom(String token, RemotePermissionScheme permissionSchemeName, RemotePermission permission, RemoteEntity remoteEntity)
void	deletePermissionScheme(String token, String permissionSchemeName)
void	deleteProject(String token, String projectKey)
void	deleteProjectRole(String token, RemoteProjectRole projectRole, boolean confirm)
void	deleteUser(String token, String username) Deletes a user in JIRA with the specified username.
void	deleteWorklogAndAutoAdjustRemainingEstimate(String token, String worklogId) Deletes the worklog with the given id and updates the remaining estimate field on the isssue by increasing it by the time spent amount on the worklog being deleted.
void	deleteWorklogAndRetainRemainingEstimate(String token, String worklogId) Deletes the worklog with the given id but leaves the remaining estimate field on the isssue unchanged.
void	deleteWorklogWithNewRemainingEstimate(String token, String worklogId, String newRemainingEstimate) Deletes the worklog with the given id and sets the remaining estimate field on the isssue to the given value.
RemoteComment	editComment(String token, RemoteComment remoteComment)
RemotePermission[]	getAllPermissions(String token)
RemoteScheme[]	getAssociatedNotificationSchemes(String token, RemoteProjectRole projectRole)
RemoteScheme[]	getAssociatedPermissionSchemes(String token, RemoteProjectRole projectRole)
RemoteAttachment[]	getAttachmentsFromIssue(String token, String issueKey)
RemoteNamedObject[]	getAvailableActions(String token, String issueKey)
RemoteComment	getComment(String token, Long id)
RemoteComment[]	getComments(String token, String issueKey)
RemoteComponent[]	getComponents(String token, String projectKey) Returns an array of all the components for the specified project key.
RemoteConfiguration	getConfiguration(String token) Returns information about the current configuration of JIRA.
RemoteField[]	getCustomFields(String token)
RemoteRoleActors	getDefaultRoleActors(String token, RemoteProjectRole projectRole)
RemoteField[]	getFieldsForAction(String token, String issueKey, String actionIdString)
RemoteField[]	getFieldsForEdit(String token, String issueKey)
RemoteGroup	getGroup(String token, String groupName) Find the group with the specified name in JIRA.
RemoteIssue	getIssue(String token, String issueKey)
RemoteIssue	getIssueById(String token, String issueId)
long	getIssueCountForFilter(String token, String filterId)
RemoteIssue[]	getIssuesFromFilter(String token, String filterId)
RemoteIssue[]	getIssuesFromTextSearch(String token, String searchTerms) Returns issues containing searchTerms.
RemoteIssue[]	getIssuesFromTextSearchWithProject(String token, String[] projectKeys, String searchTerms, int maxNumResults)
RemoteIssueType[]	getIssueTypes(String token) Returns an array of all the issue types for all projects in JIRA.
RemoteIssueType[]	getIssueTypesForProject(String token, String projectId) Returns an array of all the (non-sub task) issue types for the specified project id.
RemoteScheme[]	getNotificationSchemes(String token)
RemotePermissionScheme[]	getPermissionSchemes(String token)
RemotePriority[]	getPriorities(String token) Returns an array of all the issue priorities in JIRA.
RemoteProject	getProjectById(String token, Long projectId) Returns the Project with the matching key (if the user has permission to browse it).
RemoteProject	getProjectByKey(String token, String projectKey) Returns the Project with the matching key (if the user has permission to browse it).
RemoteProjectRole	getProjectRole(String token, Long id)
RemoteProjectRoleActors	getProjectRoleActors(String token, RemoteProjectRole projectRole, RemoteProject project)
RemoteProjectRole[]	getProjectRoles(String token)
RemoteProject[]	getProjects(String token) Deprecated. Please use getProjectsNoSchemes(String) wherever possible, as this method can use huge amounts of memory, particularly if you have many users!
RemoteProject[]	getProjectsNoSchemes(String token) Returns an array of all the Projects defined in JIRA.
RemoteResolution[]	getResolutions(String token) Returns an array of all the issue resolutions in JIRA.
RemoteFilter[]	getSavedFilters(String token)
RemoteScheme[]	getSecuritySchemes(String token)
RemoteServerInfo	getServerInfo(String token) Returns information about the server JIRA is running on including build number and base URL.
RemoteStatus[]	getStatuses(String token) Returns an array of all the issue statuses in JIRA.
RemoteIssueType[]	getSubTaskIssueTypes(String token) Returns an array of all the sub task issue types in JIRA.
RemoteIssueType[]	getSubTaskIssueTypesForProject(String token, String projectId) Returns an array of all the sub task issue types for the specified project id.
RemoteUser	getUser(String token, String username) Returns information about a user defined to JIRA.
RemoteVersion[]	getVersions(String token, String projectKey) Returns an array of all the versions for the specified project key.
RemoteWorklog[]	getWorklogs(String token, String issueKey) Returns all worklogs for the given issue.
boolean	hasPermissionToCreateWorklog(String token, String issueKey) Determines if the user has the permission to add worklogs to the specified issue, that timetracking is enabled in JIRA and that the specified issue is in an editable workflow state.
boolean	hasPermissionToDeleteWorklog(String token, String worklogId) Determine whether the current user has the permission to delete the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.
boolean	hasPermissionToEditComment(String token, RemoteComment remoteComment)
boolean	hasPermissionToUpdateWorklog(String token, String worklogId) Determine whether the current user has the permission to update the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.
boolean	isProjectRoleNameUnique(String token, String name)
String	login(String username, String password) This will authenticate the user in JIRA and returned a authentication token that can then be used on all other SOAP methods.
boolean	logout(String token) Cleans up an authentication token that was previously created with a call to login(java.lang.String, java.lang.String)
RemoteIssue	progressWorkflowAction(String token, String issueKey, String actionIdString, RemoteFieldValue[] actionParams)
void	refreshCustomFields(String token)
void	releaseVersion(String token, String projectKey, RemoteVersion version)
void	removeActorsFromProjectRole(String token, String[] actors, RemoteProjectRole projectRole, RemoteProject project, String actorType)
void	removeAllRoleActorsByNameAndType(String token, String name, String type)
void	removeAllRoleActorsByProject(String token, RemoteProject project)
void	removeDefaultActorsFromProjectRole(String token, String[] actors, RemoteProjectRole projectRole, String actorType)
void	removeUserFromGroup(String token, RemoteGroup group, RemoteUser ruser)
RemoteGroup	updateGroup(String token, RemoteGroup group)
RemoteIssue	updateIssue(String token, String issueKey, RemoteFieldValue[] actionParams)
RemoteProject	updateProject(String token, RemoteProject rProject)
void	updateProjectRole(String token, RemoteProjectRole projectRole)
void	updateWorklogAndAutoAdjustRemainingEstimate(String token, RemoteWorklog remoteWorklog) Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog and changes the remaining estimate field on the relevant issue to the value obtained by adding the previous time spent amount of the worklog and subtracting the new time spent amount.
void	updateWorklogAndRetainRemainingEstimate(String token, RemoteWorklog remoteWorklog) Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog but leaves the remaining estimate field on the relevant issue unchanged.
void	updateWorklogWithNewRemainingEstimate(String token, RemoteWorklog remoteWorklog, String newRemainingEstimate) Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog and sets the remaining estimate field on the relevant issue to the given value.

Method Detail

login

String login(String username,
             String password)
             throws RemoteException,
                    RemoteAuthenticationException

This will authenticate the user in JIRA and returned a authentication token that can then be used on all other SOAP methods.

Parameters:

username - the JIRA user name to authenticate

password - the password of the JIRA user

Returns:

a authentication token that can then be used on further SOAP calls.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemoteAuthenticationException - If the username and password is an invalid combination

logout

boolean logout(String token)

Cleans up an authentication token that was previously created with a call to login(java.lang.String, java.lang.String)

Parameters:

token - the SOAP authentication token

Returns:

true if the logout succeeded

getServerInfo

RemoteServerInfo getServerInfo(String token)

Returns information about the server JIRA is running on including build number and base URL.

Parameters:

token - the SOAP authentication token.

Returns:

a RemoteServerInfo object

getProjects

RemoteProject[] getProjects(String token)
                            throws RemotePermissionException,
                                   RemoteAuthenticationException,
                                   RemoteException

Deprecated. Please use getProjectsNoSchemes(String) wherever possible, as this method can use huge amounts of memory, particularly if you have many users!

Returns an object graph containing all projects, their permission schemes, notification schemes and (in Enterprise) security schemes, and in turn any users/groups they use.

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteProject objects.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getProjectById

RemoteProject getProjectById(String token,
                             Long projectId)
                             throws RemotePermissionException,
                                    RemoteAuthenticationException,
                                    RemoteException

Returns the Project with the matching key (if the user has permission to browse it).

Parameters:

token - the SOAP authentication token.

projectId - the id of the requested project

Returns:

the RemoteProject object specified by the key, if it exists and the user has the BROWSE permission for it

Throws:

RemotePermissionException - if the User does not have permission to BROWSE the project.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteException

getProjectByKey

RemoteProject getProjectByKey(String token,
                              String projectKey)
                              throws RemotePermissionException,
                                     RemoteAuthenticationException,
                                     RemoteException

Returns the Project with the matching key (if the user has permission to browse it).

Parameters:

token - the SOAP authentication token.

projectKey - the key of the requested project

Returns:

the RemoteProject object specified by the key, if it exists and the user has the BROWSE permission for it

Throws:

RemotePermissionException - if the User does not have permission to BROWSE the project.

RemoteException

RemoteAuthenticationException

getVersions

RemoteVersion[] getVersions(String token,
                            String projectKey)
                            throws RemotePermissionException,
                                   RemoteAuthenticationException,
                                   RemoteException

Returns an array of all the versions for the specified project key.

Parameters:

token - the SOAP authentication token.

projectKey - the key of the requested project

Returns:

an array of RemoteVersion objects

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getComponents

RemoteComponent[] getComponents(String token,
                                String projectKey)
                                throws RemotePermissionException,
                                       RemoteAuthenticationException,
                                       RemoteException

Returns an array of all the components for the specified project key.

Parameters:

token - the SOAP authentication token.

projectKey - the key of the requested project

Returns:

an array of RemoteComponent objects

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getIssueTypesForProject

RemoteIssueType[] getIssueTypesForProject(String token,
                                          String projectId)
                                          throws RemotePermissionException,
                                                 RemoteAuthenticationException

Returns an array of all the (non-sub task) issue types for the specified project id.

Parameters:

token - the SOAP authentication token.

projectId - id of the project

Returns:

an array of RemoteIssueType objects

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getSubTaskIssueTypesForProject

RemoteIssueType[] getSubTaskIssueTypesForProject(String token,
                                                 String projectId)
                                                 throws RemotePermissionException,
                                                        RemoteAuthenticationException

Returns an array of all the sub task issue types for the specified project id.

Parameters:

token - the SOAP authentication token.

projectId - id of the project

Returns:

an array of RemoteIssueType objects

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getIssueTypes

RemoteIssueType[] getIssueTypes(String token)
                                throws RemotePermissionException,
                                       RemoteAuthenticationException

Returns an array of all the issue types for all projects in JIRA.

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteIssueType objects

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getSubTaskIssueTypes

RemoteIssueType[] getSubTaskIssueTypes(String token)
                                       throws RemotePermissionException,
                                              RemoteAuthenticationException

Returns an array of all the sub task issue types in JIRA.

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteIssueType objects

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getPriorities

RemotePriority[] getPriorities(String token)
                               throws RemotePermissionException,
                                      RemoteAuthenticationException

Returns an array of all the issue priorities in JIRA.

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemotePriority objects

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getStatuses

RemoteStatus[] getStatuses(String token)
                           throws RemotePermissionException,
                                  RemoteAuthenticationException

Returns an array of all the issue statuses in JIRA.

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteStatus objects

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getResolutions

RemoteResolution[] getResolutions(String token)
                                  throws RemotePermissionException,
                                         RemoteAuthenticationException

Returns an array of all the issue resolutions in JIRA.

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteResolution objects

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getUser

RemoteUser getUser(String token,
                   String username)
                   throws RemotePermissionException,
                          RemoteAuthenticationException

Returns information about a user defined to JIRA.

Parameters:

token - the SOAP authentication token.

username - the user name to look up

Returns:

a RemoteUser or null if it cant be found

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

createUser

RemoteUser createUser(String token,
                      String username,
                      String password,
                      String fullName,
                      String email)
                      throws RemotePermissionException,
                             RemoteAuthenticationException,
                             RemoteValidationException,
                             RemoteException

Creates a user in JIRA with the specified user details.

Parameters:

token - the SOAP authentication token.

username - the user name to create

password - the password for the new user

fullName - the full name of the new user

email - the email of the new user

Returns:

the newly created RemoteUser

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

RemoteException

deleteUser

void deleteUser(String token,
                String username)
                throws RemotePermissionException,
                       RemoteAuthenticationException,
                       RemoteException,
                       RemoteValidationException

Deletes a user in JIRA with the specified username.

Parameters:

token - the SOAP authentication token.

username - the user name to delete

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteException

RemoteValidationException

getGroup

RemoteGroup getGroup(String token,
                     String groupName)
                     throws RemotePermissionException,
                            RemoteAuthenticationException,
                            RemoteException,
                            RemoteValidationException

Find the group with the specified name in JIRA.

Parameters:

token - the SOAP authentication token.

groupName - the name of the group to find.

Returns:

a RemoteGroup object for the found group or null if it cant be found.

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteException

RemoteValidationException

createGroup

RemoteGroup createGroup(String token,
                        String groupName,
                        RemoteUser firstUser)
                        throws RemotePermissionException,
                               RemoteAuthenticationException,
                               RemoteException,
                               RemoteValidationException

Creates a group with the given name optionally adding the given user to it.

Parameters:

token - the SOAP authentication token.

groupName - the name of the group to create.

firstUser - the user to add to the group (if null, no user will be added).

Returns:

the group.

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteException

RemoteValidationException - If there is a problem with the group name, such as if the group name exists.

addUserToGroup

void addUserToGroup(String token,
                    RemoteGroup group,
                    RemoteUser ruser)
                    throws RemotePermissionException,
                           RemoteAuthenticationException,
                           RemoteException,
                           RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

removeUserFromGroup

void removeUserFromGroup(String token,
                         RemoteGroup group,
                         RemoteUser ruser)
                         throws RemotePermissionException,
                                RemoteAuthenticationException,
                                RemoteException,
                                RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

updateGroup

RemoteGroup updateGroup(String token,
                        RemoteGroup group)
                        throws RemotePermissionException,
                               RemoteAuthenticationException,
                               RemoteException,
                               RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

deleteGroup

void deleteGroup(String token,
                 String groupName,
                 String swapGroupName)
                 throws RemotePermissionException,
                        RemoteAuthenticationException,
                        RemoteException,
                        RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

getSavedFilters

RemoteFilter[] getSavedFilters(String token)
                               throws RemotePermissionException,
                                      RemoteAuthenticationException,
                                      RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getIssue

RemoteIssue getIssue(String token,
                     String issueKey)
                     throws RemotePermissionException,
                            RemoteAuthenticationException,
                            RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getComment

RemoteComment getComment(String token,
                         Long id)
                         throws RemoteException

Throws:

RemoteException

getComments

RemoteComment[] getComments(String token,
                            String issueKey)
                            throws RemotePermissionException,
                                   RemoteAuthenticationException,
                                   RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

createIssue

RemoteIssue createIssue(String token,
                        RemoteIssue rIssue)
                        throws RemotePermissionException,
                               RemoteAuthenticationException,
                               RemoteException,
                               RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

addAttachmentsToIssue

boolean addAttachmentsToIssue(String token,
                              String issueKey,
                              String[] fileNames,
                              byte[][] attachments)
                              throws RemotePermissionException,
                                     RemoteAuthenticationException,
                                     RemoteException,
                                     RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

getAttachmentsFromIssue

RemoteAttachment[] getAttachmentsFromIssue(String token,
                                           String issueKey)
                                           throws RemotePermissionException,
                                                  RemoteAuthenticationException,
                                                  RemoteException,
                                                  RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

deleteIssue

void deleteIssue(String token,
                 String issueKey)
                 throws RemotePermissionException,
                        RemoteAuthenticationException,
                        RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

createProject

RemoteProject createProject(String token,
                            String key,
                            String name,
                            String description,
                            String url,
                            String lead,
                            RemotePermissionScheme permissionScheme,
                            RemoteScheme notificationScheme,
                            RemoteScheme issueSecurityScheme)
                            throws RemotePermissionException,
                                   RemoteAuthenticationException,
                                   RemoteException,
                                   RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

createProjectFromObject

RemoteProject createProjectFromObject(String token,
                                      RemoteProject rproject)
                                      throws RemotePermissionException,
                                             RemoteAuthenticationException,
                                             RemoteException,
                                             RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

updateProject

RemoteProject updateProject(String token,
                            RemoteProject rProject)
                            throws RemotePermissionException,
                                   RemoteAuthenticationException,
                                   RemoteException,
                                   RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

deleteProject

void deleteProject(String token,
                   String projectKey)
                   throws RemotePermissionException,
                          RemoteAuthenticationException,
                          RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getNotificationSchemes

RemoteScheme[] getNotificationSchemes(String token)
                                      throws RemotePermissionException,
                                             RemoteAuthenticationException,
                                             RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getPermissionSchemes

RemotePermissionScheme[] getPermissionSchemes(String token)
                                              throws RemotePermissionException,
                                                     RemoteAuthenticationException,
                                                     RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getSecuritySchemes

RemoteScheme[] getSecuritySchemes(String token)
                                  throws RemotePermissionException,
                                         RemoteAuthenticationException,
                                         RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getAllPermissions

RemotePermission[] getAllPermissions(String token)
                                     throws RemotePermissionException,
                                            RemoteException,
                                            RemoteAuthenticationException

Throws:

RemotePermissionException

RemoteException

RemoteAuthenticationException

createPermissionScheme

RemotePermissionScheme createPermissionScheme(String token,
                                              String name,
                                              String description)
                                              throws RemotePermissionException,
                                                     RemoteException,
                                                     RemoteAuthenticationException,
                                                     RemoteValidationException

Throws:

RemotePermissionException

RemoteException

RemoteAuthenticationException

RemoteValidationException

addPermissionTo

RemotePermissionScheme addPermissionTo(String token,
                                       RemotePermissionScheme permissionScheme,
                                       RemotePermission permission,
                                       RemoteEntity remoteEntity)
                                       throws RemotePermissionException,
                                              RemoteException,
                                              RemoteValidationException,
                                              RemoteAuthenticationException

Throws:

RemotePermissionException

RemoteException

RemoteValidationException

RemoteAuthenticationException

deletePermissionFrom

RemotePermissionScheme deletePermissionFrom(String token,
                                            RemotePermissionScheme permissionSchemeName,
                                            RemotePermission permission,
                                            RemoteEntity remoteEntity)
                                            throws RemotePermissionException,
                                                   RemoteException,
                                                   RemoteAuthenticationException,
                                                   RemoteValidationException

Throws:

RemotePermissionException

RemoteException

RemoteAuthenticationException

RemoteValidationException

deletePermissionScheme

void deletePermissionScheme(String token,
                            String permissionSchemeName)
                            throws RemotePermissionException,
                                   RemoteException,
                                   RemoteAuthenticationException,
                                   RemoteValidationException

Throws:

RemotePermissionException

RemoteException

RemoteAuthenticationException

RemoteValidationException

addComment

void addComment(String token,
                String issueKey,
                RemoteComment remoteComment)
                throws RemotePermissionException,
                       RemoteAuthenticationException,
                       RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

hasPermissionToEditComment

boolean hasPermissionToEditComment(String token,
                                   RemoteComment remoteComment)
                                   throws RemoteException

Throws:

RemoteException

editComment

RemoteComment editComment(String token,
                          RemoteComment remoteComment)
                          throws RemoteException

Throws:

RemoteException

updateIssue

RemoteIssue updateIssue(String token,
                        String issueKey,
                        RemoteFieldValue[] actionParams)
                        throws RemoteException

Throws:

RemoteException

getFieldsForEdit

RemoteField[] getFieldsForEdit(String token,
                               String issueKey)
                               throws RemoteException

Throws:

RemoteException

getAvailableActions

RemoteNamedObject[] getAvailableActions(String token,
                                        String issueKey)
                                        throws RemoteException

Throws:

RemoteException

getFieldsForAction

RemoteField[] getFieldsForAction(String token,
                                 String issueKey,
                                 String actionIdString)
                                 throws RemoteException

Throws:

RemoteException

progressWorkflowAction

RemoteIssue progressWorkflowAction(String token,
                                   String issueKey,
                                   String actionIdString,
                                   RemoteFieldValue[] actionParams)
                                   throws RemoteException

Throws:

RemoteException

getCustomFields

RemoteField[] getCustomFields(String token)
                              throws RemoteException

Throws:

RemoteException

addVersion

RemoteVersion addVersion(String token,
                         String projectKey,
                         RemoteVersion remoteVersion)
                         throws RemoteException

Throws:

RemoteException

refreshCustomFields

void refreshCustomFields(String token)
                         throws RemoteException

Throws:

RemoteException

getIssuesFromFilter

RemoteIssue[] getIssuesFromFilter(String token,
                                  String filterId)
                                  throws RemoteException

Throws:

RemoteException

getIssuesFromTextSearch

RemoteIssue[] getIssuesFromTextSearch(String token,
                                      String searchTerms)
                                      throws RemoteException

Returns issues containing searchTerms. Note: this is a fuzzy search, returned in order of 'relevance', so the results are only generally useful for human consumption. A full search interface is yet to be implemented - see JRA-7626.

Throws:

RemoteException

getIssuesFromTextSearchWithProject

RemoteIssue[] getIssuesFromTextSearchWithProject(String token,
                                                 String[] projectKeys,
                                                 String searchTerms,
                                                 int maxNumResults)
                                                 throws RemoteException

Throws:

RemoteException

getProjectsNoSchemes

RemoteProject[] getProjectsNoSchemes(String token)
                                     throws RemotePermissionException,
                                            RemoteAuthenticationException,
                                            RemoteException

Returns an array of all the Projects defined in JIRA.

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteProject objects.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getIssueCountForFilter

long getIssueCountForFilter(String token,
                            String filterId)
                            throws RemoteException

Throws:

RemoteException

getIssueById

RemoteIssue getIssueById(String token,
                         String issueId)
                         throws RemotePermissionException,
                                RemoteAuthenticationException,
                                RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getConfiguration

RemoteConfiguration getConfiguration(String token)
                                     throws RemotePermissionException,
                                            RemoteAuthenticationException,
                                            RemoteException

Returns information about the current configuration of JIRA.

Parameters:

token - the authr

Returns:

a RemoteConfiguration object which contains information about the current configuration of JIRA.

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getProjectRoles

RemoteProjectRole[] getProjectRoles(String token)
                                    throws RemoteException

Throws:

RemoteException

getProjectRole

RemoteProjectRole getProjectRole(String token,
                                 Long id)
                                 throws RemoteException

Throws:

RemoteException

createProjectRole

RemoteProjectRole createProjectRole(String token,
                                    RemoteProjectRole projectRole)
                                    throws RemoteException

Throws:

RemoteException

isProjectRoleNameUnique

boolean isProjectRoleNameUnique(String token,
                                String name)
                                throws RemoteException

Throws:

RemoteException

deleteProjectRole

void deleteProjectRole(String token,
                       RemoteProjectRole projectRole,
                       boolean confirm)
                       throws RemoteException

Throws:

RemoteException

addActorsToProjectRole

void addActorsToProjectRole(String token,
                            String[] actors,
                            RemoteProjectRole projectRole,
                            RemoteProject project,
                            String actorType)
                            throws RemoteException

Throws:

RemoteException

removeActorsFromProjectRole

void removeActorsFromProjectRole(String token,
                                 String[] actors,
                                 RemoteProjectRole projectRole,
                                 RemoteProject project,
                                 String actorType)
                                 throws RemoteException

Throws:

RemoteException

updateProjectRole

void updateProjectRole(String token,
                       RemoteProjectRole projectRole)
                       throws RemoteException

Throws:

RemoteException

getProjectRoleActors

RemoteProjectRoleActors getProjectRoleActors(String token,
                                             RemoteProjectRole projectRole,
                                             RemoteProject project)
                                             throws RemoteException

Throws:

RemoteException

getDefaultRoleActors

RemoteRoleActors getDefaultRoleActors(String token,
                                      RemoteProjectRole projectRole)
                                      throws RemoteException

Throws:

RemoteException

addDefaultActorsToProjectRole

void addDefaultActorsToProjectRole(String token,
                                   String[] actors,
                                   RemoteProjectRole projectRole,
                                   String type)
                                   throws RemoteException

Throws:

RemoteException

removeDefaultActorsFromProjectRole

void removeDefaultActorsFromProjectRole(String token,
                                        String[] actors,
                                        RemoteProjectRole projectRole,
                                        String actorType)
                                        throws RemoteException

Throws:

RemoteException

removeAllRoleActorsByNameAndType

void removeAllRoleActorsByNameAndType(String token,
                                      String name,
                                      String type)
                                      throws RemoteException

Throws:

RemoteException

removeAllRoleActorsByProject

void removeAllRoleActorsByProject(String token,
                                  RemoteProject project)
                                  throws RemoteException

Throws:

RemoteException

getAssociatedNotificationSchemes

RemoteScheme[] getAssociatedNotificationSchemes(String token,
                                                RemoteProjectRole projectRole)
                                                throws RemoteException

Throws:

RemoteException

getAssociatedPermissionSchemes

RemoteScheme[] getAssociatedPermissionSchemes(String token,
                                              RemoteProjectRole projectRole)
                                              throws RemoteException

Throws:

RemoteException

releaseVersion

void releaseVersion(String token,
                    String projectKey,
                    RemoteVersion version)
                    throws RemoteException

Throws:

RemoteException

archiveVersion

void archiveVersion(String token,
                    String projectKey,
                    String versionName,
                    boolean archive)
                    throws RemoteException

Throws:

RemoteException

addWorklogWithNewRemainingEstimate

RemoteWorklog addWorklogWithNewRemainingEstimate(String token,
                                                 String issueKey,
                                                 RemoteWorklog remoteWorklog,
                                                 String newRemainingEstimate)
                                                 throws RemoteException,
                                                        RemotePermissionException,
                                                        RemoteValidationException

Adds a worklog to the given issue and sets the issue's remaining estimate field to the given value. The issue's time spent field will be increased by the amount in the remoteWorklog.getTimeSpent().

The following fields of remoteWorklog are ignored:

• id: generated by the system.
• author: derived from the authenticated user.
• updatedAuthor: derived from the authenticated user.
• created: derived from the current date.
• updated: derived from the current date.

Parameters:

token - the SOAP auth token.

issueKey - the key of the issue.

remoteWorklog - the worklog to add.

newRemainingEstimate - the new value for the issue's remaining estimate in seconds.

Returns:

Created worklog with the id set or null if no worklog was created.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

addWorklogAndAutoAdjustRemainingEstimate

RemoteWorklog addWorklogAndAutoAdjustRemainingEstimate(String token,
                                                       String issueKey,
                                                       RemoteWorklog remoteWorklog)
                                                       throws RemoteException,
                                                              RemotePermissionException,
                                                              RemoteValidationException

Adds a worklog to the given issue and sets the issue's remaining estimate field to the given value. The issue's time spent field will be increased by the amount in the remoteWorklog.getTimeSpent().

The following fields of remoteWorklog are ignored:

• id: generated by the system.
• author: derived from the authenticated user.
• updatedAuthor: derived from the authenticated user.
• created: derived from the current date.
• updated: derived from the current date.

Parameters:

token - the SOAP auth token.

issueKey - the key of the issue.

remoteWorklog - the worklog to add.

Returns:

Created worklog with the id set or null if no worklog was created.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

addWorklogAndRetainRemainingEstimate

RemoteWorklog addWorklogAndRetainRemainingEstimate(String token,
                                                   String issueKey,
                                                   RemoteWorklog remoteWorklog)
                                                   throws RemoteException,
                                                          RemotePermissionException,
                                                          RemoteValidationException

Adds a worklog to the given issue but leaves the issue's remaining estimate field unchanged. The issue's time spent field will be increased by the amount in the remoteWorklog.getTimeSpent().

The following fields of remoteWorklog are ignored:

• id: generated by the system.
• author: derived from the authenticated user.
• updatedAuthor: derived from the authenticated user.
• created: derived from the current date.
• updated: derived from the current date.

Parameters:

token - the SOAP auth token.

issueKey - the key of the issue.

remoteWorklog - the worklog to add.

Returns:

Created worklog with the id set or null if no worklog was created.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

getWorklogs

RemoteWorklog[] getWorklogs(String token,
                            String issueKey)
                            throws RemoteException,
                                   RemotePermissionException,
                                   RemoteValidationException

Returns all worklogs for the given issue.

Parameters:

token - the SOAP auth token.

issueKey - the key of the issue.

Returns:

all the worklogs of the issue.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

deleteWorklogWithNewRemainingEstimate

void deleteWorklogWithNewRemainingEstimate(String token,
                                           String worklogId,
                                           String newRemainingEstimate)
                                           throws RemoteException,
                                                  RemotePermissionException,
                                                  RemoteValidationException

Deletes the worklog with the given id and sets the remaining estimate field on the isssue to the given value. The time spent field of the issue is reduced by the time spent amount on the worklog being deleted.

Parameters:

token - the SOAP auth token.

worklogId - the id of the worklog to delete.

newRemainingEstimate - the new value for the issue's remaining estimate in seconds.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

deleteWorklogAndAutoAdjustRemainingEstimate

void deleteWorklogAndAutoAdjustRemainingEstimate(String token,
                                                 String worklogId)
                                                 throws RemoteException,
                                                        RemotePermissionException,
                                                        RemoteValidationException

Deletes the worklog with the given id and updates the remaining estimate field on the isssue by increasing it by the time spent amount on the worklog being deleted. The time spent field of the issue is reduced by the time spent amount on the worklog being deleted.

Parameters:

token - the SOAP auth token.

worklogId - the id of the worklog to delete.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

deleteWorklogAndRetainRemainingEstimate

void deleteWorklogAndRetainRemainingEstimate(String token,
                                             String worklogId)
                                             throws RemoteException,
                                                    RemotePermissionException,
                                                    RemoteValidationException

Deletes the worklog with the given id but leaves the remaining estimate field on the isssue unchanged. The time spent field of the issue is reduced by the time spent amount on the worklog being deleted.

Parameters:

token - the SOAP auth token.

worklogId - the id of the worklog to delete.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

updateWorklogWithNewRemainingEstimate

void updateWorklogWithNewRemainingEstimate(String token,
                                           RemoteWorklog remoteWorklog,
                                           String newRemainingEstimate)
                                           throws RemoteException,
                                                  RemotePermissionException,
                                                  RemoteValidationException

Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog and sets the remaining estimate field on the relevant issue to the given value. The time spent field of the issue is changed by subtracting the previous value of the worklog's time spent amount and adding the new value in the given worklog.

The following fields of remoteWorklog are ignored:

• author: unchanged.
• updatedAuthor: derived from the authenticated user.
• created: unchanged.
• updated: derived from the current date.

Parameters:

token - the SOAP auth token.

remoteWorklog - the worklog to update.

newRemainingEstimate - the new value for the issue's remaining estimate in seconds.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

updateWorklogAndAutoAdjustRemainingEstimate

void updateWorklogAndAutoAdjustRemainingEstimate(String token,
                                                 RemoteWorklog remoteWorklog)
                                                 throws RemoteException,
                                                        RemotePermissionException,
                                                        RemoteValidationException

Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog and changes the remaining estimate field on the relevant issue to the value obtained by adding the previous time spent amount of the worklog and subtracting the new time spent amount. The time spent field of the issue is changed by subtracting the previous value of the worklog's time spent amount and adding the new value in the given worklog.

The following fields of remoteWorklog are ignored:

• author: unchanged.
• updatedAuthor: derived from the authenticated user.
• created: unchanged.
• updated: derived from the current date.

Parameters:

token - the SOAP auth token.

remoteWorklog - the worklog to update.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

updateWorklogAndRetainRemainingEstimate

void updateWorklogAndRetainRemainingEstimate(String token,
                                             RemoteWorklog remoteWorklog)
                                             throws RemoteException,
                                                    RemotePermissionException,
                                                    RemoteValidationException

Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog but leaves the remaining estimate field on the relevant issue unchanged. The time spent field of the issue is changed by subtracting the previous value of the worklog's time spent amount and adding the new value in the given worklog.

The following fields of remoteWorklog are ignored:

• author: unchanged.
• updatedAuthor: derived from the authenticated user.
• created: unchanged.
• updated: derived from the current date.

Parameters:

token - the SOAP auth token.

remoteWorklog - the worklog to update.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

hasPermissionToCreateWorklog

boolean hasPermissionToCreateWorklog(String token,
                                     String issueKey)
                                     throws RemoteException,
                                            RemoteValidationException

Determines if the user has the permission to add worklogs to the specified issue, that timetracking is enabled in JIRA and that the specified issue is in an editable workflow state.

Parameters:

token - the SOAP auth token.

issueKey - the key of the issue.

Returns:

true if the user has permission to create a worklog on the specified issue, false otherwise

Throws:

RemoteException

RemoteValidationException

hasPermissionToDeleteWorklog

boolean hasPermissionToDeleteWorklog(String token,
                                     String worklogId)
                                     throws RemoteException,
                                            RemoteValidationException

Determine whether the current user has the permission to delete the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.

This method will return true if the user is a member of the worklog's group/role level (if specified) AND

• The user has the WORKLOG_DELETE_ALL permission; OR
• The user is the worklog author and has the WORKLOG_DELETE_OWN permission

and false otherwise.

Parameters:

token - the SOAP auth token.

worklogId - the id of the worklog wishes to delete.

Returns:

true if the user has permission to delete the supplied worklog, false otherwise

Throws:

RemoteException

RemoteValidationException

hasPermissionToUpdateWorklog

boolean hasPermissionToUpdateWorklog(String token,
                                     String worklogId)
                                     throws RemoteException,
                                            RemoteValidationException

Determine whether the current user has the permission to update the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.

This method will return true if the user is a member of the worklog's group/role level (if specified) AND

• The user has the WORKLOG_EDIT_ALL permission; OR
• The user is the worklog author and has the WORKLOG_EDIT_OWN permission

and false otherwise.

Parameters:

token - the SOAP authentication token.

worklogId - the ide of the worklog wishes to update.

Returns:

true if the user has permission to update the supplied worklog, false otherwise

Throws:

RemoteException

RemoteValidationException