com.atlassian.jira.issue.thumbnail

Class DefaultThumbnailManager

java.lang.Object

com.atlassian.jira.issue.thumbnail.DefaultThumbnailManager

All Implemented Interfaces:

ThumbnailManager

public class DefaultThumbnailManager
extends Object
implements ThumbnailManager

ThumbnailManager is a utility used to create and retrieve thumbnails for attachments.

Field Summary

Fields inherited from interface com.atlassian.jira.issue.thumbnail.ThumbnailManager

MIME_TYPE

Constructor Summary

Constructors

Constructor and Description
DefaultThumbnailManager(ThumbnailConfiguration thumbnailConfiguration, AttachmentManager attachmentManager, MimeManager mimeManager, VelocityRequestContextFactory velocityRequestContextFactory, AttachmentStore attachmentStore, ThumbnailAccessor thumbnailAccessor, ApplicationProperties applicationProperties)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkToolkit() Checks whether there is an "Abstract Window Toolkit" (AWT Toolkit) available.
void	deleteThumbnailForAttachment(Issue issue, Attachment attachment) Deletes the generated thumbnail for an attachment, if exists.
void	deleteThumbnailsForIssue(Issue issue) Deletes the generated thumbnails for the attachments of an issue.
com.atlassian.core.util.thumbnail.Thumbnail	getThumbnail(Attachment attachment) Returns the Thumbnail that corresponds to an Attachment, or null if the given attachment is not an image.
com.atlassian.core.util.thumbnail.Thumbnail	getThumbnail(Issue issue, Attachment attachment) Returns the Thumbnail that corresponds to an Attachment, or null if the given attachment is not an image.
Collection<com.atlassian.core.util.thumbnail.Thumbnail>	getThumbnails(Issue issue, com.atlassian.crowd.embedded.api.User user) Retrieves Thumbnails for an Issue
boolean	isThumbnailable(Attachment attachment) Indicates whether JIRA can generate a thumbnail for the given attachment.
boolean	isThumbnailable(Issue issue, Attachment attachment) Indicates whether JIRA can generate a thumbnail for the given attachment.
<T> T	streamThumbnailContent(Attachment attachment, InputStreamConsumer<T> consumer) Get binary content of the thumbnail
ThumbnailedImage	toThumbnailedImage(com.atlassian.core.util.thumbnail.Thumbnail thumbnail) Converts a Thumbnail into an ThumbnailedImage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultThumbnailManager

public DefaultThumbnailManager(ThumbnailConfiguration thumbnailConfiguration,
                       AttachmentManager attachmentManager,
                       MimeManager mimeManager,
                       VelocityRequestContextFactory velocityRequestContextFactory,
                       AttachmentStore attachmentStore,
                       ThumbnailAccessor thumbnailAccessor,
                       ApplicationProperties applicationProperties)

Method Detail

getThumbnails

public Collection<com.atlassian.core.util.thumbnail.Thumbnail> getThumbnails(Issue issue,
                                                                    com.atlassian.crowd.embedded.api.User user)

Description copied from interface: ThumbnailManager

Retrieves Thumbnails for an Issue

Specified by:

getThumbnails in interface ThumbnailManager

Parameters:

issue - the issue to get the thumnails for.

user - the user on whose behalf the request is made.

Returns:

the thumbnails.

See Also:

ThumbnailManager.toThumbnailedImage(com.atlassian.core.util.thumbnail.Thumbnail)

isThumbnailable

public boolean isThumbnailable(Issue issue,
                      Attachment attachment)

Description copied from interface: ThumbnailManager

Indicates whether JIRA can generate a thumbnail for the given attachment. This method may perform better than ThumbnailManager.isThumbnailable(com.atlassian.jira.issue.attachment.Attachment) because it doesn't need to look up the issue.

Specified by:

isThumbnailable in interface ThumbnailManager

Parameters:

issue - the issue to which the attachment relates (if null, this method will look it up)

