com.atlassian.jira.issue.attachment
Interface AttachmentStore

All Known Implementing Classes:

DefaultAttachmentStore

@Internal
public interface AttachmentStore

Since:

v6.1

Nested Class Summary

static interface

AttachmentStore.AttachmentAdapter

Method Summary

void	checkValidAttachmentDirectory(Issue issue) Checks that the Attachment directory of the given issue is right to go - writable, accessible etc.
void	checkValidTemporaryAttachmentDirectory()
File	getAttachmentDirectory(Issue issue) Returns the physical directory of the attachments for the given issue.
File	getAttachmentDirectory(Issue issue, boolean createDirectory) Returns the physical directory of the attachments for the given issue.
File	getAttachmentDirectory(String issueKey)
File	getAttachmentDirectory(String attachmentDirectory, String projectKey, String issueKey) Get the attachment directory for the given attachment base directory, project key, and issue key.
File	getAttachmentFile(Attachment attachment) Returns the physical File for the given Attachment.
File	getAttachmentFile(AttachmentStore.AttachmentAdapter attachment, File attachmentDir) This is intended for cases where you want more control over where the attachment actually lives and you just want something to handle the look up logic for the various possible filenames an attachment can have.
File	getAttachmentFile(Issue issue, Attachment attachment) Returns the physical File for the given Attachment.
File	getLegacyThumbnailFile(Attachment attachment) Returns the old legacy file name for thumbnails.
File	getTemporaryAttachmentDirectory()
File	getThumbnailDirectory(Issue issue) Returns the physical directory of the thumbnails for the given issue, creating if necessary.
File	getThumbnailFile(Attachment attachment) Just like the attachments themselves, thumbnails can succumb to file system encoding problems.
File	getThumbnailFile(Issue issue, Attachment attachment) Returns the file handle for the given attachment's thumbnail.

Method Detail

getThumbnailDirectory

@Nonnull
File getThumbnailDirectory(@Nonnull
                                   Issue issue)

Returns the physical directory of the thumbnails for the given issue, creating if necessary.

Parameters:

issue - the issue whose thumbnail directory you want

Returns:

The issue's thumbnail directory.

getAttachmentDirectory

@Nullable
File getAttachmentDirectory(@Nonnull
                                     String issueKey)

getAttachmentDirectory

File getAttachmentDirectory(@Nonnull
                            Issue issue,
                            boolean createDirectory)

Returns the physical directory of the attachments for the given issue. This will create it if necessary.

Parameters:

issue - the issue whose attachment directory you want

createDirectory - If true, and the directory does not currently exist, then the directory is created.

Returns:

the issue's attachment directory

getTemporaryAttachmentDirectory

File getTemporaryAttachmentDirectory()

getAttachmentDirectory

File getAttachmentDirectory(@Nonnull
                            Issue issue)

Returns the physical directory of the attachments for the given issue. This will create it if necessary.

Parameters:

issue - the issue whose attachment directory you want

Returns:

The issue's attachment directory.

getAttachmentDirectory

File getAttachmentDirectory(String attachmentDirectory,
                            String projectKey,
                            String issueKey)

Get the attachment directory for the given attachment base directory, project key, and issue key.

The idea is to encapsulate all of the path-joinery magic to make future refactoring easier if we ever decide to move away from attachment-base/project-key/issue-ket

Parameters:

attachmentDirectory - base of attachments

projectKey - the project key the issue belongs to

issueKey - the issue key for the issue

Returns:

the directory attachments for this issue live in

getAttachmentFile

File getAttachmentFile(Issue issue,
                       Attachment attachment)
                       throws DataAccessException

Returns the physical File for the given Attachment. This method performs better as it does not need to look up the issue object.

Parameters:

issue - the issue the attachment belongs to.

attachment - the attachment.

Returns:

the file.

Throws:

DataAccessException - on failure getting required attachment info.

getAttachmentFile

File getAttachmentFile(Attachment attachment)
                       throws DataAccessException

Returns the physical File for the given Attachment. If you are calling this on multiple attachments for the same issue, consider using the overriden method that passes in the issue. Else, this goes to the database for each call.

Parameters:

attachment - the attachment.

Returns:

the file.

Throws:

DataAccessException - on failure getting required attachment info.

getAttachmentFile

File getAttachmentFile(AttachmentStore.AttachmentAdapter attachment,
                       File attachmentDir)

This is intended for cases where you want more control over where the attachment actually lives and you just want something to handle the look up logic for the various possible filenames an attachment can have.

In practice, this is just used during Project Import

Parameters:

attachment - it's not an attachment but it acts like one for our purposes.

attachmentDir - the directory the attachments live in. This is different that the system-wide attachment directory. i.e. this would "attachments/MKY/MKY-1" and not just "attachments"

Returns:

the actual attachment

getThumbnailFile

@Nonnull
File getThumbnailFile(Attachment attachment)

Just like the attachments themselves, thumbnails can succumb to file system encoding problems. However we are going to regenerate thumbnails by only using the new naming scheme and not the legacy one. We can't do this for attachments, but we can for thumbnails since they are ephemeral objects anyway. http://jira.atlassian.com/browse/JRA-23311

Parameters:

attachment - the attachment for which to get the thumbnail file

Returns:

a non-null file handle (the file itself might not exist)

See Also:

getThumbnailFile(com.atlassian.jira.issue.Issue, Attachment)

getThumbnailFile

@Nonnull
File getThumbnailFile(@Nonnull
                              Issue issue,
                              Attachment attachment)

Returns the file handle for the given attachment's thumbnail. This method performs better than getThumbnailFile(Attachment) if you already have the issue.

Parameters:

issue - the issue to which the attachment belongs

attachment - the attachment for which to get the thumbnail file

Returns:

a non-null file handle (the file itself might not exist)

See Also:

getThumbnailFile(Attachment)

getLegacyThumbnailFile

File getLegacyThumbnailFile(Attachment attachment)

Returns the old legacy file name for thumbnails. http://jira.atlassian.com/browse/JRA-23311

Parameters:

attachment - the attachment in play

Returns:

the full legacy thumbnail file name

checkValidAttachmentDirectory

void checkValidAttachmentDirectory(Issue issue)
                                   throws AttachmentException

Checks that the Attachment directory of the given issue is right to go - writable, accessible etc. Will create it if necessary.

Parameters:

issue - the issue whose attachment directory to check.

Throws:

AttachmentException - if the directory is not writable or missing and cannot be created.

checkValidTemporaryAttachmentDirectory

void checkValidTemporaryAttachmentDirectory()
                                            throws AttachmentException

Throws:

AttachmentException