com.atlassian.jira.rpc.soap
Class JiraSoapServiceImpl

java.lang.Object
  com.atlassian.jira.rpc.soap.JiraSoapServiceImpl

All Implemented Interfaces:

JiraSoapService, com.atlassian.jira.soap.axis.JiraSoapTokenResolver

public class JiraSoapServiceImpl
extends java.lang.Object
implements JiraSoapService, com.atlassian.jira.soap.axis.JiraSoapTokenResolver

Constructor Summary

JiraSoapServiceImpl(TokenManager tokenManager, ProjectService projectService, IssueService issueService, UserService userService, SchemeService schemeService, AdminService adminService, SearchService searchService, ProjectRoleService projectRoleService, IssueConstantsService issueConstantsService)

Method Summary

void	addActorsToProjectRole(java.lang.String token, java.lang.String[] actors, RemoteProjectRole projectRole, RemoteProject project, java.lang.String actorType)
boolean	addAttachmentsToIssue(java.lang.String token, java.lang.String issueKey, java.lang.String[] fileNames, byte[][] attachments) Add attachments to an issue.
boolean	addBase64EncodedAttachmentsToIssue(java.lang.String token, java.lang.String issueKey, java.lang.String[] fileNames, java.lang.String[] base64EncodedAttachmentData) An alternative mechanism for adding attachments to an issue.
void	addComment(java.lang.String token, java.lang.String issueKey, RemoteComment remoteComment) Adds a comment to the specified issue
void	addDefaultActorsToProjectRole(java.lang.String token, java.lang.String[] actorNames, RemoteProjectRole projectRole, java.lang.String type)
RemotePermissionScheme	addPermissionTo(java.lang.String token, RemotePermissionScheme permissionScheme, RemotePermission permission, RemoteEntity remoteEntity)
void	addUserToGroup(java.lang.String token, RemoteGroup group, RemoteUser ruser) Adds the specified user to the specified group
RemoteVersion	addVersion(java.lang.String token, java.lang.String projectKey, RemoteVersion remoteVersion) Addsa a new version to the specified project.
RemoteWorklog	addWorklogAndAutoAdjustRemainingEstimate(java.lang.String token, java.lang.String issueKey, RemoteWorklog remoteWorklog) Adds a worklog to the given issue.
RemoteWorklog	addWorklogAndRetainRemainingEstimate(java.lang.String token, java.lang.String issueKey, RemoteWorklog remoteWorklog) Adds a worklog to the given issue but leaves the issue's remaining estimate field unchanged.
RemoteWorklog	addWorklogWithNewRemainingEstimate(java.lang.String token, java.lang.String issueKey, RemoteWorklog remoteWorklog, java.lang.String newRemainingEstimate) Adds a worklog to the given issue and sets the issue's remaining estimate field to the given value.
void	archiveVersion(java.lang.String token, java.lang.String projectKey, java.lang.String versionName, boolean archive)
RemoteGroup	createGroup(java.lang.String token, java.lang.String groupName, RemoteUser firstUser) Creates a group with the given name optionally adding the given user to it.
RemoteIssue	createIssue(java.lang.String token, RemoteIssue rIssue) This will create an issue based on the passed in details.
RemoteIssue	createIssueWithParent(java.lang.String token, RemoteIssue rIssue, java.lang.String parentIssueKey) This will create an issue based on the passed in details and make it a child (eg subtask) of the specified parent issue.
RemoteIssue	createIssueWithParentWithSecurityLevel(java.lang.String token, RemoteIssue rIssue, java.lang.String parentIssueKey, java.lang.Long securityLevelId) This will create an issue based on the passed in details and use the security level and make it a child (eg subtask) of the specified parent issue.
RemoteIssue	createIssueWithSecurityLevel(java.lang.String token, RemoteIssue rIssue, java.lang.Long securityLevelId) This will create an issue based on the passed in details and use the security level See also JiraSoapService.createIssue(String, com.atlassian.jira.rpc.soap.beans.RemoteIssue)
RemotePermissionScheme	createPermissionScheme(java.lang.String token, java.lang.String name, java.lang.String description)
RemoteProject	createProject(java.lang.String token, java.lang.String key, java.lang.String name, java.lang.String description, java.lang.String url, java.lang.String lead, RemotePermissionScheme permissionScheme, RemoteScheme notificationScheme, RemoteScheme issueSecurityScheme) Creates a project based on the passed in details.
RemoteProject	createProjectFromObject(java.lang.String token, RemoteProject rproject) Creates a project based on the passed in details.
RemoteProjectRole	createProjectRole(java.lang.String token, RemoteProjectRole projectRole)
RemoteUser	createUser(java.lang.String token, java.lang.String username, java.lang.String password, java.lang.String fullName, java.lang.String email) Creates a user in JIRA with the specified user details.
void	deleteGroup(java.lang.String token, java.lang.String groupName, java.lang.String swapGroupName) Deletes the specified group by name
void	deleteIssue(java.lang.String token, java.lang.String issueKey) This will delete an issue with the specified issue key
RemotePermissionScheme	deletePermissionFrom(java.lang.String token, RemotePermissionScheme permissionSchemeName, RemotePermission permission, RemoteEntity remoteEntity)
void	deletePermissionScheme(java.lang.String token, java.lang.String permissionSchemeName)
void	deleteProject(java.lang.String token, java.lang.String projectKey) This will delete a project with the specified project key
void	deleteProjectAvatar(java.lang.String token, long avatarId) Deletes the given custom Avatar from the system.
void	deleteProjectRole(java.lang.String token, RemoteProjectRole projectRole, boolean confirm)
void	deleteUser(java.lang.String token, java.lang.String username) Deletes a user in JIRA with the specified username.
void	deleteWorklogAndAutoAdjustRemainingEstimate(java.lang.String token, java.lang.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(java.lang.String token, java.lang.String worklogId) Deletes the worklog with the given id but leaves the remaining estimate field on the isssue unchanged.
void	deleteWorklogWithNewRemainingEstimate(java.lang.String token, java.lang.String worklogId, java.lang.String newRemainingEstimate) Deletes the worklog with the given id and sets the remaining estimate field on the isssue to the given value.
RemoteComment	editComment(java.lang.String token, RemoteComment remoteComment) Allows a comment to be edited
RemotePermission[]	getAllPermissions(java.lang.String token)
RemoteScheme[]	getAssociatedNotificationSchemes(java.lang.String token, RemoteProjectRole projectRole)
RemoteScheme[]	getAssociatedPermissionSchemes(java.lang.String token, RemoteProjectRole projectRole)
RemoteAttachment[]	getAttachmentsFromIssue(java.lang.String token, java.lang.String issueKey) Returns the attachments that are associated with an issue
RemoteNamedObject[]	getAvailableActions(java.lang.String token, java.lang.String issueKey) Returns the available actions that can be applied to an issue.
RemoteComment	getComment(java.lang.String token, java.lang.Long id) Gets a specific comment by comment id
RemoteComment[]	getComments(java.lang.String token, java.lang.String issueKey) Gets the comments for an issue
RemoteComponent[]	getComponents(java.lang.String token, java.lang.String projectKey) Returns an array of all the components for the specified project key.
RemoteConfiguration	getConfiguration(java.lang.String token) Returns information about the current configuration of JIRA.
RemoteField[]	getCustomFields(java.lang.String token) Returns all the custom fields available
RemoteRoleActors	getDefaultRoleActors(java.lang.String token, RemoteProjectRole projectRole)
RemoteFilter[]	getFavouriteFilters(java.lang.String token) This retreives a list of the currently logged in user's favourite fitlers.
RemoteField[]	getFieldsForAction(java.lang.String token, java.lang.String issueKey, java.lang.String actionIdString) Returns the fields that are shown during an issue action.
RemoteField[]	getFieldsForCreate(java.lang.String token, java.lang.String projectKey, java.lang.Long issueTypeId) Returns the fields that are shown during an issue creation.
RemoteField[]	getFieldsForEdit(java.lang.String token, java.lang.String issueKey) Returns the fields that are shown during an issue edit.
RemoteGroup	getGroup(java.lang.String token, java.lang.String groupName) Find the group with the specified name in JIRA.
RemoteIssue	getIssue(java.lang.String token, java.lang.String issueKey) Returns information about the specific issue as identified by the issue key
RemoteIssue	getIssueById(java.lang.String token, java.lang.String issueId) Returns information about the specific issue as identified by the issue id
long	getIssueCountForFilter(java.lang.String token, java.lang.String filterId) Returns the count of issues that would be returned for a given filter
RemoteIssue[]	getIssuesFromFilter(java.lang.String token, java.lang.String filterId) Returns issues that match the saved filter specified by the filterId.
RemoteIssue[]	getIssuesFromFilterWithLimit(java.lang.String token, java.lang.String filterId, int offSet, int maxNumResults) Returns issues that match the saved filter specified by the filterId.
RemoteIssue[]	getIssuesFromJqlSearch(java.lang.String token, java.lang.String jqlSearch, int maxNumResults) Execute a specified JQL query and return the resulting issues.
RemoteIssue[]	getIssuesFromTextSearch(java.lang.String token, java.lang.String searchTerms) Returns issues containing searchTerms.
RemoteIssue[]	getIssuesFromTextSearchWithLimit(java.lang.String token, java.lang.String searchTerms, int offSet, int maxNumResults) Returns issues containing searchTerms.
RemoteIssue[]	getIssuesFromTextSearchWithProject(java.lang.String token, java.lang.String[] projectKeys, java.lang.String searchTerms, int maxNumResults) Returns issues containing searchTerms that are within the specified projects.
RemoteIssueType[]	getIssueTypes(java.lang.String token) Returns an array of all the issue types for all projects in JIRA.
RemoteIssueType[]	getIssueTypesForProject(java.lang.String token, java.lang.String projectId) Returns an array of all the (non-sub task) issue types for the specified project id.
RemoteScheme[]	getNotificationSchemes(java.lang.String token)
RemotePermissionScheme[]	getPermissionSchemes(java.lang.String token)
RemotePriority[]	getPriorities(java.lang.String token) Returns an array of all the issue priorities in JIRA.
RemoteAvatar	getProjectAvatar(java.lang.String token, java.lang.String projectKey) Retrieves the current avatar for the given project.
RemoteAvatar[]	getProjectAvatars(java.lang.String token, java.lang.String projectKey, boolean includeSystemAvatars) Retrieves avatars for the given project.
RemoteProject	getProjectById(java.lang.String token, java.lang.Long projectId) Returns the Project with the matching id (if the user has permission to browse it).
RemoteProject	getProjectByKey(java.lang.String token, java.lang.String projectKey) Returns the Project with the matching key (if the user has permission to browse it).
RemoteProjectRole	getProjectRole(java.lang.String token, java.lang.Long id)
RemoteProjectRoleActors	getProjectRoleActors(java.lang.String token, RemoteProjectRole projectRole, RemoteProject project)
RemoteProjectRole[]	getProjectRoles(java.lang.String token)
RemoteProject[]	getProjectsNoSchemes(java.lang.String token) Returns an array of all the Projects defined in JIRA.
RemoteProject	getProjectWithSchemesById(java.lang.String token, java.lang.Long projectId) Returns the Project with the matching id (if the user has permission to browse it) with notification, issue security and permission schemes attached.
java.util.Date	getResolutionDateById(java.lang.String token, java.lang.Long issueId) Given an issue id, this method returns the resolution date for this issue.
java.util.Date	getResolutionDateByKey(java.lang.String token, java.lang.String issueKey) Given an issue key, this method returns the resolution date for this issue.
RemoteResolution[]	getResolutions(java.lang.String token) Returns an array of all the issue resolutions in JIRA.
RemoteFilter[]	getSavedFilters(java.lang.String token) This retrieves a list of the currently logged in user's favourite fitlers.
RemoteSecurityLevel	getSecurityLevel(java.lang.String token, java.lang.String issueKey) Returns the current security level for given issue
RemoteSecurityLevel[]	getSecurityLevels(java.lang.String token, java.lang.String projectKey) Returns an array of all security levels for a given project.
RemoteScheme[]	getSecuritySchemes(java.lang.String token)
RemoteServerInfo	getServerInfo(java.lang.String token) Returns information about the server JIRA is running on including build number and base URL.
RemoteStatus[]	getStatuses(java.lang.String token) Returns an array of all the issue statuses in JIRA.
RemoteIssueType[]	getSubTaskIssueTypes(java.lang.String token) Returns an array of all the sub task issue types in JIRA.
RemoteIssueType[]	getSubTaskIssueTypesForProject(java.lang.String token, java.lang.String projectId) Returns an array of all the sub task issue types for the specified project id.
int	getTokenParameterIndex(java.lang.String operationName) This is called to work out which parameter the token is given a method name
RemoteUser	getUser(java.lang.String token, java.lang.String username) Returns information about a user defined to JIRA.
RemoteVersion[]	getVersions(java.lang.String token, java.lang.String projectKey) Returns an array of all the versions for the specified project key.
RemoteWorklog[]	getWorklogs(java.lang.String token, java.lang.String issueKey) Returns all worklogs for the given issue.
boolean	hasPermissionToCreateWorklog(java.lang.String token, java.lang.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(java.lang.String token, java.lang.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(java.lang.String token, RemoteComment remoteComment) Returns true if the user has permission to edit a comment
boolean	hasPermissionToUpdateWorklog(java.lang.String token, java.lang.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(java.lang.String token, java.lang.String name)
java.lang.String	login(java.lang.String username, java.lang.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(java.lang.String token) Cleans up an authentication token that was previously created with a call to JiraSoapService.login(String, String)
RemoteIssue	progressWorkflowAction(java.lang.String token, java.lang.String issueKey, java.lang.String actionIdString, RemoteFieldValue[] actionParams) This will progress an issue through a workflow.
void	refreshCustomFields(java.lang.String token) Refreshes the internal representation of all the custom fields available
void	releaseVersion(java.lang.String token, java.lang.String projectKey, RemoteVersion remoteVersion)
void	removeActorsFromProjectRole(java.lang.String token, java.lang.String[] actors, RemoteProjectRole projectRole, RemoteProject project, java.lang.String actorType)
void	removeAllRoleActorsByNameAndType(java.lang.String token, java.lang.String name, java.lang.String type)
void	removeAllRoleActorsByProject(java.lang.String token, RemoteProject project)
void	removeDefaultActorsFromProjectRole(java.lang.String token, java.lang.String[] actors, RemoteProjectRole projectRole, java.lang.String actorType)
void	removeUserFromGroup(java.lang.String token, RemoteGroup group, RemoteUser ruser) Removes the specified user to the specified group
java.lang.String	resolveTokenToUserName(java.lang.String token) This ability to resolve a token into a user name is used by the JIRA logging and is not exposed on the SOAP service interface itself but rather via JiraSoapTokenResolver.
void	setNewProjectAvatar(java.lang.String token, java.lang.String projectKey, java.lang.String contentType, java.lang.String base64ImageData) Creates a new custom avatar for the given project and sets it to be current for the project.
void	setProjectAvatar(java.lang.String token, java.lang.String projectKey, java.lang.Long avatarId) Sets the current avatar for the given project to that with the given id.
void	setTokenManager(TokenManager tokenManager)
void	setUserPassword(java.lang.String token, RemoteUser ruser, java.lang.String newPassword) Sets the password for a specified user
RemoteGroup	updateGroup(java.lang.String token, RemoteGroup group) Updates the details of a group
RemoteIssue	updateIssue(java.lang.String token, java.lang.String issueKey, RemoteFieldValue[] actionParams) This will update an issue with new values.
RemoteProject	updateProject(java.lang.String token, RemoteProject rProject) Updates a project based on the passed in details.
void	updateProjectRole(java.lang.String token, RemoteProjectRole projectRole)
RemoteUser	updateUser(java.lang.String token, RemoteUser ruser) Updates the details about a user
void	updateWorklogAndAutoAdjustRemainingEstimate(java.lang.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(java.lang.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(java.lang.String token, RemoteWorklog remoteWorklog, java.lang.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

JiraSoapServiceImpl

public JiraSoapServiceImpl(TokenManager tokenManager,
                           ProjectService projectService,
                           IssueService issueService,
                           UserService userService,
                           SchemeService schemeService,
                           AdminService adminService,
                           SearchService searchService,
                           ProjectRoleService projectRoleService,
                           IssueConstantsService issueConstantsService)

Method Detail

setTokenManager

public void setTokenManager(TokenManager tokenManager)

resolveTokenToUserName

public java.lang.String resolveTokenToUserName(java.lang.String token)

This ability to resolve a token into a user name is used by the JIRA logging and is not exposed on the SOAP service interface itself but rather via JiraSoapTokenResolver.

Specified by:

resolveTokenToUserName in interface com.atlassian.jira.soap.axis.JiraSoapTokenResolver

Parameters:

token - the given out previously via login(String, String)

Returns:

the user name behind that token or null if the token is not valid

getTokenParameterIndex

public int getTokenParameterIndex(java.lang.String operationName)

This is called to work out which parameter the token is given a method name

Specified by:

getTokenParameterIndex in interface com.atlassian.jira.soap.axis.JiraSoapTokenResolver

Parameters:

operationName - the name of the SOAP operation

Returns:

the parameter index of the user token

login

public java.lang.String login(java.lang.String username,
                              java.lang.String password)
                       throws RemoteException

Description copied from interface: JiraSoapService

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

Specified by:

login in interface JiraSoapService

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

public boolean logout(java.lang.String token)

Description copied from interface: JiraSoapService

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

Specified by:

logout in interface JiraSoapService

Parameters:

token - the SOAP authentication token

Returns:

true if the logout succeeded

getServerInfo

public RemoteServerInfo getServerInfo(java.lang.String token)

Description copied from interface: JiraSoapService

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

Specified by:

getServerInfo in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

Returns:

a RemoteServerInfo object

getProjectsNoSchemes

public RemoteProject[] getProjectsNoSchemes(java.lang.String token)
                                     throws RemoteException

Description copied from interface: JiraSoapService

Returns an array of all the Projects defined in JIRA.

Specified by:

getProjectsNoSchemes in interface JiraSoapService

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

public RemoteProject getProjectById(java.lang.String token,
                                    java.lang.Long projectId)
                             throws RemoteException

Description copied from interface: JiraSoapService

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

Specified by:

getProjectById in interface JiraSoapService

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

getProjectWithSchemesById

public RemoteProject getProjectWithSchemesById(java.lang.String token,
                                               java.lang.Long projectId)
                                        throws RemoteException

Description copied from interface: JiraSoapService

Returns the Project with the matching id (if the user has permission to browse it) with notification, issue security and permission schemes attached.

Specified by:

getProjectWithSchemesById in interface JiraSoapService

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 - if something dramatic happens during this operation

getProjectByKey

public RemoteProject getProjectByKey(java.lang.String token,
                                     java.lang.String projectKey)
                              throws RemoteException

Description copied from interface: JiraSoapService

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

Specified by:

getProjectByKey in interface JiraSoapService

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.

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

RemoteException - if something dramatic happens during this operation

addVersion

public RemoteVersion addVersion(java.lang.String token,
                                java.lang.String projectKey,
                                RemoteVersion remoteVersion)
                         throws RemoteException

Description copied from interface: JiraSoapService

Addsa a new version to the specified project.

Specified by:

addVersion in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

projectKey - the key of the project to add the new version to

remoteVersion - the new version details

Returns:

the newly added version

Throws:

RemoteException - If something dramatic happened during the execution of the operation

getVersions

public RemoteVersion[] getVersions(java.lang.String token,
                                   java.lang.String projectKey)
                            throws RemoteException

Description copied from interface: JiraSoapService

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

Specified by:

getVersions in interface JiraSoapService

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

public RemoteComponent[] getComponents(java.lang.String token,
                                       java.lang.String projectKey)
                                throws RemoteException

Description copied from interface: JiraSoapService

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

Specified by:

getComponents in interface JiraSoapService

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

public RemoteIssueType[] getIssueTypesForProject(java.lang.String token,
                                                 java.lang.String projectId)
                                          throws RemotePermissionException,
                                                 RemoteAuthenticationException

Description copied from interface: JiraSoapService

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

Specified by:

getIssueTypesForProject in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

projectId - id of the project

Returns:

an array of RemoteIssueType objects

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

getSubTaskIssueTypesForProject

public RemoteIssueType[] getSubTaskIssueTypesForProject(java.lang.String token,
                                                        java.lang.String projectId)
                                                 throws RemotePermissionException,
                                                        RemoteAuthenticationException

Description copied from interface: JiraSoapService

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

Specified by:

getSubTaskIssueTypesForProject in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

projectId - id of the project

Returns:

an array of RemoteIssueType objects

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

getIssueTypes

public RemoteIssueType[] getIssueTypes(java.lang.String token)
                                throws RemotePermissionException,
                                       RemoteAuthenticationException

Description copied from interface: JiraSoapService

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

Specified by:

getIssueTypes in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteIssueType objects

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

getSubTaskIssueTypes

public RemoteIssueType[] getSubTaskIssueTypes(java.lang.String token)
                                       throws RemotePermissionException,
                                              RemoteAuthenticationException

Description copied from interface: JiraSoapService

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

Specified by:

getSubTaskIssueTypes in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteIssueType objects

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

getPriorities

public RemotePriority[] getPriorities(java.lang.String token)
                               throws RemotePermissionException,
                                      RemoteAuthenticationException

Description copied from interface: JiraSoapService

Returns an array of all the issue priorities in JIRA.

Specified by:

getPriorities in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemotePriority objects

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

getStatuses

public RemoteStatus[] getStatuses(java.lang.String token)
                           throws RemotePermissionException,
                                  RemoteAuthenticationException

Description copied from interface: JiraSoapService

Returns an array of all the issue statuses in JIRA.

Specified by:

getStatuses in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteStatus objects

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

getResolutions

public RemoteResolution[] getResolutions(java.lang.String token)
                                  throws RemotePermissionException,
                                         RemoteAuthenticationException

Description copied from interface: JiraSoapService

Returns an array of all the issue resolutions in JIRA.

Specified by:

getResolutions in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteResolution objects

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

getGroup

public RemoteGroup getGroup(java.lang.String token,
                            java.lang.String groupName)
                     throws RemoteException

Description copied from interface: JiraSoapService

Find the group with the specified name in JIRA.

Specified by:

getGroup in interface JiraSoapService

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

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

RemoteException

createGroup

public RemoteGroup createGroup(java.lang.String token,
                               java.lang.String groupName,
                               RemoteUser firstUser)
                        throws RemoteException

Description copied from interface: JiraSoapService

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

Specified by:

createGroup in interface JiraSoapService

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

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

RemoteException

addUserToGroup

public void addUserToGroup(java.lang.String token,
                           RemoteGroup group,
                           RemoteUser ruser)
                    throws RemoteException

Description copied from interface: JiraSoapService

Adds the specified user to the specified group

Specified by:

addUserToGroup in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

group - the name of the group to add the user to.

ruser - the name of the user to add

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 there is a problem with the operation.

RemoteException

removeUserFromGroup

public void removeUserFromGroup(java.lang.String token,
                                RemoteGroup group,
                                RemoteUser ruser)
                         throws RemoteException

Description copied from interface: JiraSoapService

Removes the specified user to the specified group

Specified by:

removeUserFromGroup in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

group - the name of the group to remove the user from.

ruser - the name of the user to remove

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 there is a problem with the operation.

RemoteException

updateGroup

public RemoteGroup updateGroup(java.lang.String token,
                               RemoteGroup group)
                        throws RemoteException

Description copied from interface: JiraSoapService

Updates the details of a group

Specified by:

updateGroup in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

group - the to be updated group

Returns:

the new roup information

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 there is a problem with the operation.

RemoteException

deleteGroup

public void deleteGroup(java.lang.String token,
                        java.lang.String groupName,
                        java.lang.String swapGroupName)
                 throws RemoteException

Description copied from interface: JiraSoapService

Deletes the specified group by name

Specified by:

deleteGroup in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

groupName - the name of the group to delete.

swapGroupName - identifies the group to change comment and worklog visibility to.

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 there is a problem with the operation.

RemoteException

getUser

public RemoteUser getUser(java.lang.String token,
                          java.lang.String username)
                   throws RemotePermissionException,
                          RemoteAuthenticationException

Description copied from interface: JiraSoapService

Returns information about a user defined to JIRA.

Specified by:

getUser in interface JiraSoapService

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

public RemoteUser createUser(java.lang.String token,
                             java.lang.String username,
                             java.lang.String password,
                             java.lang.String fullName,
                             java.lang.String email)
                      throws RemoteException

Description copied from interface: JiraSoapService

Creates a user in JIRA with the specified user details.

Specified by:

createUser in interface JiraSoapService

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

updateUser

public RemoteUser updateUser(java.lang.String token,
                             RemoteUser ruser)
                      throws RemotePermissionException,
                             RemoteAuthenticationException,
                             RemoteValidationException,
                             RemoteException

Description copied from interface: JiraSoapService

Updates the details about a user

Specified by:

updateUser in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

ruser - the ruser details to update

Returns:

the new represensentation of the user

Throws:

RemotePermissionException - If the ruser 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

setUserPassword

public void setUserPassword(java.lang.String token,
                            RemoteUser ruser,
                            java.lang.String newPassword)
                     throws RemotePermissionException,
                            RemoteAuthenticationException,
                            RemoteValidationException,
                            RemoteException

Description copied from interface: JiraSoapService

Sets the password for a specified user

Specified by:

setUserPassword in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

ruser - the ruser to update

newPassword - the new password for that user

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

public void deleteUser(java.lang.String token,
                       java.lang.String username)
                throws RemoteException

Description copied from interface: JiraSoapService

Deletes a user in JIRA with the specified username.

Specified by:

deleteUser in interface JiraSoapService

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

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

RemoteException

getSavedFilters

public RemoteFilter[] getSavedFilters(java.lang.String token)
                               throws RemoteException

Description copied from interface: JiraSoapService

This retrieves a list of the currently logged in user's favourite fitlers.

Specified by:

getSavedFilters in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

Returns:

a list of the currently logged in user's favourite fitlers.

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 there is a problem with the group name, such as if the group name exists.

RemoteException

getFavouriteFilters

public RemoteFilter[] getFavouriteFilters(java.lang.String token)
                                   throws RemoteException

Description copied from interface: JiraSoapService

This retreives a list of the currently logged in user's favourite fitlers.

Specified by:

getFavouriteFilters in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

Returns:

a list of the currently logged in user's favourite fitlers.

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 there is a problem with the group name, such as if the group name exists.

RemoteException

getAvailableActions

public RemoteNamedObject[] getAvailableActions(java.lang.String token,
                                               java.lang.String issueKey)
                                        throws RemoteException

Description copied from interface: JiraSoapService

Returns the available actions that can be applied to an issue.

Specified by:

getAvailableActions in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

issueKey - the issue to get actions for.

Returns:

the available actions that can be applied to an issue

Throws:

RemoteException - if something dramatic happens during this operation

getFieldsForAction

public RemoteField[] getFieldsForAction(java.lang.String token,
                                        java.lang.String issueKey,
                                        java.lang.String actionIdString)
                                 throws RemoteException

Description copied from interface: JiraSoapService

Returns the fields that are shown during an issue action.

Specified by:

getFieldsForAction in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

issueKey - the issue to update.

actionIdString - the id of issue action to be executed

Returns:

the fields that would be shown during the issue action operation

Throws:

RemoteException - if something dramatic happens during this operation

progressWorkflowAction

public RemoteIssue progressWorkflowAction(java.lang.String token,
                                          java.lang.String issueKey,
                                          java.lang.String actionIdString,
                                          RemoteFieldValue[] actionParams)
                                   throws RemoteException

Description copied from interface: JiraSoapService

This will progress an issue through a workflow.

Specified by:

progressWorkflowAction in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

issueKey - the issue to update.

actionIdString - the workflow action to progress to

actionParams - the list of issue fields to change in this workflow step

Returns:

the updated RemoteIssue

Throws:

RemoteException - if the issue cannot be updated

getIssue

public RemoteIssue getIssue(java.lang.String token,
                            java.lang.String issueKey)
                     throws RemoteException

Description copied from interface: JiraSoapService

Returns information about the specific issue as identified by the issue key

Specified by:

getIssue in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

issueKey - the key of the issue to return

Returns:

a representation of the issue

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 - if the issue does not exist or your dont have permission to see it

getResolutionDateByKey

public java.util.Date getResolutionDateByKey(java.lang.String token,
                                             java.lang.String issueKey)
                                      throws RemotePermissionException,
                                             RemoteAuthenticationException,
                                             RemoteException

Description copied from interface: JiraSoapService

Given an issue key, this method returns the resolution date for this issue. If the issue hasn't been resolved yet, this method will return null.

If the no issue with the given key exists a RemoteException will be thrown.

Specified by:

getResolutionDateByKey in interface JiraSoapService

Parameters:

token - the SOAP authentication token

issueKey - the key of the issue

Returns:

The resolution date of the issue. May be null

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

getResolutionDateById

public java.util.Date getResolutionDateById(java.lang.String token,
                                            java.lang.Long issueId)
                                     throws RemotePermissionException,
                                            RemoteAuthenticationException,
                                            RemoteException

Description copied from interface: JiraSoapService

Given an issue id, this method returns the resolution date for this issue. If the issue hasn't been resolved yet, this method will return null.

If the no issue with the given id exists a RemoteException will be thrown.

Specified by:

getResolutionDateById in interface JiraSoapService

Parameters:

token - the SOAP authentication token

issueId - the id of the issue

Returns:

The resolution date of the issue. May be null

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

createIssue

public RemoteIssue createIssue(java.lang.String token,
                               RemoteIssue rIssue)
                        throws RemoteException

Description copied from interface: JiraSoapService

This will create an issue based on the passed in details. If you are updating Select or Multi-Select custom fields, note that you should be passing in the Option Ids, as opposed to the actual Option values. If you pass in the Option values, we will attempt to do an automatic conversion from Option value to an Option Id if we find that none of the values passed in can be parsed to an Option Id for the field. In the case where an Option has a value that is also a valid Option Id for the field, and the supplied value matches this Option value, we assume the supplied value is an OptionId. If any automatic conversion fails, the original values are passed through and cause an exception with the valid Option Ids for the field to be thrown.

Specified by:

createIssue in interface JiraSoapService

Parameters:

token - the SOAP authentication token

rIssue - the new issue details to create

Returns:

the newly created issue

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 data cannot be validated

RemoteException - If the issue does not exist or your dont have permission to see it

createIssueWithSecurityLevel

public RemoteIssue createIssueWithSecurityLevel(java.lang.String token,
                                                RemoteIssue rIssue,
                                                java.lang.Long securityLevelId)
                                         throws RemoteException

Description copied from interface: JiraSoapService

This will create an issue based on the passed in details and use the security level See also JiraSoapService.createIssue(String, com.atlassian.jira.rpc.soap.beans.RemoteIssue)

Specified by:

createIssueWithSecurityLevel in interface JiraSoapService

Parameters:

token - the SOAP authentication token

rIssue - the new issue details to create

securityLevelId - the id of the required security level

Returns:

the newly created issue

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 data cannot be validated

RemoteException - If the issue does not exist or your dont have permission to see it

createIssueWithParent

public RemoteIssue createIssueWithParent(java.lang.String token,
                                         RemoteIssue rIssue,
                                         java.lang.String parentIssueKey)
                                  throws RemoteException

Description copied from interface: JiraSoapService

This will create an issue based on the passed in details and make it a child (eg subtask) of the specified parent issue. See also JiraSoapService.createIssue(String, com.atlassian.jira.rpc.soap.beans.RemoteIssue)

Specified by:

createIssueWithParent in interface JiraSoapService

Parameters:

token - the SOAP authentication token

rIssue - the new issue details to create

parentIssueKey - the key of the parent issue

Returns:

the newly created issue

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 data cannot be validated

RemoteException - If the issue does not exist or your dont have permission to see it

createIssueWithParentWithSecurityLevel

public RemoteIssue createIssueWithParentWithSecurityLevel(java.lang.String token,
                                                          RemoteIssue rIssue,
                                                          java.lang.String parentIssueKey,
                                                          java.lang.Long securityLevelId)
                                                   throws RemoteException

Description copied from interface: JiraSoapService

This will create an issue based on the passed in details and use the security level and make it a child (eg subtask) of the specified parent issue. See also JiraSoapService.createIssue(String, com.atlassian.jira.rpc.soap.beans.RemoteIssue)

Specified by:

createIssueWithParentWithSecurityLevel in interface JiraSoapService

Parameters:

token - the SOAP authentication token

rIssue - the new issue details to create

parentIssueKey - the key of the parent issue

securityLevelId - the id of the required security level

Returns:

the newly created issue

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 data cannot be validated

RemoteException - If the issue does not exist or your dont have permission to see it

addAttachmentsToIssue

public boolean addAttachmentsToIssue(java.lang.String token,
                                     java.lang.String issueKey,
                                     java.lang.String[] fileNames,
                                     byte[][] attachments)
                              throws RemoteException

Description copied from interface: JiraSoapService

Add attachments to an issue.

This method accepts the data of the attachments as byte arrays. This is known to cause problems when the attachments are above a certain size. For more information, please see JRA-11693.

Specified by:

addAttachmentsToIssue in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

issueKey - the issue to attach to

fileNames - an array of filenames; each element names an attachment to be uploaded

attachments - an array of byte arrays; each element contains the data of the attachment to be uploaded

Returns:

true if attachments were successfully added; if the operation was not successful, an exception would be thrown

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 data cannot be validated

RemoteException

addBase64EncodedAttachmentsToIssue

public boolean addBase64EncodedAttachmentsToIssue(java.lang.String token,
                                                  java.lang.String issueKey,
                                                  java.lang.String[] fileNames,
                                                  java.lang.String[] base64EncodedAttachmentData)
                                           throws RemoteException

Description copied from interface: JiraSoapService

An alternative mechanism for adding attachments to an issue. This method accepts the data of the attachments as Base64 encoded strings instead of byte arrays. This is to combat the XML message bloat created by Axis when SOAP-ifying byte arrays.

For more information, please see JRA-11693.

Specified by:

addBase64EncodedAttachmentsToIssue in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

issueKey - the issue to attach to

fileNames - an array of filenames; each element names an attachment to be uploaded

base64EncodedAttachmentData - an array of Base 64 encoded Strings; each element contains the data of the attachment to be uploaded

Returns:

true if attachments were successfully added; if the operation was not successful, an exception would be thrown

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 data cannot be validated

RemoteException

See Also:

JiraSoapService.addAttachmentsToIssue(String, String, String[], byte[][])

getAttachmentsFromIssue

public RemoteAttachment[] getAttachmentsFromIssue(java.lang.String token,
                                                  java.lang.String issueKey)
                                           throws RemoteException

Description copied from interface: JiraSoapService

Returns the attachments that are associated with an issue

Specified by:

getAttachmentsFromIssue in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

issueKey - the issue to find attachments for

Returns:

the attachments of the issue

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 data cannot be validated

RemoteException - If the issue does not exist or your dont have permission to see it

updateIssue

public RemoteIssue updateIssue(java.lang.String token,
                               java.lang.String issueKey,
                               RemoteFieldValue[] actionParams)
                        throws RemoteException

Description copied from interface: JiraSoapService

This will update an issue with new values.

NOTE : You cannot update the 'status' field of the issue via this method. You must instead call :

JiraSoapService.progressWorkflowAction(String, String, String, com.atlassian.jira.rpc.soap.beans.RemoteFieldValue[])

to progress the issue status into a new workflow state. If you are updating Select or Multi-Select custom fields, note that you should be passing in the Option Ids, as opposed to the actual Option values. If you pass in the Option values, we will attempt to do an automatic conversion from Option value to an Option Id if we find that none of the values passed in can be parsed to an Option Id for the field. In the case where an Option has a value that is also a valid Option Id for the field, and the supplied value matches this Option value, we assume the supplied value is an OptionId. If any automatic conversion fails, the original values are passed through and cause an exception with the valid Option Ids for the field to be thrown.

Specified by:

updateIssue in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

issueKey - the issue to update.

actionParams - the list of issue fields to change

Returns:

the updated RemoteIssue

Throws:

RemoteException - if the issue cannot be updated

deleteIssue

public void deleteIssue(java.lang.String token,
                        java.lang.String issueKey)
                 throws RemoteException

Description copied from interface: JiraSoapService

This will delete an issue with the specified issue key

Specified by:

deleteIssue in interface JiraSoapService

Parameters:

token - the SOAP authentication token

issueKey - the issue 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 - If the issue does not exist or your dont have permission to see it

getFieldsForCreate

public RemoteField[] getFieldsForCreate(java.lang.String token,
                                        java.lang.String projectKey,
                                        java.lang.Long issueTypeId)
                                 throws RemoteException

Description copied from interface: JiraSoapService

Returns the fields that are shown during an issue creation.

Specified by:

getFieldsForCreate in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

projectKey - the project to create the issue in.

issueTypeId - the type of issue to create

Returns:

the fields that would be shown during the create operation

Throws:

RemoteException - if something dramatic happens during this operation

getFieldsForEdit

public RemoteField[] getFieldsForEdit(java.lang.String token,
                                      java.lang.String issueKey)
                               throws RemoteException

Description copied from interface: JiraSoapService

Returns the fields that are shown during an issue edit.

Specified by:

getFieldsForEdit in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

issueKey - the issue to update.

Returns:

the fields that would be shown during the edit operation

Throws:

RemoteException - if something dramatic happens during this operation

createProject

public RemoteProject createProject(java.lang.String token,
                                   java.lang.String key,
                                   java.lang.String name,
                                   java.lang.String description,
                                   java.lang.String url,
                                   java.lang.String lead,
                                   RemotePermissionScheme permissionScheme,
                                   RemoteScheme notificationScheme,
                                   RemoteScheme issueSecurityScheme)
                            throws RemoteException

Description copied from interface: JiraSoapService

Creates a project based on the passed in details.

Specified by:

createProject in interface JiraSoapService

Parameters:

token - the SOAP authentication token

key - the new project key

name - the new project name

description - the description of the new project

url - the new project URL

lead - the user who is trhe project lead

permissionScheme - the permission to use for the new project

notificationScheme - the notification scheme to use on the new project

issueSecurityScheme - the issue security scheme to use on the new project

Returns:

the newly created project

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 data cannot be validated

RemoteException - If something dramatic happened during the execution of the operation

createProjectFromObject

public RemoteProject createProjectFromObject(java.lang.String token,
                                             RemoteProject rproject)
                                      throws RemoteException

Description copied from interface: JiraSoapService

Creates a project based on the passed in details.

Specified by:

createProjectFromObject in interface JiraSoapService

Parameters:

token - the SOAP authentication token

rproject - the object representation of the new project

Returns:

the newly created project

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 data cannot be validated

RemoteException - If something dramatic happened during the execution of the operation

updateProject

public RemoteProject updateProject(java.lang.String token,
                                   RemoteProject rProject)
                            throws RemoteException

Description copied from interface: JiraSoapService

Updates a project based on the passed in details.

Specified by:

updateProject in interface JiraSoapService

Parameters:

token - the SOAP authentication token

rProject - the object representation of the updated project

Returns:

the updated project

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 data cannot be validated

RemoteException - If something dramatic happened during the execution of the operation

deleteProject

public void deleteProject(java.lang.String token,
                          java.lang.String projectKey)
                   throws RemoteException

Description copied from interface: JiraSoapService

This will delete a project with the specified project key

Specified by:

deleteProject in interface JiraSoapService

Parameters:

token - the SOAP authentication token

projectKey - the project 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 - If something dramatic happened during the execution of the operation

getComment

public RemoteComment getComment(java.lang.String token,
                                java.lang.Long id)
                         throws RemoteException

Description copied from interface: JiraSoapService

Gets a specific comment by comment id

Specified by:

getComment in interface JiraSoapService

Parameters:

token - the SOAP authentication token

id - the id of the comment to retrieve

Returns:

the comment with the specified id

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 - if the comment does not exist or your dont have permission to see it

getComments

public RemoteComment[] getComments(java.lang.String token,
                                   java.lang.String issueKey)
                            throws RemoteException

Description copied from interface: JiraSoapService

Gets the comments for an issue

Specified by:

getComments in interface JiraSoapService

Parameters:

token - the SOAP authentication token

issueKey - the key of the issue to get comments for

Returns:

the comment with the specified id

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 - if the issue does not exist or your dont have permission to see it

addComment

public void addComment(java.lang.String token,
                       java.lang.String issueKey,
                       RemoteComment remoteComment)
                throws RemoteException

Description copied from interface: JiraSoapService

Adds a comment to the specified issue

Specified by:

addComment in interface JiraSoapService

Parameters:

token - the SOAP authentication token

issueKey - the key of the issue to add a comment to

remoteComment - the new comment to add

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 - If the issue does not exist or your dont have permission to see it

hasPermissionToEditComment

public boolean hasPermissionToEditComment(java.lang.String token,
                                          RemoteComment remoteComment)
                                   throws RemoteException

Description copied from interface: JiraSoapService

Returns true if the user has permission to edit a comment

Specified by:

hasPermissionToEditComment in interface JiraSoapService

Parameters:

token - the SOAP authentication token

remoteComment - the comment to edit

Returns:

true if the user has permission to make this edit

Throws:

RemoteException - if something dramatic happens during this operation

editComment

public RemoteComment editComment(java.lang.String token,
                                 RemoteComment remoteComment)
                          throws RemoteException

Description copied from interface: JiraSoapService

Allows a comment to be edited

Specified by:

editComment in interface JiraSoapService

Parameters:

token - the SOAP authentication token

remoteComment - the new comment details

Returns:

the updated comment details

Throws:

RemoteException - if something dramatic happens during this operation

getNotificationSchemes

public RemoteScheme[] getNotificationSchemes(java.lang.String token)
                                      throws RemoteException

Specified by:

getNotificationSchemes in interface JiraSoapService

Throws:

RemoteException

getPermissionSchemes

public RemotePermissionScheme[] getPermissionSchemes(java.lang.String token)
                                              throws RemoteException

Specified by:

getPermissionSchemes in interface JiraSoapService

Throws:

RemoteException

getSecuritySchemes

public RemoteScheme[] getSecuritySchemes(java.lang.String token)
                                  throws RemoteException

Specified by:

getSecuritySchemes in interface JiraSoapService

Throws:

RemoteException

getAllPermissions

public RemotePermission[] getAllPermissions(java.lang.String token)
                                     throws RemoteException

Specified by:

getAllPermissions in interface JiraSoapService

Throws:

RemoteException

createPermissionScheme

public RemotePermissionScheme createPermissionScheme(java.lang.String token,
                                                     java.lang.String name,
                                                     java.lang.String description)
                                              throws RemoteException

Specified by:

createPermissionScheme in interface JiraSoapService

Throws:

RemoteException

addPermissionTo

public RemotePermissionScheme addPermissionTo(java.lang.String token,
                                              RemotePermissionScheme permissionScheme,
                                              RemotePermission permission,
                                              RemoteEntity remoteEntity)
                                       throws RemoteException

Specified by:

addPermissionTo in interface JiraSoapService

Throws:

RemoteException

deletePermissionFrom

public RemotePermissionScheme deletePermissionFrom(java.lang.String token,
                                                   RemotePermissionScheme permissionSchemeName,
                                                   RemotePermission permission,
                                                   RemoteEntity remoteEntity)
                                            throws RemoteException

Specified by:

deletePermissionFrom in interface JiraSoapService

Throws:

RemoteException

deletePermissionScheme

public void deletePermissionScheme(java.lang.String token,
                                   java.lang.String permissionSchemeName)
                            throws RemoteException

Specified by:

deletePermissionScheme in interface JiraSoapService

Throws:

RemoteException

getCustomFields

public RemoteField[] getCustomFields(java.lang.String token)
                              throws RemoteException

Description copied from interface: JiraSoapService

Returns all the custom fields available

Specified by:

getCustomFields in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

Returns:

all the custom fields available

Throws:

RemoteException - If something dramatic happened during the execution of the operation

refreshCustomFields

public void refreshCustomFields(java.lang.String token)
                         throws RemoteException

Description copied from interface: JiraSoapService

Refreshes the internal representation of all the custom fields available

Specified by:

refreshCustomFields in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

Throws:

RemoteException - If something dramatic happened during the execution of the operation

getIssuesFromFilter

public RemoteIssue[] getIssuesFromFilter(java.lang.String token,
                                         java.lang.String filterId)
                                  throws RemoteException

Description copied from interface: JiraSoapService

Returns issues that match the saved filter specified by the filterId.

This method will return no more than the maxNumResults.

It will start the result set at the provided off set.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

If the jira.search.views.max.limit property is set and you are not in a group specified by jira.search.views.max.unlimited.group then the number of results returned will be constrained by the value of jira.search.views.max.limit if it is less than the specified maxNumResults.

Specified by:

getIssuesFromFilter in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

filterId - identifies the saved filter to use for the search.

Returns:

issues matching the saved filter

Throws:

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

getIssuesFromFilterWithLimit

public RemoteIssue[] getIssuesFromFilterWithLimit(java.lang.String token,
                                                  java.lang.String filterId,
                                                  int offSet,
                                                  int maxNumResults)
                                           throws RemoteException

Description copied from interface: JiraSoapService

Returns issues that match the saved filter specified by the filterId.

This method will return no more than the maxNumResults.

It will start the result set at the provided off set.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

If the jira.search.views.max.limit property is set and you are not in a group specified by jira.search.views.max.unlimited.group then the number of results returned will be constrained by the value of jira.search.views.max.limit if it is less than the specified maxNumResults.

Specified by:

getIssuesFromFilterWithLimit in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

filterId - identifies the saved filter to use for the search.

offSet - the place in the result set to use as the first result returned

maxNumResults - the maximum number of results that this method will return.

Returns:

issues matching the saved filter

Throws:

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

getIssuesFromTextSearch

public RemoteIssue[] getIssuesFromTextSearch(java.lang.String token,
                                             java.lang.String searchTerms)
                                      throws RemoteException

Description copied from interface: JiraSoapService

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.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

If the jira.search.views.max.limit property is set and you are not in a group specified by jira.search.views.max.unlimited.group then the number of results returned will be constrained by the value of jira.search.views.max.limit if it is less than the specified maxNumResults.

Specified by:

getIssuesFromTextSearch in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

searchTerms - search terms

Returns:

issues matching the search terms

Throws:

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

See Also:

JiraSoapService.getIssuesFromJqlSearch(String, String, int)

getIssuesFromTextSearchWithLimit

public RemoteIssue[] getIssuesFromTextSearchWithLimit(java.lang.String token,
                                                      java.lang.String searchTerms,
                                                      int offSet,
                                                      int maxNumResults)
                                               throws RemoteException

Description copied from interface: JiraSoapService

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.

This method will return no more than the maxNumResults.

It will start the result set at the provided off set.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

If the jira.search.views.max.limit property is set and you are not in a group specified by jira.search.views.max.unlimited.group then the number of results returned will be constrained by the value of jira.search.views.max.limit if it is less than the specified maxNumResults.

Specified by:

getIssuesFromTextSearchWithLimit in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

searchTerms - search terms

offSet - the place in the result set to use as the first result returned

maxNumResults - the maximum number of results that this method will return.

Returns:

issues matching the search terms

Throws:

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

See Also:

JiraSoapService.getIssuesFromJqlSearch(String, String, int)

getIssuesFromTextSearchWithProject

public RemoteIssue[] getIssuesFromTextSearchWithProject(java.lang.String token,
                                                        java.lang.String[] projectKeys,
                                                        java.lang.String searchTerms,
                                                        int maxNumResults)
                                                 throws RemoteException

Description copied from interface: JiraSoapService

Returns issues containing searchTerms that are within the specified projects.

Note: this is a fuzzy search, returned in order of 'relevance', so the results are only generally useful for human consumption.

This method will return no more than the maxNumResults.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

If the jira.search.views.max.limit property is set and you are not in a group specified by jira.search.views.max.unlimited.group then the number of results returned will be constrained by the value of jira.search.views.max.limit if it is less than the specified maxNumResults.

Specified by:

getIssuesFromTextSearchWithProject in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

projectKeys - an array of project keys to search within

searchTerms - search terms

maxNumResults - the maximum number of results that this method will return.

Returns:

issues matching the search terms

Throws:

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

See Also:

JiraSoapService.getIssuesFromJqlSearch(String, String, int)

getIssuesFromJqlSearch

public RemoteIssue[] getIssuesFromJqlSearch(java.lang.String token,
                                            java.lang.String jqlSearch,
                                            int maxNumResults)
                                     throws RemoteException

Description copied from interface: JiraSoapService

Execute a specified JQL query and return the resulting issues.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

If the jira.search.views.max.limit property is set and you are not in a group specified by jira.search.views.max.unlimited.group then the number of results returned will be constrained by the value of jira.search.views.max.limit if it is less than the specified maxNumResults.

Specified by:

getIssuesFromJqlSearch in interface JiraSoapService

Parameters:

token - the SOAP authentication token

jqlSearch - JQL query string to execute

maxNumResults - the maximum number of results that this method will return

Returns:

issues matching the JQL query

Throws:

RemoteException - If there was a JQL parse error or an error occurs during the search

getIssueCountForFilter

public long getIssueCountForFilter(java.lang.String token,
                                   java.lang.String filterId)
                            throws RemoteException

Description copied from interface: JiraSoapService

Returns the count of issues that would be returned for a given filter

Specified by:

getIssueCountForFilter in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

filterId - the id of the search filter

Returns:

the count of matching issues

Throws:

RemoteException - if something dramatic happens during this operation

getIssueById

public RemoteIssue getIssueById(java.lang.String token,
                                java.lang.String issueId)
                         throws RemoteException

Description copied from interface: JiraSoapService

Returns information about the specific issue as identified by the issue id

Specified by:

getIssueById in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

issueId - the id of the issue to return

Returns:

a representation of the issue

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 - if the issue does not exist or your dont have permission to see it

getConfiguration

public RemoteConfiguration getConfiguration(java.lang.String token)
                                     throws RemoteException

Description copied from interface: JiraSoapService

Returns information about the current configuration of JIRA.

Specified by:

getConfiguration in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

Returns:

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

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

getProjectRoles

public RemoteProjectRole[] getProjectRoles(java.lang.String token)
                                    throws RemoteException

Specified by:

getProjectRoles in interface JiraSoapService

Throws:

RemoteException

getProjectRole

public RemoteProjectRole getProjectRole(java.lang.String token,
                                        java.lang.Long id)
                                 throws RemoteException

Specified by:

getProjectRole in interface JiraSoapService

Throws:

RemoteException

createProjectRole

public RemoteProjectRole createProjectRole(java.lang.String token,
                                           RemoteProjectRole projectRole)
                                    throws RemoteException

Specified by:

createProjectRole in interface JiraSoapService

Throws:

RemoteException

isProjectRoleNameUnique

public boolean isProjectRoleNameUnique(java.lang.String token,
                                       java.lang.String name)
                                throws RemoteException

Specified by:

isProjectRoleNameUnique in interface JiraSoapService

Throws:

RemoteException

deleteProjectRole

public void deleteProjectRole(java.lang.String token,
                              RemoteProjectRole projectRole,
                              boolean confirm)
                       throws RemoteException

Specified by:

deleteProjectRole in interface JiraSoapService

Throws:

RemoteException

addActorsToProjectRole

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

Specified by:

addActorsToProjectRole in interface JiraSoapService

Throws:

RemoteException

removeActorsFromProjectRole

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

Specified by:

removeActorsFromProjectRole in interface JiraSoapService

Throws:

RemoteException

updateProjectRole

public void updateProjectRole(java.lang.String token,
                              RemoteProjectRole projectRole)
                       throws RemoteException

Specified by:

updateProjectRole in interface JiraSoapService

Throws:

RemoteException

getProjectRoleActors

public RemoteProjectRoleActors getProjectRoleActors(java.lang.String token,
                                                    RemoteProjectRole projectRole,
                                                    RemoteProject project)
                                             throws RemoteException

Specified by:

getProjectRoleActors in interface JiraSoapService

Throws:

RemoteException

getDefaultRoleActors

public RemoteRoleActors getDefaultRoleActors(java.lang.String token,
                                             RemoteProjectRole projectRole)
                                      throws RemoteException

Specified by:

getDefaultRoleActors in interface JiraSoapService

Throws:

RemoteException

addDefaultActorsToProjectRole

public void addDefaultActorsToProjectRole(java.lang.String token,
                                          java.lang.String[] actorNames,
                                          RemoteProjectRole projectRole,
                                          java.lang.String type)
                                   throws RemoteException

Specified by:

addDefaultActorsToProjectRole in interface JiraSoapService

Throws:

RemoteException

removeDefaultActorsFromProjectRole

public void removeDefaultActorsFromProjectRole(java.lang.String token,
                                               java.lang.String[] actors,
                                               RemoteProjectRole projectRole,
                                               java.lang.String actorType)
                                        throws RemoteException

Specified by:

removeDefaultActorsFromProjectRole in interface JiraSoapService

Throws:

RemoteException

removeAllRoleActorsByNameAndType

public void removeAllRoleActorsByNameAndType(java.lang.String token,
                                             java.lang.String name,
                                             java.lang.String type)
                                      throws RemoteException

Specified by:

removeAllRoleActorsByNameAndType in interface JiraSoapService

Throws:

RemoteException

removeAllRoleActorsByProject

public void removeAllRoleActorsByProject(java.lang.String token,
                                         RemoteProject project)
                                  throws RemoteException

Specified by:

removeAllRoleActorsByProject in interface JiraSoapService

Throws:

RemoteException

getAssociatedNotificationSchemes

public RemoteScheme[] getAssociatedNotificationSchemes(java.lang.String token,
                                                       RemoteProjectRole projectRole)
                                                throws RemoteException

Specified by:

getAssociatedNotificationSchemes in interface JiraSoapService

Throws:

RemoteException

getAssociatedPermissionSchemes

public RemoteScheme[] getAssociatedPermissionSchemes(java.lang.String token,
                                                     RemoteProjectRole projectRole)
                                              throws RemoteException

Specified by:

getAssociatedPermissionSchemes in interface JiraSoapService

Throws:

RemoteException

releaseVersion

public void releaseVersion(java.lang.String token,
                           java.lang.String projectKey,
                           RemoteVersion remoteVersion)
                    throws RemoteException

Specified by:

releaseVersion in interface JiraSoapService

Throws:

RemoteException

archiveVersion

public void archiveVersion(java.lang.String token,
                           java.lang.String projectKey,
                           java.lang.String versionName,
                           boolean archive)
                    throws RemoteException

Specified by:

archiveVersion in interface JiraSoapService

Throws:

RemoteException

addWorklogAndAutoAdjustRemainingEstimate

public RemoteWorklog addWorklogAndAutoAdjustRemainingEstimate(java.lang.String token,
                                                              java.lang.String issueKey,
                                                              RemoteWorklog remoteWorklog)
                                                       throws RemoteException

Description copied from interface: JiraSoapService

Adds a worklog to the given issue. 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.

Specified by:

addWorklogAndAutoAdjustRemainingEstimate in interface JiraSoapService

Parameters:

token - the SOAP authentication 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

public RemoteWorklog addWorklogAndRetainRemainingEstimate(java.lang.String token,
                                                          java.lang.String issueKey,
                                                          RemoteWorklog remoteWorklog)
                                                   throws RemoteException

Description copied from interface: JiraSoapService

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.

Specified by:

addWorklogAndRetainRemainingEstimate in interface JiraSoapService

Parameters:

token - the SOAP authentication 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.

addWorklogWithNewRemainingEstimate

public RemoteWorklog addWorklogWithNewRemainingEstimate(java.lang.String token,
                                                        java.lang.String issueKey,
                                                        RemoteWorklog remoteWorklog,
                                                        java.lang.String newRemainingEstimate)
                                                 throws RemoteException

Description copied from interface: JiraSoapService

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.

Specified by:

addWorklogWithNewRemainingEstimate in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

issueKey - the key of the issue.

remoteWorklog - the worklog to add.

newRemainingEstimate - the new value for the issue's remaining estimate as a duration string, eg 1d 2h.

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

public RemoteWorklog[] getWorklogs(java.lang.String token,
                                   java.lang.String issueKey)
                            throws RemoteException

Description copied from interface: JiraSoapService

Returns all worklogs for the given issue.

Specified by:

getWorklogs in interface JiraSoapService

Parameters:

token - the SOAP authentication 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.

deleteWorklogAndAutoAdjustRemainingEstimate

public void deleteWorklogAndAutoAdjustRemainingEstimate(java.lang.String token,
                                                        java.lang.String worklogId)
                                                 throws RemoteException

Description copied from interface: JiraSoapService

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.

Specified by:

deleteWorklogAndAutoAdjustRemainingEstimate in interface JiraSoapService

Parameters:

token - the SOAP authentication 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

public void deleteWorklogAndRetainRemainingEstimate(java.lang.String token,
                                                    java.lang.String worklogId)
                                             throws RemoteException

Description copied from interface: JiraSoapService

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.

Specified by:

deleteWorklogAndRetainRemainingEstimate in interface JiraSoapService

Parameters:

token - the SOAP authentication 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.

deleteWorklogWithNewRemainingEstimate

public void deleteWorklogWithNewRemainingEstimate(java.lang.String token,
                                                  java.lang.String worklogId,
                                                  java.lang.String newRemainingEstimate)
                                           throws RemoteException

Description copied from interface: JiraSoapService

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.

Specified by:

deleteWorklogWithNewRemainingEstimate in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

worklogId - the id of the worklog to delete.

newRemainingEstimate - the new value for the issue's remaining estimate as a duration string, eg 1d 2h.

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

public void updateWorklogAndAutoAdjustRemainingEstimate(java.lang.String token,
                                                        RemoteWorklog remoteWorklog)
                                                 throws RemoteException

Description copied from interface: JiraSoapService

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.

Specified by:

updateWorklogAndAutoAdjustRemainingEstimate in interface JiraSoapService

Parameters:

token - the SOAP authentication 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

public void updateWorklogAndRetainRemainingEstimate(java.lang.String token,
                                                    RemoteWorklog remoteWorklog)
                                             throws RemoteException

Description copied from interface: JiraSoapService

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.

Specified by:

updateWorklogAndRetainRemainingEstimate in interface JiraSoapService

Parameters:

token - the SOAP authentication 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.

updateWorklogWithNewRemainingEstimate

public void updateWorklogWithNewRemainingEstimate(java.lang.String token,
                                                  RemoteWorklog remoteWorklog,
                                                  java.lang.String newRemainingEstimate)
                                           throws RemoteException

Description copied from interface: JiraSoapService

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.

Specified by:

updateWorklogWithNewRemainingEstimate in interface JiraSoapService

Parameters:

token - the SOAP authentication token.

remoteWorklog - the worklog to update.

newRemainingEstimate - the new value for the issue's remaining estimate as a duration string, eg 1d 2h.

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

public boolean hasPermissionToCreateWorklog(java.lang.String token,
                                            java.lang.String issueKey)
                                     throws RemoteException

Description copied from interface: JiraSoapService

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.

Specified by:

hasPermissionToCreateWorklog in interface JiraSoapService

Parameters:

token - the SOAP authentication 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:

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

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

hasPermissionToDeleteWorklog

public boolean hasPermissionToDeleteWorklog(java.lang.String token,
                                            java.lang.String worklogId)
                                     throws RemoteException

Description copied from interface: JiraSoapService

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.

Specified by:

hasPermissionToDeleteWorklog in interface JiraSoapService

Parameters:

token - the SOAP authentication 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:

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

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

hasPermissionToUpdateWorklog

public boolean hasPermissionToUpdateWorklog(java.lang.String token,
                                            java.lang.String worklogId)
                                     throws RemoteException

Description copied from interface: JiraSoapService

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.

Specified by:

hasPermissionToUpdateWorklog in interface JiraSoapService

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:

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

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

getSecurityLevel

public RemoteSecurityLevel getSecurityLevel(java.lang.String token,
                                            java.lang.String issueKey)
                                     throws RemoteException,
                                            RemotePermissionException

Description copied from interface: JiraSoapService

Returns the current security level for given issue

Specified by:

getSecurityLevel in interface JiraSoapService

Parameters:

token - the SOAP authentication token

issueKey - the issue key

Returns:

issue security level

Throws:

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

RemotePermissionException - If the issue key is invalid or the user is not permitted to see this issue.

getSecurityLevels

public RemoteSecurityLevel[] getSecurityLevels(java.lang.String token,
                                               java.lang.String projectKey)
                                        throws RemoteException,
                                               RemotePermissionException

Description copied from interface: JiraSoapService

Returns an array of all security levels for a given project.

Specified by:

getSecurityLevels in interface JiraSoapService

Parameters:

token - the SOAP authentication token

projectKey - the key for the project

Returns:

array of RemoteSecurityLevels for the project

Throws:

RemoteException - If the project key is invalid

RemotePermissionException - If you do not have Browse permission for the project

getProjectAvatars

public RemoteAvatar[] getProjectAvatars(java.lang.String token,
                                        java.lang.String projectKey,
                                        boolean includeSystemAvatars)
                                 throws RemoteException,
                                        RemotePermissionException

Description copied from interface: JiraSoapService

Retrieves avatars for the given project. If the includeSystemAvatars parameter is true, this will include both system (built-in) avatars as well as custom (user-supplied) avatars for that project, otherwise it will include only the custom avatars. Project browse permission is required.

Specified by:

getProjectAvatars in interface JiraSoapService

Parameters:

token - the SOAP authentication token

projectKey - the key for the project.

includeSystemAvatars - if false, only custom avatars will be included in the returned array.

Returns:

the avatars for the project, possibly empty.

Throws:

RemoteException - If the project key is invalid.

RemotePermissionException - If you do not have Browse permission for the project.

setNewProjectAvatar

public void setNewProjectAvatar(java.lang.String token,
                                java.lang.String projectKey,
                                java.lang.String contentType,
                                java.lang.String base64ImageData)
                         throws RemoteException,
                                RemotePermissionException

Description copied from interface: JiraSoapService

Creates a new custom avatar for the given project and sets it to be current for the project. The image data must be provided as base64 encoded data and should be 48 pixels square. If the image is larger, the top left 48 pixels are taken, if it is smaller it is upscaled to 48 pixels. The small version of the avatar image (16 pixels) is generated automatically. Project administration permission is required.

Specified by:

setNewProjectAvatar in interface JiraSoapService

Parameters:

token - the SOAP authentication token

projectKey - the key for the project.

contentType - the MIME type of the image provided, e.g. image/gif, image/jpeg, image/png.

base64ImageData - a base 64 encoded image, 48 pixels square.

Throws:

RemoteException - If the project key is invalid.

RemotePermissionException - If you do not have project admin permission for the project.

setProjectAvatar

public void setProjectAvatar(java.lang.String token,
                             java.lang.String projectKey,
                             java.lang.Long avatarId)
                      throws RemoteException,
                             RemotePermissionException

Description copied from interface: JiraSoapService

Sets the current avatar for the given project to that with the given id. Project administration permission is required.

Specified by:

setProjectAvatar in interface JiraSoapService

Parameters:

token - the SOAP authentication token

projectKey - the key for the project.

avatarId - the id of an existing avatar to use for the project or null for the default avatar.

Throws:

RemoteException - If the project key is invalid.

RemotePermissionException - If you do not have project admin permission for the project.

getProjectAvatar

public RemoteAvatar getProjectAvatar(java.lang.String token,
                                     java.lang.String projectKey)
                              throws RemoteException,
                                     RemotePermissionException

Description copied from interface: JiraSoapService

Retrieves the current avatar for the given project. Project browse permission is required.

Specified by:

getProjectAvatar in interface JiraSoapService

Parameters:

token - the SOAP authentication token

projectKey - the key for the project.

Returns:

the current avatar for the project.

Throws:

RemoteException - If the project key is invalid.

RemotePermissionException - If you do not have Browse permission for the project.

deleteProjectAvatar

public void deleteProjectAvatar(java.lang.String token,
                                long avatarId)
                         throws RemoteException

Description copied from interface: JiraSoapService

Deletes the given custom Avatar from the system. System avatars cannot be deleted. Project administration permission is required.

Specified by:

deleteProjectAvatar in interface JiraSoapService

Parameters:

token - the SOAP authentication token

avatarId - id of the custom avatar to delete.

Throws:

RemoteException - if there is no avatar with the given id, or if it is a system avatar.

RemotePermissionException - If you do not have administer permission for the project.