| Package | Description |
|---|---|
| net.rcarz.jiraclient | |
| net.rcarz.jiraclient.agile | |
| net.rcarz.jiraclient.greenhopper |
| Modifier and Type | Method and Description |
|---|---|
void |
Issue.addAttachment(File file)
Adds an attachment to this issue.
|
void |
Issue.addAttachments(Issue.NewAttachment... attachments)
Adds an attachments to this issue.
|
Comment |
Issue.addComment(String body)
Adds a comment to this issue.
|
Comment |
Issue.addComment(String body,
String visType,
String visName)
Adds a comment to this issue with limited visibility.
|
void |
Issue.addRemoteLink(String url,
String title,
String summary)
Adds a remote link to this issue.
|
void |
Issue.addWatcher(String username)
Adds a watcher to the issue.
|
WorkLog |
Issue.addWorkLog(String comment,
org.joda.time.DateTime startDate,
long timeSpentSeconds)
Adds
WorkLog to this issue |
void |
Version.copyTo(Project project)
Copies the version to the given project
|
static int |
Issue.count(RestClient restclient,
String jql)
count issues with the given query.
|
int |
JiraClient.countIssues(String jql)
count issues with the given query.
|
void |
Issue.FluentRemoteLink.create()
Creates or updates the remote link if a
global id is given and there is already
a remote link for the specified global id. |
static Issue.FluentCreate |
Issue.create(RestClient restclient,
String project,
String issueType)
Creates a new JIRA issue.
|
Issue.FluentCreate |
JiraClient.createIssue(String project,
String issueType)
Creates a new issue in the given project.
|
Issue.FluentCreate |
Issue.createSubtask()
Creates a new sub-task.
|
void |
IssueLink.delete()
Deletes this issue link record.
|
void |
Component.delete()
Deletes a component from a project.
|
boolean |
Issue.delete(boolean deleteSubtasks) |
void |
Issue.deleteWatcher(String username)
Removes a watcher to the issue.
|
byte[] |
Attachment.download()
Downloads attachment to byte array
|
Version |
Version.FluentCreate.execute()
Executes the create action.
|
Issue |
Issue.FluentCreate.execute()
Executes the create action (issue includes all fields).
|
void |
Issue.FluentUpdate.execute()
Executes the update action.
|
Component |
Component.FluentCreate.execute()
Executes the create action.
|
void |
Issue.FluentTransition.execute(int id)
Executes the transition action.
|
Issue |
Issue.FluentCreate.execute(String includedFields)
Executes the create action and specify which fields to retrieve.
|
void |
Issue.FluentTransition.execute(String name)
Executes the transition action.
|
void |
Issue.FluentTransition.execute(Transition transition)
Executes the transition action.
|
static Watches |
Watches.get(RestClient restclient,
String issue)
Retrieves the given watches record.
|
static Votes |
Votes.get(RestClient restclient,
String issue)
Retrieves the given votes record.
|
static Version |
Version.get(RestClient restclient,
String id)
Retrieves the given version record.
|
static User |
User.get(RestClient restclient,
String username)
Retrieves the given user record.
|
static Status |
Status.get(RestClient restclient,
String id)
Retrieves the given status record.
|
static Security |
Security.get(RestClient restclient,
String id)
Retrieves the given security record.
|
static Resolution |
Resolution.get(RestClient restclient,
String id)
Retrieves the given resolution record.
|
static ProjectCategory |
ProjectCategory.get(RestClient restclient,
String id)
Retrieves the given status record.
|
static Project |
Project.get(RestClient restclient,
String key)
Retrieves the given project record.
|
static Priority |
Priority.get(RestClient restclient,
String id)
Retrieves the given priority record.
|
static LinkType |
LinkType.get(RestClient restclient,
String id)
Retrieves the given issue link type record.
|
static IssueType |
IssueType.get(RestClient restclient,
String id)
Retrieves the given issue type record.
|
static IssueLink |
IssueLink.get(RestClient restclient,
String id)
Retrieves the given issue link record.
|
static Issue |
Issue.get(RestClient restclient,
String key)
Retrieves the given issue record.
|
static Filter |
Filter.get(RestClient restclient,
String id) |
static CustomFieldOption |
CustomFieldOption.get(RestClient restclient,
String id)
Retrieves the given custom field option record.
|
static Component |
Component.get(RestClient restclient,
String id)
Retrieves the given component record.
|
static Attachment |
Attachment.get(RestClient restclient,
String id)
Retrieves the given attachment record.
|
static WorkLog |
WorkLog.get(RestClient restclient,
String issue,
String id)
Retrieves the given work log record.
|
static Issue |
Issue.get(RestClient restclient,
String key,
String includedFields)
Retrieves the given issue record.
|
static Comment |
Comment.get(RestClient restclient,
String issue,
String id)
Retrieves the given comment record.
|
static Issue |
Issue.get(RestClient restclient,
String key,
String includedFields,
String expand)
Retrieves the given issue record.
|
static List<Project> |
Project.getAll(RestClient restclient)
Retrieves all project records visible to the session user.
|
List<WorkLog> |
Issue.getAllWorkLogs() |
List<User> |
Project.getAssignableUsers() |
Component |
JiraClient.getComponent(String id)
Obtains a component given its ID.
|
List<Component> |
JiraClient.getComponentsAllowedValues(String project,
String issueType)
Get a list of options for a components
|
static net.sf.json.JSONObject |
Issue.getCreateMetadata(RestClient restclient,
String project,
String issueType) |
List<CustomFieldOption> |
JiraClient.getCustomFieldAllowedValues(String field,
String project,
String issueType)
Get a list of options for a custom field
|
static Field.Meta |
Field.getFieldMetadata(String name,
net.sf.json.JSONObject editmeta)
Extracts field metadata from an editmeta JSON object.
|
Filter |
JiraClient.getFilter(String id)
Retrieve the jira filter with the supplied id.
|
Issue |
JiraClient.getIssue(String key)
Retreives the issue with the given key.
|
Issue |
JiraClient.getIssue(String key,
String includedFields)
Retreives the issue with the given key.
|
Issue |
JiraClient.getIssue(String key,
String includedFields,
String expand)
Retreives the issue with the given key.
|
ArrayList<IssueHistory> |
JiraClient.getIssueChangeLog(Issue issue) |
List<IssueType> |
JiraClient.getIssueTypes()
Obtains the list of all issue types in Jira.
|
List<Priority> |
JiraClient.getPriorities() |
Project |
JiraClient.getProject(String key)
Obtains information about a project, given its project key.
|
List<Project> |
JiraClient.getProjects()
Obtains the list of all projects in Jira.
|
List<RemoteLink> |
Issue.getRemoteLinks() |
List<Transition> |
Issue.getTransitions() |
void |
TokenCredentials.initialize(RestClient client) |
void |
ICredentials.initialize(RestClient client) |
void |
BasicCredentials.initialize(RestClient client) |
void |
Issue.link(String issue,
String type)
Links this issue with another issue.
|
void |
Issue.link(String issue,
String type,
String body)
Links this issue with another issue and adds a comment.
|
void |
Issue.link(String issue,
String type,
String body,
String visType,
String visName)
Links this issue with another issue and adds a comment with limited visibility.
|
void |
TokenCredentials.logout(RestClient client) |
void |
ICredentials.logout(RestClient client) |
void |
BasicCredentials.logout(RestClient client) |
void |
Version.mergeWith(Version version)
Merges the given version with current version
|
void |
Issue.refresh()
Reloads issue data from the JIRA server (issue includes all navigable
fields).
|
void |
Issue.refresh(String includedFields)
Reloads issue data from the JIRA server and specify which fields to
retrieve.
|
void |
Issue.removeAttachment(String attachmentId)
Removes an attachments.
|
static Issue.SearchResult |
Issue.search(RestClient restclient,
String jql,
String includedFields,
String expandFields,
Integer maxResults,
Integer startAt)
Search for issues with the given query and specify which fields to
retrieve.
|
Issue.SearchResult |
JiraClient.searchIssues(String jql)
Search for issues with the given query.
|
Issue.SearchResult |
JiraClient.searchIssues(String jql,
Integer maxResults)
Search for issues with the given query and max results.
|
Issue.SearchResult |
JiraClient.searchIssues(String jql,
String includedFields)
Search for issues with the given query and specify which fields to
retrieve.
|
Issue.SearchResult |
JiraClient.searchIssues(String jql,
String includedFields,
Integer maxResults)
Search for issues with the given query and specify which fields to
retrieve.
|
Issue.SearchResult |
JiraClient.searchIssues(String jql,
String includedFields,
Integer maxResults,
Integer startAt)
Search for issues with the given query and specify which fields to
retrieve.
|
Issue.SearchResult |
JiraClient.searchIssues(String jql,
String includedFields,
String expandFields)
Search for issues with the given query and specify which fields to
retrieve and expand.
|
Issue.SearchResult |
JiraClient.searchIssues(String jql,
String includedFields,
String expandFields,
Integer maxResults,
Integer startAt)
Search for issues with the given query and specify which fields to
retrieve.
|
static net.sf.json.JSONArray |
Field.toArray(Iterable iter,
String type,
String custom)
Converts an iterable type to a JSON array.
|
static Object |
Field.toJson(String name,
Object value,
net.sf.json.JSONObject editmeta)
Converts the given value to a JSON object.
|
Issue.FluentTransition |
Issue.transition()
Begins a transition field chain.
|
void |
Issue.unvote()
Removes the current user's vote from the issue.
|
Issue.FluentUpdate |
Issue.update()
Begins an update field chain.
|
void |
Comment.update(String body)
Updates the comment body.
|
void |
Comment.update(String body,
String visType,
String visName)
Updates the comment body with limited visibility.
|
void |
Issue.vote()
Casts a vote in favour of an issue.
|
| Constructor and Description |
|---|
JiraClient(org.apache.http.client.HttpClient httpClient,
String uri,
ICredentials creds)
Creates an authenticated JIRA client with custom HttpClient.
|
JiraClient(String uri)
Creates a JIRA client.
|
JiraClient(String uri,
ICredentials creds)
Creates an authenticated JIRA client.
|
SearchResult(RestClient restclient,
String jql,
String includedFields,
String expandFields,
Integer maxResults,
Integer startAt) |
| Modifier and Type | Method and Description |
|---|---|
Issue |
Epic.asIssue(boolean refresh) |
protected void |
Sprint.deserialize(net.sf.json.JSONObject json) |
protected void |
Issue.deserialize(net.sf.json.JSONObject json) |
protected void |
Board.deserialize(net.sf.json.JSONObject json) |
static Sprint |
Sprint.get(RestClient restclient,
long sprintId)
Retrieve all sprints related to the specified board.
|
static Issue |
Issue.get(RestClient restclient,
long id)
Retrieves the issue matching the ID.
|
static Epic |
Epic.get(RestClient restclient,
long id)
Retrieves the epic matching the ID.
|
static Board |
Board.get(RestClient restclient,
long id)
Retrieves the given rapid view.
|
static Issue |
Issue.get(RestClient restclient,
String key)
Retrieves the issue matching the ID.
|
static List<Board> |
Board.getAll(RestClient restclient)
Retrieves all boards visible to the session user.
|
static List<Sprint> |
Sprint.getAll(RestClient restclient,
long boardId)
Retrieve all sprints related to the specified board.
|
List<Issue> |
Board.getBacklog() |
Board |
AgileClient.getBoard(long id)
Retrieves the board with the given ID.
|
List<Board> |
AgileClient.getBoards()
Retrieves all boards visible to the session user.
|
Epic |
AgileClient.getEpic(long id)
Retrieves the epic with the given ID.
|
List<Epic> |
Board.getEpics() |
Issue |
AgileClient.getIssue(long id)
Retrieves the issue with the given ID.
|
Issue |
AgileClient.getIssue(String key)
Retrieves the issue with the given Key.
|
List<Issue> |
Sprint.getIssues() |
List<Issue> |
Epic.getIssues() |
List<Issue> |
Board.getIssuesWithoutEpic() |
protected static <T extends AgileResource> |
AgileResource.getResource(Class<T> type,
Object r,
RestClient restclient)
Gets an Agile resource from the given object.
|
protected static <T extends AgileResource> |
AgileResource.getResourceArray(Class<T> type,
Object ra,
RestClient restclient,
String listName)
Gets a list of GreenHopper resources from the given object.
|
Sprint |
AgileClient.getSprint(long id)
Retrieves the sprint with the given ID.
|
List<Sprint> |
Board.getSprints() |
| Constructor and Description |
|---|
AgileResource(RestClient restclient,
net.sf.json.JSONObject json)
Creates a new Agile resource.
|
Board(RestClient restclient,
net.sf.json.JSONObject json)
Creates a Board from a JSON payload.
|
Comment(RestClient restclient,
net.sf.json.JSONObject json)
Creates a new Agile resource.
|
Epic(RestClient restclient,
net.sf.json.JSONObject json)
Creates a new Agile resource.
|
Issue(RestClient restclient,
net.sf.json.JSONObject json)
Creates a new Agile Issue resource.
|
IssueType(RestClient restclient,
net.sf.json.JSONObject json)
Creates a new Agile resource.
|
Priority(RestClient restclient,
net.sf.json.JSONObject json)
Creates a new Agile resource.
|
Project(RestClient restclient,
net.sf.json.JSONObject json)
Creates a new Agile resource.
|
Resolution(RestClient restclient,
net.sf.json.JSONObject json)
Creates a new Agile resource.
|
Sprint(RestClient restclient,
net.sf.json.JSONObject json)
Creates a rapid view from a JSON payload.
|
Status(RestClient restclient,
net.sf.json.JSONObject json)
Creates a new Agile resource.
|
TimeTracking(RestClient restclient,
net.sf.json.JSONObject json)
Creates a new Agile resource.
|
User(RestClient restclient,
net.sf.json.JSONObject json)
Creates a new Agile resource.
|
Worklog(RestClient restclient,
net.sf.json.JSONObject json)
Creates a new Agile resource.
|
| Modifier and Type | Method and Description |
|---|---|
static RapidView |
RapidView.get(RestClient restclient,
int id)
Retrieves the given rapid view.
|
static Backlog |
Backlog.get(RestClient restclient,
RapidView rv)
Retrieves the backlog data for the given rapid view.
|
static SprintReport |
SprintReport.get(RestClient restclient,
RapidView rv,
Sprint sprint)
Retrieves the sprint report for the given rapid view and sprint.
|
static List<RapidView> |
RapidView.getAll(RestClient restclient)
Retrieves all rapid views visible to the session user.
|
Backlog |
RapidView.getBacklogData()
Retrieves the backlog data for this rapid view.
|
Issue |
GreenHopperIssue.getJiraIssue()
Retrieves the full JIRA issue.
|
Project |
RapidViewProject.getJiraProject()
Retrieves the full JIRA project.
|
Version |
RapidViewVersion.getJiraVersion()
Retrieves the full JIRA version.
|
RapidView |
GreenHopperClient.getRapidView(int id)
Retreives the rapid view with the given ID.
|
List<RapidView> |
GreenHopperClient.getRapidViews()
Retreives all rapid views visible to the session user.
|
SprintReport |
RapidView.getSprintReport(Sprint sprint)
Retrieves the sprint report for the given sprint.
|
List<Sprint> |
RapidView.getSprints()
Retrieves all sprints associated with this rapid view.
|
Copyright © 2022. All rights reserved.