Package com.atlassian.jira.issue.attachment

Class DefaultStreamAttachmentStore

java.lang.Object

com.atlassian.jira.issue.attachment.DefaultStreamAttachmentStore

All Implemented Interfaces:

StreamAttachmentStore

@ParametersAreNonnullByDefault
public class DefaultStreamAttachmentStore
extends Object
implements StreamAttachmentStore

Default implementation of the StreamAttachmentStore interface, the intention behind this class is that it will work with any FileStore implementation, so do not add filesystem specific code. There are some FS-specific code paths that will be removed when S3 support is added for Jira 10.

Since:

v9.7

Constructor Summary

Constructors

Constructor	Description
DefaultStreamAttachmentStore(AttachmentConfigStore attachmentConfigStore, AttachmentKeyMapper attachmentKeyMapper, com.atlassian.event.api.EventPublisher eventPublisher, ExecutorServiceWrapper managedExecutor, LocalTemporaryFileStore localTemporaryFileStore, ProjectManager projectManager, StreamAttachmentStoreStats streamAttachmentStoreStats)

Method Summary

Modifier and Type	Method	Description
io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit>	copyAttachment(AttachmentKey sourceAttachmentKey, AttachmentKey newAttachmentKey)	Copies the attachment identified by oldAttachmentKey to be identified also by newAttachmentKey.
io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit>	deleteAttachment(AttachmentKey attachmentKey)	Deletes the specified attachment.
io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit>	deleteAttachmentContainerForIssue(Issue issue)	Delete the container for attachments for a given issue if it exists.
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.util.concurrent.Promise<Boolean>	exists(AttachmentKey attachmentKey)	Indicates whether the specified attachment exists.
<A> io.atlassian.util.concurrent.Promise<A>	getAttachment(AttachmentKey attachmentKey, Function<InputStream,A> inputStreamProcessor)	Retrieves the specified attachment.
<A> io.atlassian.util.concurrent.Promise<A>	getAttachmentData(AttachmentKey attachmentKey, Function<AttachmentGetData,A> attachmentGetDataProcessor)	Retrieves the specified attachment.
com.atlassian.dc.filestore.api.FileStore.Path	getAttachmentPath(com.atlassian.dc.filestore.api.FileStore.Path rootAttachmentPath, String projectKey, String issueKey)	Get the attachment path for the given attachment base directory, project key, and issue key.
com.atlassian.dc.filestore.api.FileStore.Path	getAttachmentPath(Attachment attachment)	Returns the file for the given attachment.
com.atlassian.dc.filestore.api.FileStore.Path	getAttachmentPath(AttachmentKey attachmentKey)	Returns the physical File for the given attachment key.
Optional<com.atlassian.dc.filestore.api.FileStore.Path>	getAttachmentPathForIssue(Issue issue)	Returns the path of the attachments for the given issue.
<A> io.atlassian.util.concurrent.Promise<A>	getTemporaryAttachment(TemporaryAttachmentId temporaryAttachmentId, Function<InputStream,A> inputStreamProcessor)	Retrieve data for temporary attachment.
io.atlassian.util.concurrent.Promise<Void>	move(Attachment attachment, String newIssueKey)	Moves an attachment from its current issue to the one with the given key.
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<StoreAttachmentResult>	putAttachment(StoreAttachmentBean storeAttachmentBean)	Stores the 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 Details

DefaultStreamAttachmentStore

public DefaultStreamAttachmentStore(AttachmentConfigStore attachmentConfigStore,
 AttachmentKeyMapper attachmentKeyMapper,
 com.atlassian.event.api.EventPublisher eventPublisher,
 ExecutorServiceWrapper managedExecutor,
 LocalTemporaryFileStore localTemporaryFileStore,
 ProjectManager projectManager,
 StreamAttachmentStoreStats streamAttachmentStoreStats)

Method Details

putAttachment

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

Description copied from interface: StreamAttachmentStore

Stores the 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,
 Function<InputStream,A> inputStreamProcessor)

Description copied from interface: StreamAttachmentStore

Retrieves the specified 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,
 Function<AttachmentGetData,A> attachmentGetDataProcessor)

Description copied from interface: StreamAttachmentStore

Retrieves the specified attachment. Provides more information to the consumer than StreamAttachmentStore.getAttachment(AttachmentKey, Function).

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.

getAttachmentPath

public com.atlassian.dc.filestore.api.FileStore.Path getAttachmentPath(Attachment attachment)

Description copied from interface: StreamAttachmentStore

Returns the file for the given attachment.

Specified by:

getAttachmentPath in interface StreamAttachmentStore

Parameters:

attachment - the attachment for which to retrieve the file.

Returns:

the filestore path

getAttachmentPath

public com.atlassian.dc.filestore.api.FileStore.Path getAttachmentPath(@Nullable
 AttachmentKey attachmentKey)
                                                                throws AttachmentsDisabledException,
AttachmentCleanupException

Returns the physical File for the given attachment key.

Specified by:

getAttachmentPath in interface StreamAttachmentStore

Parameters:

attachmentKey - the key of attachment

Returns:

the file.

Throws:

AttachmentsDisabledException - if attachments are disabled.

AttachmentCleanupException - if there is an error getting the attachment path.

deleteAttachmentContainerForIssue

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

Description copied from interface: StreamAttachmentStore

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

Specified by:

deleteAttachmentContainerForIssue in interface StreamAttachmentStore

Parameters:

issue - The issue to delete attachments for.

Returns:

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

getAttachmentPathForIssue

public Optional<com.atlassian.dc.filestore.api.FileStore.Path> getAttachmentPathForIssue(Issue issue)

Description copied from interface: StreamAttachmentStore

Returns the path of the attachments for the given issue.

Specified by:

getAttachmentPathForIssue in interface StreamAttachmentStore

Parameters:

issue - the issue whose attachment directory you want

Returns:

The issue's attachment path if a base attachment path exists and the issue has a project. Otherwise, an empty optional.

getAttachmentPath

public com.atlassian.dc.filestore.api.FileStore.Path getAttachmentPath(com.atlassian.dc.filestore.api.FileStore.Path rootAttachmentPath,
 String projectKey,
 String issueKey)

Description copied from interface: StreamAttachmentStore

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

Specified by:

getAttachmentPath in interface StreamAttachmentStore

Parameters:

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

move

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

Description copied from interface: StreamAttachmentStore

Moves an attachment from its current issue to the one with the given key.

Specified by:

move in interface StreamAttachmentStore

Parameters:

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

copyAttachment

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

Description copied from interface: StreamAttachmentStore

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

Returns:

a promise of unit

deleteAttachment

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

Description copied from interface: StreamAttachmentStore

Deletes the specified attachment.

Specified by:

deleteAttachment in interface StreamAttachmentStore

Parameters:

attachmentKey - the attachment key

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

Returns:

a promise of unit

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

Returns:

a promise of unit

getTemporaryAttachment

public <A> io.atlassian.util.concurrent.Promise<A> getTemporaryAttachment(TemporaryAttachmentId temporaryAttachmentId,
 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

Indicates whether the specified 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