Package com.atlassian.jira.issue.attachment

Interface ThumbnailAccessor

All Known Implementing Classes:
DefaultThumbnailAccessor
@ParametersAreNonnullByDefault public interface ThumbnailAccessor

  • Method Summary

    Modifier and Type
    Method
    Description
    io.atlassian.util.concurrent.Promise<Void>
    deleteThumbnailDirectory(Issue issue)
    Deletes the thumbnail directory for a given issue, deleting its contents if necessary.
    com.atlassian.dc.filestore.api.FileStore.Path
    getThumbnailFilePath(Attachment attachment)
    Just like the attachments themselves, thumbnails can succumb to file system encoding problems.
    com.atlassian.dc.filestore.api.FileStore.Path
    getThumbnailFilePath(Issue issue, Attachment attachment)
    Returns the file path for the given attachment's thumbnail.

  • Method Details

    • getThumbnailFilePath

      @Nonnull com.atlassian.dc.filestore.api.FileStore.Path getThumbnailFilePath(Attachment attachment)
      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 cant do this for attachments but we can for thumbnails since they are ephemeral objects anyway.

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

      Parameters:
      attachment - the attachment for which to get the thumbnail file path
      Returns:
      a non-null file path (the file itself might not exist)
      See Also:

    • getThumbnailFilePath

      @Nonnull com.atlassian.dc.filestore.api.FileStore.Path getThumbnailFilePath(Issue issue, Attachment attachment)
      Returns the file path for the given attachment's thumbnail. This method performs better than getThumbnailFilePath(Attachment) if you already have the issue.
      Parameters:
      issue - the issue to which the attachment belongs
      attachment - the attachment for which to get the thumbnail file path
      Returns:
      a non-null file path (the file itself might not exist)
      See Also:

    • deleteThumbnailDirectory

      io.atlassian.util.concurrent.Promise<Void> deleteThumbnailDirectory(Issue issue)
      Deletes the thumbnail directory for a given issue, deleting its contents if necessary.
      Parameters:
      issue - The issue whose thumbnail path you want to delete.
      Returns:
      A promise that contains a AttachmentCleanupException if there was an error deleting the path.