com.atlassian.jira.issue.attachment

Class DefaultAttachmentStore

java.lang.Object

com.atlassian.jira.issue.attachment.DefaultAttachmentStore

All Implemented Interfaces:

AttachmentStore

@ParametersAreNonnullByDefault
public class DefaultAttachmentStore
extends Object
implements AttachmentStore

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.issue.attachment.AttachmentStore

AttachmentStore.AttachmentAdapter

Constructor Summary

Constructors

Constructor and Description
DefaultAttachmentStore(AttachmentDirectoryAccessor directoryAccessor, AttachmentKeyMapper attachmentKeyMapper, StoreAttachmentBeanMapper storeAttachmentBeanMapper, StreamAttachmentStore streamAttachmentStore, ThumbnailAccessor thumbnailAccessor)

Method Summary

Modifier and Type	Method and Description
void	checkValidAttachmentDirectory(Issue issue) Checks that the Attachment directory of the given issue is right to go - writable, accessible etc.
void	checkValidTemporaryAttachmentDirectory() Checks that the temporary directory for attachment uploads is right to go - writable, accessible etc.
File	getAttachmentDirectory(Issue issue, boolean createDirectory) Returns the physical directory of the attachments for the given issue.
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(AttachmentStore.AttachmentAdapter adapter, 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 lookup 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() Returns the directory for temporary attachments.
File	getThumbnailDirectory(Issue issue) Returns the physical directory of the thumbnails for the given issue, creating it 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAttachmentStore

public DefaultAttachmentStore(AttachmentDirectoryAccessor directoryAccessor,
                              AttachmentKeyMapper attachmentKeyMapper,
                              StoreAttachmentBeanMapper storeAttachmentBeanMapper,
                              StreamAttachmentStore streamAttachmentStore,
                              ThumbnailAccessor thumbnailAccessor)

Method Detail

getThumbnailDirectory

@Nonnull
public File getThumbnailDirectory(Issue issue)

Description copied from interface: AttachmentStore

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

Specified by:

getThumbnailDirectory in interface AttachmentStore

Parameters:

issue - the issue whose thumbnail directory you want

Returns:

the issue's thumbnail directory

getAttachmentDirectory

public File getAttachmentDirectory(Issue issue,
                                   boolean createDirectory)

Description copied from interface: AttachmentStore

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

Specified by:

getAttachmentDirectory in interface AttachmentStore

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

getTemporaryAttachmentDirectory

@Nonnull
public File getTemporaryAttachmentDirectory()

Description copied from interface: AttachmentStore

Returns the directory for temporary attachments.

Specified by:

getTemporaryAttachmentDirectory in interface AttachmentStore

Returns:

see description

getAttachmentDirectory

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

Description copied from interface: AttachmentStore

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.

Specified by:

getAttachmentDirectory in interface AttachmentStore

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

public File getAttachmentFile(Issue issue,
                              Attachment attachment)
                       throws DataAccessException

Description copied from interface: AttachmentStore

Returns the physical File for the given Attachment.

Specified by:

getAttachmentFile in interface AttachmentStore

Parameters:

issue - the issue to which the attachment belongs

attachment - the attachment

Returns:

the file.

Throws:

DataAccessException - on failure getting required attachment info.

getAttachmentFile

public File getAttachmentFile(AttachmentStore.AttachmentAdapter adapter,
                              File attachmentDir)

Description copied from interface: AttachmentStore

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.

Specified by:

getAttachmentFile in interface AttachmentStore

Parameters:

adapter - 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
public File getThumbnailFile(Attachment attachment)

Description copied from interface: AttachmentStore

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.

Specified by:

getThumbnailFile in interface AttachmentStore

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:

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

getThumbnailFile

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

Description copied from interface: AttachmentStore

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

Specified by:

getThumbnailFile in interface AttachmentStore

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:

AttachmentStore.getThumbnailFile(Attachment)

getLegacyThumbnailFile

public File getLegacyThumbnailFile(Attachment attachment)

Description copied from interface: AttachmentStore

Returns the old legacy file name for thumbnails.

See JRASERVER-23311.

Specified by:

getLegacyThumbnailFile in interface AttachmentStore

Parameters:

attachment - the attachment in play

Returns:

the full legacy thumbnail file name

checkValidAttachmentDirectory

public void checkValidAttachmentDirectory(Issue issue)
                                   throws AttachmentException

Description copied from interface: AttachmentStore

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

Specified by:

checkValidAttachmentDirectory in interface AttachmentStore

Parameters:

issue - the issue whose attachment directory to check.

Throws:

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

checkValidTemporaryAttachmentDirectory

public void checkValidTemporaryAttachmentDirectory()
                                            throws AttachmentException

Description copied from interface: AttachmentStore

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

Specified by:

checkValidTemporaryAttachmentDirectory in interface AttachmentStore

Throws:

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