com.atlassian.jira.issue.attachment.store

Class DefaultFileSystemAttachmentStore

java.lang.Object

com.atlassian.jira.issue.attachment.store.DefaultFileSystemAttachmentStore

All Implemented Interfaces:

AttachmentHealth, FileBasedAttachmentStore, FileSystemAttachmentStore, StreamAttachmentStore

@ParametersAreNonnullByDefault
public final class DefaultFileSystemAttachmentStore
extends Object
implements FileSystemAttachmentStore

Since:

v6.1

Nested Class Summary

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

StreamAttachmentStore.Factory

Constructor Summary

Constructors

Constructor and Description
DefaultFileSystemAttachmentStore(AttachmentDirectoryAccessor directoryAccessor, LocalTemporaryFileStore localTemporaryFileStore, ExecutorServiceWrapper managedExecutor, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Methods

Modifier and Type	Method and Description
com.atlassian.util.concurrent.Promise<com.atlassian.fugue.Unit>	copyAttachment(AttachmentKey sourceAttachmentKey, AttachmentKey newAttachmentKey) Copies attachment identified by oldAttachmentKey to be identified also by newAttachmentKey.
com.atlassian.util.concurrent.Promise<com.atlassian.fugue.Unit>	deleteAttachment(AttachmentKey attachmentKey) Delete the attachment identified by provided attachmentKey.
com.atlassian.util.concurrent.Promise<com.atlassian.fugue.Unit>	deleteAttachmentContainerForIssue(Issue issue) Delete the container for attachments for a given issue.
com.atlassian.util.concurrent.Promise<com.atlassian.fugue.Unit>	deleteTemporaryAttachment(TemporaryAttachmentId temporaryAttachmentId) Deletes temporary attachment created previously by StreamAttachmentStore.putTemporaryAttachment(java.io.InputStream, long).
com.atlassian.fugue.Option<ErrorCollection>	errors() Health status for this component.
com.atlassian.util.concurrent.Promise<Boolean>	exists(AttachmentKey attachmentKey) Checks if attachment exists.
<A> com.atlassian.util.concurrent.Promise<A>	getAttachment(AttachmentKey attachmentKey, com.atlassian.util.concurrent.Function<InputStream,A> inputStreamProcessor) Retrieve data for a given attachment.
<A> com.atlassian.util.concurrent.Promise<A>	getAttachmentData(AttachmentKey attachmentKey, com.atlassian.util.concurrent.Function<AttachmentGetData,A> attachmentGetDataProcessor) Retrieve data for a given attachment.
File	getAttachmentFile(AttachmentKey attachmentKey) Returns the physical File for the given attachment key.
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.
com.atlassian.util.concurrent.Promise<com.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.
com.atlassian.util.concurrent.Promise<com.atlassian.fugue.Unit>	moveTemporaryToAttachment(TemporaryAttachmentId temporaryAttachmentId, AttachmentKey destinationKey) Moving temporary attachment created by StreamAttachmentStore.putTemporaryAttachment(java.io.InputStream, long) to real attachment.
com.atlassian.util.concurrent.Promise<StoreAttachmentResult>	putAttachment(StoreAttachmentBean storeAttachmentBean) Store attachment data for a given attachment.
com.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

DefaultFileSystemAttachmentStore

public DefaultFileSystemAttachmentStore(AttachmentDirectoryAccessor directoryAccessor,
                                LocalTemporaryFileStore localTemporaryFileStore,
                                ExecutorServiceWrapper managedExecutor,
                                com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

getAttachmentFile

public File getAttachmentFile(AttachmentKey attachmentKey)
                       throws DataAccessException

Returns the physical File for the given attachment key.

Specified by:

getAttachmentFile in interface FileBasedAttachmentStore

Parameters:

attachmentKey - the key of attachment

Returns:

the file.

Throws:

DataAccessException - on failure getting required attachment info.

getAttachmentFile

public 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

Specified by:

getAttachmentFile in interface FileBasedAttachmentStore

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

@Nonnull
public com.atlassian.util.concurrent.Promise<StoreAttachmentResult> putAttachment(@Nonnull
                                                                                 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> com.atlassian.util.concurrent.Promise<A> getAttachment(AttachmentKey attachmentKey,
                                                         com.atlassian.util.concurrent.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> com.atlassian.util.concurrent.Promise<A> getAttachmentData(AttachmentKey attachmentKey,
                                                             com.atlassian.util.concurrent.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.

exists

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

deleteAttachment

public com.atlassian.util.concurrent.Promise<com.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.

deleteAttachmentContainerForIssue

public com.atlassian.util.concurrent.Promise<com.atlassian.fugue.Unit> deleteAttachmentContainerForIssue(Issue issue)

Description copied from interface: FileBasedAttachmentStore

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 FileBasedAttachmentStore

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.

moveAttachment

public com.atlassian.util.concurrent.Promise<com.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

errors

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

Description copied from interface: AttachmentHealth

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

Specified by:

errors in interface AttachmentHealth

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.

copyAttachment

public com.atlassian.util.concurrent.Promise<com.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

putTemporaryAttachment

public com.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 com.atlassian.util.concurrent.Promise<com.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 com.atlassian.util.concurrent.Promise<com.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