com.atlassian.jira.issue.attachment

Interface AttachmentStore

All Known Implementing Classes:

DefaultAttachmentStore

Deprecated.

since 6.3. Please access attachments via AttachmentManager, and thumbnails via ThumbnailManager. To be deleted in Jira 10.0.0.

@Internal
 @Deprecated
public interface AttachmentStore

A DAO-style component that handles the persistence of attachments.

Since:

v6.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AttachmentStore.AttachmentAdapter Deprecated. A lightweight value object that provides the ID and filename of an attachment.

Method Summary

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

Method Detail

getTemporaryAttachmentDirectory

@Nonnull
File getTemporaryAttachmentDirectory()

Deprecated. To be deleted in Jira 10.0.0. use AttachmentConfigManager.getTemporaryAttachmentDirectory() instead

Returns the directory for temporary attachments.

Returns:

see description

getAttachmentFile

File getAttachmentFile(Issue issue,
                       Attachment attachment)
                throws DataAccessException

Deprecated.

Returns the physical File for the given Attachment.

Parameters:

issue - the issue to which the attachment belongs

attachment - the attachment

Returns:

the file.

Throws:

DataAccessException - on failure getting required attachment info.

getThumbnailDirectory

@Nonnull
File getThumbnailDirectory(@Nonnull
                                    Issue issue)

Deprecated.

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

Parameters:

issue - the issue whose thumbnail directory you want

Returns:

the issue's thumbnail directory

getAttachmentDirectory

File getAttachmentDirectory(@Nonnull
                            Issue issue,
                            boolean createDirectory)

Deprecated.

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 exist, this method creates it

Returns:

the issue's attachment directory

getAttachmentDirectory

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

Deprecated.

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

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

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(AttachmentStore.AttachmentAdapter attachment,
                       File attachmentDir)

Deprecated.

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

Parameters:

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

attachmentDir - the directory in which the attachments live. This is different to the system-wide attachment directory, for example "attachments/MKY/MKY-1" rather than simply "attachments"

Returns:

the actual attachment

getThumbnailFile

@Nonnull
File getThumbnailFile(Attachment attachment)

Deprecated.

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.

See JRASERVER-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)

Deprecated.

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)

Deprecated.

Returns the old legacy file name for thumbnails.

See JRASERVER-23311.

Parameters:

attachment - the attachment in play

Returns:

the full legacy thumbnail file name

checkValidAttachmentDirectory

void checkValidAttachmentDirectory(Issue issue)
                            throws AttachmentException

Deprecated.

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

Deprecated.

Checks that the temporary directory for attachment uploads is right to go - writable, accessible etc.

Throws:

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