com.atlassian.jira.issue.attachment

Interface StreamAttachmentStore

All Superinterfaces:

AttachmentHealth

All Known Subinterfaces:

FileBasedAttachmentStore, FileSystemAttachmentStore

All Known Implementing Classes:

BackwardCompatibleAttachmentStore, DefaultFileSystemAttachmentStore

@ParametersAreNonnullByDefault
public interface StreamAttachmentStore
extends AttachmentHealth

Stream based operations on attachments This interface contains subset of methods from AttachmentStore and is dedicated to replace it.

Since:

v6.4

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StreamAttachmentStore.Factory

Method Summary

Modifier and Type	Method and Description
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<io.atlassian.fugue.Unit>	deleteAttachment(AttachmentKey attachmentKey) Delete the attachment identified by provided attachmentKey.
io.atlassian.util.concurrent.Promise<io.atlassian.fugue.Unit>	deleteTemporaryAttachment(TemporaryAttachmentId temporaryAttachmentId) Deletes temporary attachment created previously by putTemporaryAttachment(java.io.InputStream, long).
io.atlassian.util.concurrent.Promise<Boolean>	exists(AttachmentKey attachmentKey) Checks if attachment exists.
<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.
<A> io.atlassian.util.concurrent.Promise<A>	getTemporaryAttachment(TemporaryAttachmentId temporaryAttachmentId, java.util.function.Function<InputStream,A> inputStreamProcessor) Retrieve data for temporary attachment.
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 putTemporaryAttachment(java.io.InputStream, long) to real 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 moveTemporaryToAttachment(TemporaryAttachmentId, AttachmentKey)

Methods inherited from interface com.atlassian.jira.issue.attachment.AttachmentHealth

errors

Method Detail

putAttachment

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

Store attachment data for a given attachment.

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

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

Retrieve data for a given attachment.

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

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

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

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

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.

Parameters:

oldAttachmentKey - the old AttachmentKey

newAttachmentKey - the new AttachmentKey

copyAttachment

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.

Parameters:

sourceAttachmentKey - attachmentKey of existing attachment which should be copied

newAttachmentKey - attachmentKey under which copied

deleteAttachment

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

Delete the attachment identified by provided attachmentKey.

Returns:

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

putTemporaryAttachment

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

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

Parameters:

inputStream - stream to temporary attachment data

size - the size of provided stream

Returns:

returns promise to temporaryAttachmentId

moveTemporaryToAttachment

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

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

Parameters:

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

destinationKey - destination key of under which attachment will be identified

deleteTemporaryAttachment

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

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

Parameters:

temporaryAttachmentId - id of temporary attachment

getTemporaryAttachment

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

Retrieve data for temporary attachment.

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

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

Checks if attachment exists.

Parameters:

attachmentKey - key of attachment to check for existence

Returns:

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