com.atlassian.jira.bc.issue.attachment

Interface AttachmentService

All Known Implementing Classes:

DefaultAttachmentService

@PublicApi
public interface AttachmentService

AttachmentService contains methods for managing issue attachments in JIRA.

Method Summary

Modifier and Type	Method and Description
boolean	canAttachScreenshots(JiraServiceContext jiraServiceContext, Issue issue) Determines whether the user: has the required permission (Permissions.CREATE_ATTACHMENT) to create an attachment has the screenshot enabled is using a screenshot applet compatible OS (Windows or OSX) the issue is in an editable workflow state
boolean	canCreateAttachments(JiraServiceContext jiraServiceContext, Issue issue) Determines whether attachments are enabled in JIRA and that the user has the required permission (Permissions.CREATE_ATTACHMENT) to create an attachment for this issue.
boolean	canCreateAttachments(JiraServiceContext jiraServiceContext, Project project) Determines whether attachments are enabled in JIRA and that the user has the required permission (Permissions.CREATE_ATTACHMENT) to create an attachment for this project.
boolean	canCreateTemporaryAttachments(JiraServiceContext jiraServiceContext, Issue issue) Determines whether: the user has the required permission (Permissions.CREATE_ATTACHMENT) to create an attachment attachments are enabled This method does *not* check if the issue is in an editable workflow step, since temporary attachments may be created when reopening an issue *before* the issue is actually reopened!
boolean	canDeleteAttachment(JiraServiceContext jiraServiceContext, Long attachmentId) Retrieves the attachment specified by the attachment id and determines if the user can delete it.
boolean	canManageAttachments(JiraServiceContext jiraServiceContext, Issue issue) Checks whether the user has permission to manage the attachments of the specified issue.
void	delete(JiraServiceContext jiraServiceContext, Long attachmentId) Deletes the specified attachment and updates the issue change history and 'updated' date.
Attachment	getAttachment(JiraServiceContext jiraServiceContext, Long attachmentId) Retrieves the specified issue.

Method Detail

canDeleteAttachment

boolean canDeleteAttachment(JiraServiceContext jiraServiceContext,
                            Long attachmentId)

Retrieves the attachment specified by the attachment id and determines if the user can delete it. The user can delete it if:

• They have the DELETE_ALL permission OR they have the DELETE_OWN permission and they are the author of the specified attachment; and
• The specified attachment exists

Parameters:

jiraServiceContext - containing the user who the permission checks will be run against (can be null, indicating an anonymous user) and the errorCollection that will contain any errors in calling the method

attachmentId - specifies the attachment to be deleted

Returns:

true if the user has permission to delete the attachment; false otherwise

canManageAttachments

boolean canManageAttachments(JiraServiceContext jiraServiceContext,
                             Issue issue)

Checks whether the user has permission to manage the attachments of the specified issue. This is true if

• Attachments are enabled in JIRA
• The Attachment path is set
• The user is allowed to create OR delete attachments associated with the specified issue

Parameters:

jiraServiceContext - containing the user who the permission checks will be run against (can be null, indicating an anonymous user) and the errorCollection that will contain any errors in calling the method

issue - who's attachments will be checked against the specified user's delete permissions (if the issue is null an error will be placed into the supplied ErrorCollection and false will be returned)

Returns:

true if the user has permission to manage attachments

delete

void delete(JiraServiceContext jiraServiceContext,
            Long attachmentId)

Deletes the specified attachment and updates the issue change history and 'updated' date.

This method expects that canDeleteAttachment(com.atlassian.jira.bc.JiraServiceContext, Long) has been successfully called.

Parameters:

jiraServiceContext - containing the user who is attempting to delete the attachment and the errorCollection that will contain any errors in calling the method

attachmentId - of the target attachment, must not be null and must identify a valid attachment

getAttachment

Attachment getAttachment(JiraServiceContext jiraServiceContext,
                         Long attachmentId)
                  throws AttachmentNotFoundException

Retrieves the specified issue. Does not perform permission checks.

Parameters:

jiraServiceContext - containing the user who is attempting to retrieve the attachment and the errorCollection that will contain any errors in calling the method

attachmentId - of the target attachment, must not be null and must identify a valid attachment

Returns:

target attachment if no errors occur, null otherwise

Throws:

AttachmentNotFoundException - if the attachment does not exist

canCreateAttachments

boolean canCreateAttachments(JiraServiceContext jiraServiceContext,
                             @Nullable
                             Issue issue)

Determines whether attachments are enabled in JIRA and that the user has the required permission (Permissions.CREATE_ATTACHMENT) to create an attachment for this issue. This method also checks that the provided issue is in an editable workflow state.

Parameters:

jiraServiceContext - containing the user who wishes to create an attachment and the errorCollection that will contain any errors in calling the method

issue - that will have an attachment attached to it

Returns:

true if the user has permission to attach an attachment to the issue and the issue is in an editable workflow state, false otherwise

canCreateAttachments

boolean canCreateAttachments(JiraServiceContext jiraServiceContext,
                             @Nullable
                             Project project)

Determines whether attachments are enabled in JIRA and that the user has the required permission (Permissions.CREATE_ATTACHMENT) to create an attachment for this project.

Parameters:

jiraServiceContext - containing the user who wishes to create an attachment and the errorCollection that will contain any errors in calling the method

project - where the attachment will be created in

Returns:

true if the user has permission to attach an attachment in the project provided, false otherwise

canCreateTemporaryAttachments

boolean canCreateTemporaryAttachments(JiraServiceContext jiraServiceContext,
                                      @Nullable
                                      Issue issue)

Determines whether:

• the user has the required permission (Permissions.CREATE_ATTACHMENT) to create an attachment
• attachments are enabled

This method does *not* check if the issue is in an editable workflow step, since temporary attachments may be created when reopening an issue *before* the issue is actually reopened!

Parameters:

jiraServiceContext - containing the user who wishes to attach a file and the errorCollection that will contain any errors in calling the method

issue - that will have the file attached to it

Returns:

true if the user may attach a file, false otherwise

canAttachScreenshots

boolean canAttachScreenshots(JiraServiceContext jiraServiceContext,
                             Issue issue)

Determines whether the user:

• has the required permission (Permissions.CREATE_ATTACHMENT) to create an attachment
• has the screenshot enabled
• is using a screenshot applet compatible OS (Windows or OSX)
• the issue is in an editable workflow state

Parameters:

jiraServiceContext - containing the user who wishes to attach a screenshot and the errorCollection that will contain any errors in calling the method

issue - that will have the screenshot attached to it

Returns:

true if the user may attach a screenshot, false otherwise