com.atlassian.jira.issue.attachment

Interface AttachmentStore

All Known Implementing Classes:

BackwardCompatibleAttachmentStore

Deprecated.

since 6.3. Please access attachments via AttachmentManager, and thumbnails via ThumbnailManager.

@Internal
 @Deprecated
public interface AttachmentStore

Since:

v6.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AttachmentStore.AttachmentAdapter Deprecated.

Method Summary

Modifier and Type	Method and Description
void	checkValidAttachmentDirectory(Issue issue) Deprecated. Use errors() instead.
void	checkValidTemporaryAttachmentDirectory() Deprecated. Use errors() instead.
com.atlassian.util.concurrent.Promise<Attachment>	copy(Attachment originalAttachment, Attachment metaData, String newIssueKey) Deprecated. Copy an attachment to another issue.
com.atlassian.util.concurrent.Promise<Void>	deleteAttachment(Attachment attachment) Deprecated. Delete the specified attachment.
com.atlassian.util.concurrent.Promise<Void>	deleteAttachmentContainerForIssue(Issue issue) Deprecated. Delete the container for attachments for a given issue.
com.atlassian.fugue.Option<ErrorCollection>	errors() Deprecated. Health status for this component.
<A> com.atlassian.util.concurrent.Promise<A>	getAttachment(Attachment metaData, com.atlassian.util.concurrent.Function<InputStream,A> inputStreamProcessor) Deprecated. Retrieve data for a given attachment.
File	getAttachmentDirectory(Issue issue) Deprecated. Returns the physical directory of the attachments for the given issue.
File	getAttachmentDirectory(Issue issue, boolean createDirectory) Deprecated. Returns the physical directory of the attachments for the given issue.
File	getAttachmentDirectory(String issueKey) Deprecated.
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(Attachment attachment) Deprecated. Returns the physical File for the given Attachment.
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 look up 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.
File	getThumbnailDirectory(Issue issue) Deprecated. Returns the physical directory of the thumbnails for the given issue, creating 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.
com.atlassian.util.concurrent.Promise<Void>	move(Attachment metaData, String newIssueKey) Deprecated. Moves an attachment from its current issue under a new one
com.atlassian.util.concurrent.Promise<Attachment>	putAttachment(Attachment metadata, File data) Deprecated. Store attachment data for a given attachment.
com.atlassian.util.concurrent.Promise<Attachment>	putAttachment(Attachment metadata, InputStream data) Deprecated. Store attachment data for a given attachment.

Method Detail

getThumbnailDirectory

@Nonnull
File getThumbnailDirectory(@Nonnull
                                    Issue issue)

Deprecated.

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)

Deprecated.

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 currently exist, then the directory is created.

Returns:

the issue's attachment directory

getTemporaryAttachmentDirectory

File getTemporaryAttachmentDirectory()

Deprecated.

getAttachmentDirectory

File getAttachmentDirectory(@Nonnull
                            Issue issue)

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

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 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

Deprecated.

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

Deprecated.

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)

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 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

putAttachment

com.atlassian.util.concurrent.Promise<Attachment> putAttachment(Attachment metadata,
                                                                InputStream data)

Deprecated.

Store attachment data for a given attachment.

Parameters:

metadata - attachment metadata, used to determine the logical key under which to store the attachment data

data - source data. The attachment store will close this stream when it has completed. The stream will be closed once the operation is complete.

Returns:

A promise of an attachment that performs the 'put' operation once the promise is claimed. The promise will contain an AttachmentRuntimeException in case of error.

putAttachment

com.atlassian.util.concurrent.Promise<Attachment> putAttachment(Attachment metadata,
                                                                File data)

Deprecated.

Store attachment data for a given attachment.

Parameters:

metadata - attachment metadata, used to determine the logical key under which to store the attachment data

data - source data. It is assumed that the file will exist during the attachment process (i.e. relatively long lived).

Returns:

A promise of an attachment that performs the 'put' operation once the promise is claimed.

getAttachment

<A> com.atlassian.util.concurrent.Promise<A> getAttachment(Attachment metaData,
                                                           com.atlassian.util.concurrent.Function<InputStream,A> inputStreamProcessor)

Deprecated.

Retrieve data for a given attachment.

Type Parameters:

A - The class that the inputStreamProcessor returns when run.

Parameters:

metaData - attachment metadata, used to determine the logical key under which to store the attachment data

inputStreamProcessor - Function that processes the attachment data.

Returns:

A promise of an object that represented the processed attachment data (i.e. from running the inputStreamProcessor over the attachment data). The promise will contain an AttachmentRuntimeException in case of error.

move

com.atlassian.util.concurrent.Promise<Void> move(Attachment metaData,
                                                 String newIssueKey)

Deprecated.

Moves an attachment from its current issue under a new one

Parameters:

metaData - attachment metadata, used to determine the logical key of the attachment to be moved.

newIssueKey - the key of the new issue under which the attachment will reside.

Returns:

a promise that will be completed when the operation is complete. It will contain an AttachmentRuntimeException in case of error.

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. 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)

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. 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

Deprecated. Use errors() instead.

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. Use errors() instead.

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.

errors

com.atlassian.fugue.Option<ErrorCollection> errors()

Deprecated.

Health status for this component. Specifically the errors that cause the attachment subsystem to fail.

Returns:

An option of an error collection that contains error messages if there are any issues. The option will be none if there are no errors.

deleteAttachment

com.atlassian.util.concurrent.Promise<Void> deleteAttachment(@Nonnull
                                                             Attachment attachment)

Deprecated.

Delete the specified attachment.

Returns:

a promise that will contain an AttachmentCleanupException in case of error.

deleteAttachmentContainerForIssue

com.atlassian.util.concurrent.Promise<Void> deleteAttachmentContainerForIssue(@Nonnull
                                                                              Issue issue)

Deprecated.

Delete the container for attachments for a given issue. For file systems, this means the attachment directory for that issue.

Parameters:

issue - The issue to delete attachments for.

Returns:

A promise that will contain a AttachmentCleanupException if there is a problem deleting the attachment directory.

copy

@Nonnull
com.atlassian.util.concurrent.Promise<Attachment> copy(@Nonnull
                                                                Attachment originalAttachment,
                                                                @Nonnull
                                                                Attachment metaData,
                                                                @Nonnull
                                                                String newIssueKey)

Deprecated.

Copy an attachment to another issue.

Parameters:

originalAttachment - the original attachment.

metaData - the meta data of the copied attachment.

newIssueKey - the issue that the attachment will be copied to.

Returns:

a promise of an attachment or AttachmentCopyException if there are any errors.