com.atlassian.jira.rest.v2.issue

Class ComponentResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.ComponentResource

public class ComponentResource
extends Object

Since:

4.2

Constructor Summary

Constructors

Constructor and Description

ComponentResource(ProjectComponentService projectComponentService, ProjectComponentManager projectComponentManager, ProjectService projectService, UserManager userManager, AvatarService avatarService, ComponentIssueCountsBeanFactory componentIssueCountsBeanFactory, JiraAuthenticationContext authContext, I18nHelper i18n, PermissionManager permissionManager, ProjectManager projectManager, JiraBaseUrls jiraBaseUrls, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createComponent(ComponentBean bean) Create a component via POST.
javax.ws.rs.core.Response	delete(String id, String moveIssuesTo) Delete a project component.
javax.ws.rs.core.Response	getComponent(String id) Returns a project component.
javax.ws.rs.core.Response	getComponentRelatedIssues(String id) Returns counts of issues related to this component.
javax.ws.rs.core.Response	updateComponent(String id, ComponentBean bean) Modify a component via PUT.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentResource

public ComponentResource(ProjectComponentService projectComponentService,
                         ProjectComponentManager projectComponentManager,
                         ProjectService projectService,
                         UserManager userManager,
                         AvatarService avatarService,
                         ComponentIssueCountsBeanFactory componentIssueCountsBeanFactory,
                         JiraAuthenticationContext authContext,
                         I18nHelper i18n,
                         PermissionManager permissionManager,
                         ProjectManager projectManager,
                         JiraBaseUrls jiraBaseUrls,
                         com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

getComponent

public javax.ws.rs.core.Response getComponent(String id)

Returns a project component.

Parameters:

id - a String containing the component key

Returns:

a response containing a JSOn representation of a project component, or a 404 NOT FOUND if there is no component with the given id or the calling user does not have permission to view it.

createComponent

public javax.ws.rs.core.Response createComponent(ComponentBean bean)

Create a component via POST.

updateComponent

public javax.ws.rs.core.Response updateComponent(String id,
                                                 ComponentBean bean)

Modify a component via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.

If leadUserName is an empty string ("") the component lead will be removed.

getComponentRelatedIssues

public javax.ws.rs.core.Response getComponentRelatedIssues(String id)

Returns counts of issues related to this component.

Parameters:

id - a String containing the component id

Returns:

an issue counts bean

delete

public javax.ws.rs.core.Response delete(String id,
                                        String moveIssuesTo)

Delete a project component.

Parameters:

id - The component to delete.

moveIssuesTo - The new component applied to issues whose 'id' component will be deleted. If this value is null, then the 'id' component is simply removed from the related isues.

Returns:

An empty or error response.