|
void
|
addActorsToProjectRole(List<String> actors, Long projectRoleId, String projectKey, String actorType)
Adds the given actors to the project role.
|
|
boolean
|
addBase64EncodedAttachmentsToIssue(String issueKey, List<String> fileNames, List<String> base64EncodedAttachmentData)
An alternative mechanism for adding attachments to an issue.
|
|
RemoteComment
|
addComment(String issueKey, String commentAuthor, String commentBody, String commentGroupLevel, String commentRoleLevel)
Adds a new comment to the issue.
|
|
void
|
addDefaultActorsToProjectRole(List<String> actors, Long projectRoleId, String type)
Adds the default actors to the project role denoted by this id.
|
|
Void
|
addEffort(Issue issue, String authorUri, DateTime date, int minutes, String comment)
Add an effort to an issue's worklog
|
|
RemotePermissionScheme
|
addPermissionTo(String permissionSchemeName, Long permissionCode, String entityName)
Adds the permission to the given entity name (username or group name)
|
|
void
|
addUserToGroup(String groupName, String userName)
Adds a user to the given group name.
|
|
RemoteVersion
|
addVersion(String projectKey, String versionName, Boolean archived, Boolean released, String releaseDate)
|
|
RemoteWorklog
|
addWorklogAndAutoAdjustRemainingEstimate(String issueKey, String timeSpent, String startDate, String comment, String groupLevel, String roleLevelId)
Adds a worklog to the given issue.
|
|
RemoteWorklog
|
addWorklogAndRetainRemainingEstimate(String issueKey, String timeSpent, String startDate, String comment, String groupLevel, String roleLevelId)
Adds a worklog to the given issue but leaves the issue's remaining estimate field unchanged.
|
|
RemoteWorklog
|
addWorklogWithNewRemainingEstimate(String issueKey, String timeSpent, String startDate, String newRemainingEstimate, String comment, String groupLevel, String roleLevelId)
Adds a worklog to the given issue and sets the issue's remaining estimate field to the given value.
|
|
void
|
archiveVersion(String projectKey, String versionName, Boolean archive)
Archieves the given version/
|
|
void
|
connect(String connectionUser, String connectionPassword, String connectionAddress, String restJiraUrl)
Creates a connection to Jira by making a login call with the given credentials to the specified address.
|
|
Component
|
createComponent(String projectKey, ComponentInput component)
Create a component
|
|
RemoteGroup
|
createGroup(String groupName, String userName)
Creates a group with the given name optionally adding the given user to it.
|
|
RemoteIssue
|
createIssue(String assignee, String summary, String description, String dueDate, String environment, String priority, String project, String reporter, String type, Long votes, Map<String, String> customFields, String componentName, String componentId)
Creates an issue.
|
|
RemoteIssue
|
createIssueUsingObject(RemoteIssue issue)
Creates an issue.
|
|
RemoteIssue
|
createIssueWithParent(RemoteIssue issue, String parentIssueKey)
Creates a sub-task.
|
|
RemoteIssue
|
createIssueWithSecurityLevel(String assignee, String summary, String description, String dueDate, String environment, String priority, String project, String reporter, String type, Long votes, Map<String, String> customFields, Long securityLevelId, String componentName, String componentId)
Creates an issue using the the security level denoted by the given id.
|
|
RemotePermissionScheme
|
createPermissionScheme(String permissionName, String description)
Creates a new permission schema using the given name and description.
|
|
RemoteProject
|
createProject(String key, String projectName, String description, String url, String lead, String permissionSchemeName, String notificationSchemeName, String securityShemeName)
|
|
RemoteProjectRole
|
createProjectRole(String projectRoleName, String projectRoleDescription)
Creates a new project role.
|
|
RemoteProject
|
createProjectUsingObject(RemoteProject project)
Creates a new project.
|
|
RemoteUser
|
createUser(String username, String password, String fullName, String email)
Creates a user in JIRA with the specified user details
|
|
Version
|
createVersion(VersionInput version)
Create a version
|
|
void
|
deleteGroup(String groupName, String swapGroupName)
Deletes the group denoted by the given group name.
|
|
void
|
deleteIssue(String issueKey)
Deletes the issue with the given key
|
|
RemotePermissionScheme
|
deletePermissionFrom(String permissionSchemeName, Long permissionCode, String entityName)
Removes the permission to the given entity name (username or group name)
|
|
void
|
deletePermissionScheme(String permissionSchemeName)
Deletes the permission scheme denoted by the given name
|
|
void
|
deleteProject(String projectKey)
Deletes the project represented by the given project key.
|
|
void
|
deleteProjectAvatar(Long avatarId)
Deletes the given custom Avatar from the system.
|
|
void
|
deleteProjectRole(Long projectRoleId, Boolean confirm)
Deletes the project role denoted by the given project role id.
|
|
void
|
deleteUser(String username)
Deletes a user in JIRA with the specified username.
|
|
void
|
deleteWorklogAndAutoAdjustRemainingEstimate(String worklogId)
Deletes the worklog with the given id and updates the remaining estimate field on the isssue by increasing it
by the time spent amount on the worklog being deleted.
|
|
void
|
deleteWorklogAndRetainRemainingEstimate(String worklogId)
Deletes the worklog with the given id but leaves the remaining estimate field on the isssue unchanged.
|
|
void
|
deleteWorklogWithNewRemainingEstimate(String workLogId, String newRemainingEstimate)
Deletes the worklog with the given id and sets the remaining estimate field on the isssue to the given value.
|
|
void
|
disconnect()
Performs a logout call to Jira.
|
|
RemoteComment
|
editComment(Long commentId, String body, String updateAuthor)
Edits the comment denoted by the given id
|
|
List<Object>
|
getAllPermissions()
Returns all the permissions.
|
|
List<Object>
|
getAssociatedNotificationSchemes(Long projectRoleId)
Returns the associated notification schemes for the given project role.
|
|
List<Object>
|
getAssociatedPermissionSchemes(Long projectRoleId)
Returns the associated permission schemas for the given project role.
|
|
List<Object>
|
getAttachmentsFromIssue(String issueKey)
Returns the attachments for the issue denoted by the given key.
|
|
List<Object>
|
getAvailableActions(String issueKey)
Finds the available actions for the given issue key
|
|
RemoteComment
|
getComment(Long commentId)
Finds a comment.
|
|
List<Object>
|
getComments(String issueKey)
Returns the comments for the issue denoted by the given key.
|
|
List<Object>
|
getComponents(String projectKey)
Returns an array of all the components for the specified project key.
|
|
RemoteConfiguration
|
getConfiguration()
Returns information about the current configuration of JIRA.
|
|
String
|
getConnectionAddress()
|
|
String
|
getConnectionUser()
|
|
List<Object>
|
getCustomFields()
Returns the custom fields for the current user
|
|
RemoteRoleActors
|
getDefaultRoleActors(Long projectRoleId)
Returns the default role actors for the given project role id.
|
|
List<Object>
|
getFavouriteFilters()
This retreives a list of the currently logged in user's favourite fitlers.
|
|
List<Object>
|
getFieldsForAction(String issueKey, String actionIdString)
Returns the fields for the given action.
|
|
List<Object>
|
getFieldsForEdit(String issueKey)
Returns the fields for edit for the given issue key
|
|
RemoteGroup
|
getGroup(String groupName)
Find the group with the specified name in JIRA.
|
|
Issue
|
getIssue(String issueKey)
Get an issue given its key
|
|
RemoteIssue
|
getIssueById(String issueId)
Returns the issue for the given issue id.
|
|
long
|
getIssueCountForFilter(String filterId)
Returns the issue count for the filter denoted by this id.
|
|
List<Object>
|
getIssueTypes()
Returns an array of all the issue types for all projects in JIRA.
|
|
List<Object>
|
getIssueTypesForProject(String projectId)
Returns an array of all the (non-sub task) issue types for the specified project id.
|
|
List<Object>
|
getIssuesFromFilterWithLimit(String filterId, Integer offset, Integer maxNumResults)
Returns issues that match the saved filter specified by the filterId.
|
|
List<Object>
|
getIssuesFromJqlSearch(String jqlSearch, Integer maxNumResults)
Execute a specified JQL query and return the resulting issues.
|
|
List<Object>
|
getIssuesFromTextSearchWithLimit(String searchTerms, Integer offset, Integer maxNumResults)
Returns issues containing searchTerms.
|
|
List<Object>
|
getIssuesFromTextSearchWithProject(List<String> projectKeys, String searchTerms, Integer maxNumResults)
Returns issues containing searchTerms that are within the specified projects.
|
|
String
|
getJiraRestUrl()
|
|
List<Object>
|
getNotificationSchemes()
Returns notification schemes.
|
|
List<Object>
|
getPermissionSchemes()
Returns the permission schemes.
|
|
List<Object>
|
getPriorities()
Returns an array of all the issue statuses in JIRA.
|
|
Project
|
getProject(String projectKey)
Get a project given its key
|
|
RemoteAvatar
|
getProjectAvatar(String projectKey)
Retrieves the current avatar for the given project.
|
|
List<Object>
|
getProjectAvatars(String projectKey, Boolean includeSystemAvatars)
Retrieves avatars for the given project.
|
|
RemoteProject
|
getProjectById(Long projectId)
Returns the Project with the matching id (if the user has permission to browse it).
|
|
RemoteProject
|
getProjectByKey(String projectKey)
Returns the Project with the matching key (if the user has permission to browse it).
|
|
RemoteProjectRole
|
getProjectRole(Long projectRoleId)
Returns the project role by projectRoleId.
|
|
RemoteProjectRoleActors
|
getProjectRoleActors(Long projectRoleId, String projectKey)
Returns the project role actors for the given project
|
|
List<Object>
|
getProjectRoles()
Returns the project roles.
|
|
RemoteProject
|
getProjectWithSchemesById(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.
|
|
List<Object>
|
getProjectsNoSchemes()
Returns an array of all the Projects defined in JIRA.
|
|
RemoteIssue
|
getRemoteIssue(String issueKey)
Finds an issue by key.
|
|
RemoteUser
|
getRemoteUser(String username)
Returns information about a user defined to JIRA.
|
|
Calendar
|
getResolutionDateById(Long issueId)
Given an issue id, this method returns the resolution date for this issue.
|
|
Calendar
|
getResolutionDateByKey(String issueKey)
Given an issue key, this method returns the resolution date for this issue.
|
|
List<Object>
|
getResolutions()
Returns an array of all the issue resolutions in JIRA.
|
|
JiraRestClient
|
getRestClient()
|
|
RemoteSecurityLevel
|
getSecurityLevel(String issueKey)
Returns the current security level for given issue
|
|
List<Object>
|
getSecurityLevels(String projectKey)
Returns an array of all security levels for a given project.
|
|
List<Object>
|
getSecuritySchemes()
Returns the security schemes.
|
|
RemoteServerInfo
|
getServerInfo()
Returns information about the server JIRA is running on including build number and base URL.
|
|
List<Object>
|
getStatuses()
Returns an array of all the issue statuses in JIRA.
|
|
List<Object>
|
getSubTaskIssueTypes()
Returns an array of all the sub task issue types in JIRA.
|
|
List<Object>
|
getSubTaskIssueTypesForProject(String projectId)
Returns an array of all the sub task issue types for the specified project id.
|
|
String
|
getToken()
|
|
Boolean
|
getUseCustomFieldsExternalName()
|
|
BasicUser
|
getUser(String userName)
Get a user given its username
|
|
List<Object>
|
getVersions(String projectKey)
Returns an array of all the versions for the specified project key.
|
|
List<Object>
|
getWorklogs(String issueKey)
Returns all worklogs for the given issue.
|
|
boolean
|
hasPermissionToCreateWorklog(String issueKey)
Determines if the user has the permission to add worklogs to the specified issue, that timetracking is enabled
in JIRA and that the specified issue is in an editable workflow state.
|
|
boolean
|
hasPermissionToDeleteWorklog(String 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(Long commentId)
Returns whether the current user has permissions to edit the comment denoted by the given id.
|
|
boolean
|
hasPermissionToUpdateWorklog(String worklogId)
Determine whether the current user has the permission to update the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.
|
|
boolean
|
isProjectRoleNameUnique(String roleName)
Checks if the given project role name is unique.
|
|
String
|
login(String username, String password)
Log in using the given credentials, it returns the authentication token.
|
|
boolean
|
logout(String token)
Cleans up an authentication token that was previously created with a call to login
|
|
RemoteIssue
|
progressWorkflowAction(String issueKey, String actionIdString, Map<String, String> fields)
This will progress an issue through a workflow.
|
|
void
|
refreshCustomFields()
Refreshs custom fields for the current user.
|
|
void
|
releaseVersion(String projectKey, String versionName)
Releases the version denoted by the given name
|
|
void
|
removeActorsFromProjectRole(List<String> actors, Long projectRoleId, String projectKey, String actorType)
Removes the given actors from the project role
|
|
void
|
removeAllRoleActorsByNameAndType(String roleName, String type)
Removes all role actors using the given name and type.
|
|
void
|
removeAllRoleActorsByProject(String projectKey)
Removes all role actors for the given project key.
|
|
void
|
removeDefaultActorsFromProjectRole(List<String> actors, Long remoteProjectRoleId, String type)
Removes the default actors from the project role denoted by this id.
|
|
void
|
removeUserFromGroup(String groupName, String userName)
Removes a user from the group name.
|
|
void
|
setClient(JiraClient<?> client)
|
|
void
|
setConnectionAddress(String connectionAddress)
|
|
void
|
setConnectionUser(String connectionUser)
|
|
void
|
setJiraRestUrl(String jiraRestUrl)
|
|
void
|
setNewProjectAvatar(String projectKey, String contentType, String base64ImageData)
Creates a new custom avatar for the given project and sets it to be current for the project.
|
|
void
|
setProjectAvatar(String projectKey, Long avatarId)
Sets the current avatar for the given project to that with the given id.
|
|
void
|
setRestClient(JiraRestClient restClient)
|
|
void
|
setToken(String token)
|
|
void
|
setUseCustomFieldsExternalName(Boolean useCustomFieldsExternalName)
|
|
String
|
toString()
Returns a connection identifier.
|
|
Component
|
updateComponent(String uri, ComponentInput component)
Update a component
|
|
RemoteGroup
|
updateGroup(String groupName, List<String> usernames)
Updates the given group name with the provided users.
|
|
RemoteIssue
|
updateIssue(String issueKey, Map<String, String> fields)
This will update an issue with new values.
|
|
List<RemoteIssue>
|
updateIssuesByJql(String jql, Map<String, String> fields, Integer maxRecordsToUpdate)
This will update the set of issues that result from the jql search
NOTE : You cannot update the 'status' field of the issues via this method.
|
|
RemoteProject
|
updateProject(String key, String projectName, String description, String url, String lead, String permissionSchemeName, String notificationSchemeName, String securityShemeName)
Updates the project denoted by the given key.
|
|
void
|
updateProjectRole(Long projectRoleId, String projectRoleName, String projectRoleDescription)
Updates the project role with the given id.
|
|
Version
|
updateVersion(String uri, VersionInput version)
Update a version
|
|
void
|
updateWorklogWithNewRemainingEstimate(String issueKey, String worklogId, String newRemainingEstimate, String comment, String groupLevel, String roleLevelId)
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.
|
|
Void
|
uploadAttachment(Issue issue, InputStream in, String filename)
Upload an attachment to the issue
|
|
boolean
|
validateConnection()
Returns whether the current user is authenticated.
|
Known Direct Subclasses