com.atlassian.jira.issue.attachment

Class BackwardCompatibleAttachmentStore

java.lang.Object

com.atlassian.jira.issue.attachment.BackwardCompatibleAttachmentStore

All Implemented Interfaces:

AttachmentHealth, AttachmentStore, StreamAttachmentStore

@ParametersAreNonnullByDefault
public class BackwardCompatibleAttachmentStore
extends Object
implements AttachmentStore, StreamAttachmentStore

AttachmentStore and StreamAttachmentStore implementation that delegates calls to FileSystemAttachmentStore.

Since:

v6.3

Nested Class Summary

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

AttachmentStore.AttachmentAdapter

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

StreamAttachmentStore.Factory

Constructor Summary

Constructors

Constructor and Description
BackwardCompatibleAttachmentStore(AttachmentDirectoryAccessor directoryAccessor, ThumbnailAccessor thumbnailAccessor, StoreAttachmentBeanMapper storeAttachmentBeanMapper, FileSystemAttachmentStore fileSystemAttachmentStore, AttachmentKeyMapper attachmentKeyMapper, ProjectManager projectManager)

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.
io.atlassian.util.concurrent.Promise<Attachment>	copy(Attachment originalAttachment, Attachment metaData, String newIssueKey) Copy an attachment to another issue.
io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit>	copyAttachment(AttachmentKey sourceAttachmentKey, AttachmentKey newAttachmentKey) Copies attachment identified by oldAttachmentKey to be identified also by newAttachmentKey.
io.atlassian.util.concurrent.Promise<Void>	deleteAttachment(Attachment attachment) Delete the specified attachment.
io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit>	deleteAttachment(AttachmentKey attachmentKey) Delete the attachment identified by provided attachmentKey.
io.atlassian.util.concurrent.Promise<Void>	deleteAttachmentContainerForIssue(Issue issue) Delete the container for attachments for a given issue.
io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit>	deleteTemporaryAttachment(TemporaryAttachmentId temporaryAttachmentId) Deletes temporary attachment created previously by StreamAttachmentStore.putTemporaryAttachment(java.io.InputStream, long).
io.atlassian.fugue.Option<ErrorCollection>	errors() Health status for this component.
io.atlassian.util.concurrent.Promise<Boolean>	exists(AttachmentKey attachmentKey) Checks if attachment exists.
<A> io.atlassian.util.concurrent.Promise<A>	getAttachment(Attachment metaData, java.util.function.Function<InputStream,A> inputStreamProcessor) Retrieve data for a given attachment.
<A> io.atlassian.util.concurrent.Promise<A>	getAttachment(AttachmentKey attachmentKey, java.util.function.Function<InputStream,A> inputStreamProcessor) Retrieve data for a given attachment.
<A> io.atlassian.util.concurrent.Promise<A>	getAttachmentData(AttachmentKey attachmentKey, java.util.function.Function<AttachmentGetData,A> attachmentGetDataProcessor) Retrieve data for a given attachment.
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 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 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.
<A> io.atlassian.util.concurrent.Promise<A>	getTemporaryAttachment(TemporaryAttachmentId temporaryAttachmentId, java.util.function.Function<InputStream,A> inputStreamProcessor) Retrieve data for temporary attachment.
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.
io.atlassian.util.concurrent.Promise<Void>	move(Attachment metaData, String newIssueKey) Moves an attachment from its current issue under a new one
io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit>	moveAttachment(AttachmentKey oldAttachmentKey, AttachmentKey newAttachmentKey) Move attachment identified by oldAttachmentKey to be identified by newAttachmentKey and will be not reachable under oldAttachmentKey anymore.
io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit>	moveTemporaryToAttachment(TemporaryAttachmentId temporaryAttachmentId, AttachmentKey destinationKey) Moving temporary attachment created by StreamAttachmentStore.putTemporaryAttachment(java.io.InputStream, long) to real attachment.
io.atlassian.util.concurrent.Promise<Attachment>	putAttachment(Attachment metadata, File source) Store attachment data for a given attachment.
io.atlassian.util.concurrent.Promise<Attachment>	putAttachment(Attachment metadata, InputStream source) Store attachment data for a given attachment.
io.atlassian.util.concurrent.Promise<StoreAttachmentResult>	putAttachment(StoreAttachmentBean storeAttachmentBean) Store attachment data for a given attachment.
io.atlassian.util.concurrent.Promise<TemporaryAttachmentId>	putTemporaryAttachment(InputStream inputStream, long size) Creates temporaryAttachment in store which can be later moved to attachment via StreamAttachmentStore.moveTemporaryToAttachment(TemporaryAttachmentId, AttachmentKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

BackwardCompatibleAttachmentStore

public BackwardCompatibleAttachmentStore(@Nonnull
                                         AttachmentDirectoryAccessor directoryAccessor,
                                         @Nonnull
                                         ThumbnailAccessor thumbnailAccessor,
                                         @Nonnull
                                         StoreAttachmentBeanMapper storeAttachmentBeanMapper,
                                         @Nonnull
                                         FileSystemAttachmentStore fileSystemAttachmentStore,
                                         @Nonnull
                                         AttachmentKeyMapper attachmentKeyMapper,
                                         @Nonnull
                                         ProjectManager projectManager)

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 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(String issueKey)

Specified by:

getAttachmentDirectory in interface AttachmentStore

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

Returns:

the issue's attachment directory

getTemporaryAttachmentDirectory

public File getTemporaryAttachmentDirectory()

Specified by:

getTemporaryAttachmentDirectory in interface AttachmentStore

getAttachmentDirectory

public File getAttachmentDirectory(Issue issue)

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

Returns:

The issue's attachment directory.

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 of the path-joinery magic to make future refactoring easier if we ever decide to move away from attachment-base/project-key/issue-ket

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

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.

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 look up logic for the various possible filenames an attachment can have.

In practice, this is just used during Project Import

Specified by:

getAttachmentFile in interface AttachmentStore

Parameters:

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

http://jira.atlassian.com/browse/JRA-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.

http://jira.atlassian.com/browse/JRA-23311

Specified by:

getLegacyThumbnailFile in interface AttachmentStore

Parameters:

attachment - the attachment in play

Returns:

the full legacy thumbnail file name

getAttachmentFile

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

Description copied from interface: AttachmentStore

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

Specified by:

getAttachmentFile in interface AttachmentStore

Parameters:

issue - the issue the attachment belongs to.

attachment - the attachment.

Returns:

the file.

Throws:

DataAccessException - on failure getting required attachment info.

getAttachmentFile

public File getAttachmentFile(Attachment attachment)
                       throws DataAccessException

Description copied from interface: AttachmentStore

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.

Specified by:

getAttachmentFile in interface AttachmentStore

Parameters:

attachment - the attachment.

Returns:

the file.

Throws:

DataAccessException - on failure getting required attachment info.

putAttachment

public io.atlassian.util.concurrent.Promise<Attachment> putAttachment(Attachment metadata,
                                                                      InputStream source)

Description copied from interface: AttachmentStore

Store attachment data for a given attachment.

Specified by:

putAttachment in interface AttachmentStore

Parameters:

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

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

public io.atlassian.util.concurrent.Promise<Attachment> putAttachment(Attachment metadata,
                                                                      File source)

Description copied from interface: AttachmentStore

Store attachment data for a given attachment.

Specified by:

putAttachment in interface AttachmentStore

Parameters:

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

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

putAttachment

public io.atlassian.util.concurrent.Promise<StoreAttachmentResult> putAttachment(StoreAttachmentBean storeAttachmentBean)

Description copied from interface: StreamAttachmentStore

Store attachment data for a given attachment.

Specified by:

putAttachment in interface StreamAttachmentStore

Parameters:

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

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.

getAttachment

public <A> io.atlassian.util.concurrent.Promise<A> getAttachment(AttachmentKey attachmentKey,
                                                                 java.util.function.Function<InputStream,A> inputStreamProcessor)

Description copied from interface: StreamAttachmentStore

Retrieve data for a given attachment.

Specified by:

getAttachment in interface StreamAttachmentStore

Type Parameters:

A - The class that the inputStreamProcessor returns when run.

Parameters:

attachmentKey - The key of attachment used to identify 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.

getAttachmentData

public <A> io.atlassian.util.concurrent.Promise<A> getAttachmentData(AttachmentKey attachmentKey,
                                                                     java.util.function.Function<AttachmentGetData,A> attachmentGetDataProcessor)

Description copied from interface: StreamAttachmentStore

Retrieve data for a given attachment. Provides more information to consumer than (@link StreamAttachmentStore#getAttachment)

Specified by:

getAttachmentData in interface StreamAttachmentStore

Type Parameters:

A - The class that the attachmentGetDataProcessor returns when run.

Parameters:

attachmentKey - The key of attachment used to identify attachment data

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

moveAttachment

public io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit> moveAttachment(AttachmentKey oldAttachmentKey,
                                                                                    AttachmentKey newAttachmentKey)

Description copied from interface: StreamAttachmentStore

Move attachment identified by oldAttachmentKey to be identified by newAttachmentKey and will be not reachable under oldAttachmentKey anymore.

Specified by:

moveAttachment in interface StreamAttachmentStore

Parameters:

oldAttachmentKey - the old AttachmentKey

newAttachmentKey - the new AttachmentKey

copyAttachment

public io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit> copyAttachment(AttachmentKey sourceAttachmentKey,
                                                                                    AttachmentKey newAttachmentKey)

Description copied from interface: StreamAttachmentStore

Copies attachment identified by oldAttachmentKey to be identified also by newAttachmentKey.

Specified by:

copyAttachment in interface StreamAttachmentStore

Parameters:

sourceAttachmentKey - attachmentKey of existing attachment which should be copied

newAttachmentKey - attachmentKey under which copied

deleteAttachment

public io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit> deleteAttachment(AttachmentKey attachmentKey)

Description copied from interface: StreamAttachmentStore

Delete the attachment identified by provided attachmentKey.

Specified by:

deleteAttachment in interface StreamAttachmentStore

Returns:

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

putTemporaryAttachment

public io.atlassian.util.concurrent.Promise<TemporaryAttachmentId> putTemporaryAttachment(InputStream inputStream,
                                                                                          long size)

Description copied from interface: StreamAttachmentStore

Creates temporaryAttachment in store which can be later moved to attachment via StreamAttachmentStore.moveTemporaryToAttachment(TemporaryAttachmentId, AttachmentKey)

Specified by:

putTemporaryAttachment in interface StreamAttachmentStore

Parameters:

inputStream - stream to temporary attachment data

size - the size of provided stream

Returns:

returns promise to temporaryAttachmentId

moveTemporaryToAttachment

public io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit> moveTemporaryToAttachment(TemporaryAttachmentId temporaryAttachmentId,
                                                                                               AttachmentKey destinationKey)

Description copied from interface: StreamAttachmentStore

Moving temporary attachment created by StreamAttachmentStore.putTemporaryAttachment(java.io.InputStream, long) to real attachment.

Specified by:

moveTemporaryToAttachment in interface StreamAttachmentStore

Parameters:

temporaryAttachmentId - id of temporary attachment, returned by StreamAttachmentStore.putTemporaryAttachment(java.io.InputStream, long)

destinationKey - destination key of under which attachment will be identified

deleteTemporaryAttachment

public io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit> deleteTemporaryAttachment(TemporaryAttachmentId temporaryAttachmentId)

Description copied from interface: StreamAttachmentStore

Deletes temporary attachment created previously by StreamAttachmentStore.putTemporaryAttachment(java.io.InputStream, long).

Specified by:

deleteTemporaryAttachment in interface StreamAttachmentStore

Parameters:

temporaryAttachmentId - id of temporary attachment

getTemporaryAttachment

public <A> io.atlassian.util.concurrent.Promise<A> getTemporaryAttachment(TemporaryAttachmentId temporaryAttachmentId,
                                                                          java.util.function.Function<InputStream,A> inputStreamProcessor)

Description copied from interface: StreamAttachmentStore

Retrieve data for temporary attachment.

Specified by:

getTemporaryAttachment in interface StreamAttachmentStore

Type Parameters:

A - The class that the inputStreamProcessor returns when run.

Parameters:

temporaryAttachmentId - The id of temporary attachment

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.

exists

public io.atlassian.util.concurrent.Promise<Boolean> exists(AttachmentKey attachmentKey)

Description copied from interface: StreamAttachmentStore

Checks if attachment exists.

Specified by:

exists in interface StreamAttachmentStore

Parameters:

attachmentKey - key of attachment to check for existence

Returns:

a Promise to boolean result, true if attachment exists and false otherwise

getAttachment

public <A> io.atlassian.util.concurrent.Promise<A> getAttachment(Attachment metaData,
                                                                 java.util.function.Function<InputStream,A> inputStreamProcessor)

Description copied from interface: AttachmentStore

Retrieve data for a given attachment.

Specified by:

getAttachment in interface AttachmentStore

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

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

Description copied from interface: AttachmentStore

Moves an attachment from its current issue under a new one

Specified by:

move in interface AttachmentStore

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.

deleteAttachment

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

Description copied from interface: AttachmentStore

Delete the specified attachment.

Specified by:

deleteAttachment in interface AttachmentStore

Returns:

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

deleteAttachmentContainerForIssue

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

Description copied from interface: AttachmentStore

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

Specified by:

deleteAttachmentContainerForIssue in interface AttachmentStore

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
public io.atlassian.util.concurrent.Promise<Attachment> copy(@Nonnull
                                                                      Attachment originalAttachment,
                                                                      @Nonnull
                                                                      Attachment metaData,
                                                                      @Nonnull
                                                                      String newIssueKey)

Description copied from interface: AttachmentStore

Copy an attachment to another issue.

Specified by:

copy in interface AttachmentStore

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.

errors

@Nonnull
public io.atlassian.fugue.Option<ErrorCollection> errors()

Description copied from interface: AttachmentStore

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

Specified by:

errors in interface AttachmentHealth

Specified by:

errors in interface AttachmentStore

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.