attachment - the attachment (required)

Returns:

see above

See Also:

ThumbnailManager.isThumbnailable(com.atlassian.jira.issue.attachment.Attachment)

isThumbnailable

public boolean isThumbnailable(Attachment attachment)

Description copied from interface: ThumbnailManager

Indicates whether JIRA can generate a thumbnail for the given attachment.

Specified by:

isThumbnailable in interface ThumbnailManager

Parameters:

attachment - the attachment (required)

Returns:

see above

See Also:

ThumbnailManager.isThumbnailable(com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.attachment.Attachment)

getThumbnail

public com.atlassian.core.util.thumbnail.Thumbnail getThumbnail(Attachment attachment)

Description copied from interface: ThumbnailManager

Returns the Thumbnail that corresponds to an Attachment, or null if the given attachment is not an image.

Specified by:

getThumbnail in interface ThumbnailManager

Parameters:

attachment - an Attachment

Returns:

returns a Thumbnail, or null

See Also:

ThumbnailManager.toThumbnailedImage(com.atlassian.core.util.thumbnail.Thumbnail)

getThumbnail

public com.atlassian.core.util.thumbnail.Thumbnail getThumbnail(Issue issue,
                                                       Attachment attachment)

Description copied from interface: ThumbnailManager

Returns the Thumbnail that corresponds to an Attachment, or null if the given attachment is not an image.

Specified by:

getThumbnail in interface ThumbnailManager

Parameters:

issue - the issue for the attachment (passed in for performance reasons)

attachment - an Attachment

Returns:

returns a Thumbnail, or null

See Also:

ThumbnailManager.toThumbnailedImage(com.atlassian.core.util.thumbnail.Thumbnail)

checkToolkit

public boolean checkToolkit()

Description copied from interface: ThumbnailManager

Checks whether there is an "Abstract Window Toolkit" (AWT Toolkit) available.

Specified by:

checkToolkit in interface ThumbnailManager

Returns:

true if one is available

toThumbnailedImage

public ThumbnailedImage toThumbnailedImage(@Nullable
                                  com.atlassian.core.util.thumbnail.Thumbnail thumbnail)

Description copied from interface: ThumbnailManager

Converts a Thumbnail into an ThumbnailedImage. The ThumbnailedImage is an analog of the atlassian-core Thumbnail but it contains JIRA-specific methods for getting the image URL, etc.

Specified by:

toThumbnailedImage in interface ThumbnailManager

Parameters:

thumbnail - a Thumbnail, or null

Returns:

an ImageThumbnail, or null

streamThumbnailContent

public <T> T streamThumbnailContent(Attachment attachment,
                           InputStreamConsumer<T> consumer)
                         throws IOException

Description copied from interface: ThumbnailManager

Get binary content of the thumbnail

Specified by:

streamThumbnailContent in interface ThumbnailManager

Type Parameters:

T - The class that the consumer returns when run.

Parameters:

attachment - an Attachment

consumer - function that consumes the thumbnail data.

Returns:

the result of the function after it consumed the thumbnail data.

Throws:

IOException - if something wrong happens while reading the thumbnail data.

deleteThumbnailForAttachment

public void deleteThumbnailForAttachment(@Nullable
                                Issue issue,
                                Attachment attachment)

Description copied from interface: ThumbnailManager

Deletes the generated thumbnail for an attachment, if exists.

Specified by:

deleteThumbnailForAttachment in interface ThumbnailManager

Parameters:

issue - the issue for the attachment (passed in for performance reasons)

attachment - an Attachment

deleteThumbnailsForIssue

public void deleteThumbnailsForIssue(@Nonnull
                            Issue issue)

Description copied from interface: ThumbnailManager

Deletes the generated thumbnails for the attachments of an issue.

Specified by:

deleteThumbnailsForIssue in interface ThumbnailManager

Parameters:

issue - the issue whose attachments' thumbnails will be deleted.