com.atlassian.jira.rest.client.api

Interface JiraRestClient

All Superinterfaces:

AutoCloseable, Closeable

public interface JiraRestClient
extends Closeable

Main access point to REST com.atlassian.jira.rest.client.api. As there are many types resources exposed by JIRA REST API, various resources are grouped into clusters and then handled by different specialized *RestClient classes.

Since:

v0.1

Method Summary

Modifier and Type	Method and Description
void	close() Destroys this instance of JIRA Rest Client.
AuditRestClient	getAuditRestClient()
ComponentRestClient	getComponentClient()
IssueRestClient	getIssueClient()
MetadataRestClient	getMetadataClient()
MyPermissionsRestClient	getMyPermissionsRestClient()
ProjectRestClient	getProjectClient()
ProjectRolesRestClient	getProjectRolesRestClient()
SearchRestClient	getSearchClient()
SessionRestClient	getSessionClient()
UserRestClient	getUserClient()
VersionRestClient	getVersionRestClient()

Method Detail

getIssueClient

IssueRestClient getIssueClient()

Returns:

com.atlassian.jira.rest.client.api for performing operations on selected issue

getSessionClient

SessionRestClient getSessionClient()

Returns:

the com.atlassian.jira.rest.client.api handling session information

getUserClient

UserRestClient getUserClient()

Returns:

the com.atlassian.jira.rest.client.api handling full user information

getProjectClient

ProjectRestClient getProjectClient()

Returns:

the com.atlassian.jira.rest.client.api handling project metadata

getComponentClient

ComponentRestClient getComponentClient()

Returns:

the com.atlassian.jira.rest.client.api handling components

getMetadataClient

MetadataRestClient getMetadataClient()

Returns:

the com.atlassian.jira.rest.client.api handling basic meta-data (data dictionaries defined in JIRA - like resolutions, statuses, priorities)

getSearchClient

SearchRestClient getSearchClient()

Returns:

the com.atlassian.jira.rest.client.api handling search (e.g. JQL)

getVersionRestClient

VersionRestClient getVersionRestClient()

Returns:

the com.atlassian.jira.rest.client.api handling project versions.

getProjectRolesRestClient

ProjectRolesRestClient getProjectRolesRestClient()

Returns:

the com.atlassian.jira.rest.client.api for project roles.

getAuditRestClient

AuditRestClient getAuditRestClient()

Returns:

the com.atlassian.jira.rest.client.api for auditing records

getMyPermissionsRestClient

MyPermissionsRestClient getMyPermissionsRestClient()

Returns:

the com.atlassian.jira.rest.client.api for my permissions.

close

void close()
    throws IOException

Destroys this instance of JIRA Rest Client.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if there is a problem closing this client.