@ParametersAreNonnullByDefault public interface

StreamAttachmentStore

implements AttachmentHealth
com.atlassian.jira.issue.attachment.StreamAttachmentStore
Known Indirect Subclasses

Class Overview

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

Summary

Nested Classes
interface StreamAttachmentStore.Factory  
Public Methods
Promise<Unit> copyAttachment(AttachmentKey sourceAttachmentKey, AttachmentKey newAttachmentKey)
Copies attachment identified by oldAttachmentKey to be identified also by newAttachmentKey.
Promise<Unit> deleteAttachment(AttachmentKey attachmentKey)
Delete the attachment identified by provided attachmentKey.
Promise<Unit> deleteTemporaryAttachment(TemporaryAttachmentId temporaryAttachmentId)
Deletes temporary attachment created previously by putTemporaryAttachment(java.io.InputStream, long).
Promise<Boolean> exists(AttachmentKey attachmentKey)
Checks if attachment exists.
<A> Promise<A> getAttachment(AttachmentKey attachmentKey, Function<InputStream, A> inputStreamProcessor)
Retrieve data for a given attachment.
<A> Promise<A> getAttachmentData(AttachmentKey attachmentKey, Function<AttachmentGetData, A> attachmentGetDataProcessor)
Retrieve data for a given attachment.
Promise<Unit> moveAttachment(AttachmentKey oldAttachmentKey, AttachmentKey newAttachmentKey)
Move attachment identified by oldAttachmentKey to be identified by newAttachmentKey and will be not reachable under oldAttachmentKey anymore.
Promise<Unit> moveTemporaryToAttachment(TemporaryAttachmentId temporaryAttachmentId, AttachmentKey destinationKey)
Moving temporary attachment created by putTemporaryAttachment(java.io.InputStream, long) to real attachment.
Promise<StoreAttachmentResult> putAttachment(StoreAttachmentBean storeAttachmentBean)
Store attachment data for a given attachment.
Promise<TemporaryAttachmentId> putTemporaryAttachment(InputStream inputStream, long size)
Creates temporaryAttachment in store which can be later moved to attachment via moveTemporaryToAttachment(TemporaryAttachmentId, AttachmentKey)
[Expand]
Inherited Methods
From interface com.atlassian.jira.issue.attachment.AttachmentHealth

Public Methods

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

public Promise<Unit> deleteAttachment (AttachmentKey attachmentKey)

Delete the attachment identified by provided attachmentKey.

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

public Promise<Unit> deleteTemporaryAttachment (TemporaryAttachmentId temporaryAttachmentId)

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

Parameters
temporaryAttachmentId id of temporary attachment

public Promise<Boolean> exists (AttachmentKey attachmentKey)

Checks if attachment exists.

Parameters
attachmentKey key of attachment to check for existence
Returns
  • a com.atlassian.util.concurrent.Promise to boolean result, true if attachment exists and false otherwise

public Promise<A> getAttachment (AttachmentKey attachmentKey, Function<InputStream, A> inputStreamProcessor)

Retrieve data for a given attachment.

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.

public Promise<A> getAttachmentData (AttachmentKey attachmentKey, Function<AttachmentGetData, A> attachmentGetDataProcessor)

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

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.

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

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

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

public 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