com.atlassian.jira.rest.client
Interface MetadataRestClient

public interface MetadataRestClient

Serves information about JIRA metadata like server information, issue types defined, stati, priorities and resolutions. This data constitutes a data dictionary which then JIRA issues base on.

Since:

v0.1

Method Summary

Iterable<IssuelinksType>	getIssueLinkTypes(ProgressMonitor progressMonitor) Retrieves from the server complete list of available issue types
IssueType	getIssueType(URI uri, ProgressMonitor progressMonitor) Retrieves from the server complete information about selected issue type
Iterable<IssueType>	getIssueTypes(ProgressMonitor progressMonitor) Retrieves from the server complete list of available issue type
Iterable<Priority>	getPriorities(ProgressMonitor progressMonitor) Retrieves from the server complete list of available priorities
Priority	getPriority(URI uri, ProgressMonitor progressMonitor) Retrieves from the server complete information about selected priority
Resolution	getResolution(URI uri, ProgressMonitor progressMonitor) Retrieves from the server complete information about selected resolution
Iterable<Resolution>	getResolutions(ProgressMonitor progressMonitor) Retrieves from the server complete information about selected resolution
ServerInfo	getServerInfo(ProgressMonitor progressMonitor) Retrieves information about this JIRA instance
Status	getStatus(URI uri, ProgressMonitor progressMonitor) Retrieves complete information about selected status

Method Detail

getIssueType

IssueType getIssueType(URI uri,
                       ProgressMonitor progressMonitor)

Retrieves from the server complete information about selected issue type

Parameters:

uri - URI to issue type resource (one can get it e.g. from self attribute of issueType field of an issue).

progressMonitor - progress monitor

Returns:

complete information about issue type resource

Throws:

RestClientException - in case of problems (connectivity, malformed messages, etc.)

getIssueTypes

Iterable<IssueType> getIssueTypes(ProgressMonitor progressMonitor)

Retrieves from the server complete list of available issue type

Parameters:

progressMonitor - progress monitor

Returns:

complete information about issue type resource

Throws:

RestClientException - in case of problems (connectivity, malformed messages, etc.)

Since:

client 1.0, server 5.0

getIssueLinkTypes

Iterable<IssuelinksType> getIssueLinkTypes(ProgressMonitor progressMonitor)

Retrieves from the server complete list of available issue types

Parameters:

progressMonitor - progress monitor

Returns:

list of available issue types for this JIRA instance

Throws:

RestClientException - in case of problems (if linking is disabled on the server, connectivity, malformed messages, etc.)

Since:

server 4.3, client 0.5

getStatus

Status getStatus(URI uri,
                 ProgressMonitor progressMonitor)

Retrieves complete information about selected status

Parameters:

uri - URI to this status resource (one can get it e.g. from self attribute of status field of an issue)

progressMonitor - progress monitor

Returns:

complete information about the selected status

Throws:

RestClientException - in case of problems (connectivity, malformed messages, etc.)

getPriority

Priority getPriority(URI uri,
                     ProgressMonitor progressMonitor)

Retrieves from the server complete information about selected priority

Parameters:

uri - URI for the priority resource

progressMonitor - progress monitor

Returns:

complete information about the selected priority

Throws:

RestClientException - in case of problems (connectivity, malformed messages, etc.)

getPriorities

Iterable<Priority> getPriorities(ProgressMonitor progressMonitor)

Retrieves from the server complete list of available priorities

Parameters:

progressMonitor - progress monitor

Returns:

complete information about the selected priority

Throws:

RestClientException - in case of problems (connectivity, malformed messages, etc.)

Since:

client 1.0, server 5.0

getResolution

Resolution getResolution(URI uri,
                         ProgressMonitor progressMonitor)

Retrieves from the server complete information about selected resolution

Parameters:

uri - URI for the resolution resource

progressMonitor - progress monitor

Returns:

complete information about the selected resolution

Throws:

RestClientException - in case of problems (connectivity, malformed messages, etc.)

getResolutions

Iterable<Resolution> getResolutions(ProgressMonitor progressMonitor)

Retrieves from the server complete information about selected resolution

Parameters:

progressMonitor - progress monitor

Returns:

complete information about the selected resolution

Throws:

RestClientException - in case of problems (connectivity, malformed messages, etc.)

Since:

client 1.0, server 5.0

getServerInfo

ServerInfo getServerInfo(ProgressMonitor progressMonitor)

Retrieves information about this JIRA instance

Parameters:

progressMonitor - progress monitor

Returns:

information about this JIRA instance

Throws:

RestClientException - in case of problems (connectivity, malformed messages, etc.)