com.atlassian.jira.project

Class RemoteProject

java.lang.Object

com.atlassian.jira.project.RemoteProject

@ExperimentalApi
 @Immutable
public final class RemoteProject
extends Object

Represents a JIRA Project within our "network" of federated JIRA servers.

Normally this will represent a project coming from one of the JIRA servers that we have an app link with. However, because it can be useful to create a list with both local and remote projects, one can construct an instance of this class that represents a local project.

This class is considered experimental while RemoteProjectService is still being developed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteProject.Builder

Constructor Summary

Constructors

Constructor and Description
RemoteProject(long id, String key, String name, String description, RemoteUser leadUser, String url, com.atlassian.applinks.api.ApplicationLink applicationLink, RemoteAvatar avatar)

Method Summary

Modifier and Type	Method and Description
static RemoteProject	from(com.atlassian.applinks.api.ApplicationLink applicationLink, JSONObject jsonObject)
static RemoteProject	from(Project project) Build a Network project instance from a local Project.
com.atlassian.applinks.api.ApplicationLink	getApplicationLink() Returns the AppLink for the server that this remote project lives on.
RemoteAvatar	getAvatar()
String	getBrowseProjectUrl() Returns the URL for the "Browse Project" page of this project.
String	getDescription() Returns the description for the underlying project, or null if the description was not supplied in the JSON response.
long	getId()
String	getKey()
RemoteUser	getLeadUser() Returns the Project Lead for this project.
String	getName()
String	getServerBaseUrl() Returns the Base URL for the server that this project lives on.
String	getUrl() Returns the configured "URL" value for this project.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteProject

public RemoteProject(long id,
                     String key,
                     String name,
                     String description,
                     RemoteUser leadUser,
                     String url,
                     com.atlassian.applinks.api.ApplicationLink applicationLink,
                     RemoteAvatar avatar)

Method Detail

getId

public long getId()

getKey

@Nonnull
public String getKey()

getName

@Nonnull
public String getName()

getDescription

@Nullable
public String getDescription()

Returns the description for the underlying project, or null if the description was not supplied in the JSON response.

An empty String is returned if the project has a blank description. A null return value indicates that the description was not returned over the wire, and should be treated as an "unknown" value.

Returns:

the description for the underlying project, or null if the description was not supplied in the JSON response.

getLeadUser

@Nullable
public RemoteUser getLeadUser()

Returns the Project Lead for this project.

In the REST API for JIRA 6.1, this value is returned when getting a single project, but not when getting all projects, so this value can sometimes be null even if the underlying project has a lead. Developers should treat a null value as "unknown".

Returns:

the Project Lead for this project.

getUrl

@Nullable
public String getUrl()

Returns the configured "URL" value for this project.

In the REST API for JIRA 6.1, this value is returned when getting a single project, but not when getting all projects, so this value can sometimes be null even if the underlying project has a URL specified. Consumers should treat a null value as "unknown".

Returns:

the configured "URL" value for this project, or null if not known.

getApplicationLink

@Nullable
public com.atlassian.applinks.api.ApplicationLink getApplicationLink()

Returns the AppLink for the server that this remote project lives on.

Will return null if the project is representing a local project on this server.

Returns:

the AppLink for the server that this remote project lives on, or null for a local project.

getAvatar

@Nonnull
public RemoteAvatar getAvatar()

getBrowseProjectUrl

@Nonnull
public String getBrowseProjectUrl()

Returns the URL for the "Browse Project" page of this project.

Returns:

the URL for the "Browse Project" page of this project.

getServerBaseUrl

@Nonnull
public String getServerBaseUrl()

Returns the Base URL for the server that this project lives on.

Returns:

the Base URL for the server that this project lives on.

from

@Nonnull
public static RemoteProject from(Project project)

Build a Network project instance from a local Project.

Parameters:

project - the local project

Returns:

a NetworkProject instance representing the given local project.

from

@Nonnull
public static RemoteProject from(com.atlassian.applinks.api.ApplicationLink applicationLink,
                                          JSONObject jsonObject)
                                   throws JSONException

Throws:

JSONException