com.atlassian.jira.issue.managers

Class DefaultAttachmentIndexManager

java.lang.Object

com.atlassian.jira.issue.managers.DefaultAttachmentIndexManager

All Implemented Interfaces:

AttachmentIndexManager

public class DefaultAttachmentIndexManager
extends Object
implements AttachmentIndexManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultAttachmentIndexManager.TotalLengthPredicate JSONs are saved to the database by EntityProperty mechanism maximum length of whole index is EntityConstants.EXTREMELY_LONG_MAXIMUM_LENGTH.

Constructor Summary

Constructors

Constructor and Description
DefaultAttachmentIndexManager(com.atlassian.plugin.PluginAccessor pluginAccessor, StreamAttachmentStore attachmentStore, JsonEntityPropertyManager jsonEntityPropertyManager, IssuePropertyHelper entityPropertyHelper, InputStreamFunctionFactory inputStreamFunctionFactory, AttachmentKeyMapper attachmentKeyMapper)

Method Summary

Modifier and Type	Method and Description
io.atlassian.fugue.Option<AttachmentArchive>	getAttachmentContents(Attachment attachment, Issue issue, int maxEntries) Retrieves index of given attachment file.
boolean	isExpandable(Attachment attachment) Checks if provided attachment is currently expandable.
void	processAttachmentAndCreateIndex(File file, Attachment attachment, Issue issue) This methods generates the index of and archive file.
protected io.atlassian.fugue.Option<AttachmentArchive>	processAttachmentAndCreateIndex(File file, Attachment attachment, Issue issue, int maxEntries)
void	removeAttachmentIndex(Attachment attachment, Issue issue) Removes the index data of the specified attachment.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAttachmentIndexManager

public DefaultAttachmentIndexManager(com.atlassian.plugin.PluginAccessor pluginAccessor,
                                     StreamAttachmentStore attachmentStore,
                                     JsonEntityPropertyManager jsonEntityPropertyManager,
                                     IssuePropertyHelper entityPropertyHelper,
                                     InputStreamFunctionFactory inputStreamFunctionFactory,
                                     AttachmentKeyMapper attachmentKeyMapper)

Method Detail

processAttachmentAndCreateIndex

public void processAttachmentAndCreateIndex(@Nonnull
                                            File file,
                                            @Nonnull
                                            Attachment attachment,
                                            @Nonnull
                                            Issue issue)

Description copied from interface: AttachmentIndexManager

This methods generates the index of and archive file. It looks up for plugins that can handle processing file with certain extension. Then it stores given attachment index to database.

Note that after processing file other than archive its index will still be saved as an empty JSON array ("[]") in order to store information that this file was already processed so that getAttachmentContents will not call this method unnecessarily on each issue display.

Specified by:

processAttachmentAndCreateIndex in interface AttachmentIndexManager

Parameters:

file - attachment.

attachment - for which index provided.

issue - to which attachment belongs.

processAttachmentAndCreateIndex

protected io.atlassian.fugue.Option<AttachmentArchive> processAttachmentAndCreateIndex(@Nonnull
                                                                                       File file,
                                                                                       @Nonnull
                                                                                       Attachment attachment,
                                                                                       @Nonnull
                                                                                       Issue issue,
                                                                                       int maxEntries)

getAttachmentContents

public io.atlassian.fugue.Option<AttachmentArchive> getAttachmentContents(@Nonnull
                                                                          Attachment attachment,
                                                                          @Nonnull
                                                                          Issue issue,
                                                                          int maxEntries)

Description copied from interface: AttachmentIndexManager

Retrieves index of given attachment file. If the index does not exist tries to obtain Attachment file from AttachmentStore and if obtained saves its index to the database.

Specified by:

getAttachmentContents in interface AttachmentIndexManager

Parameters:

attachment - for which index will be retrieved.

issue - to which attachment belongs.

maxEntries - maximum number of entries that should be returned in

Returns:

Option.none if no index was found or contents that were retrieved from database.

removeAttachmentIndex

public void removeAttachmentIndex(@Nonnull
                                  Attachment attachment,
                                  @Nonnull
                                  Issue issue)

Description copied from interface: AttachmentIndexManager

Removes the index data of the specified attachment.

Specified by:

removeAttachmentIndex in interface AttachmentIndexManager

Parameters:

attachment - for which index file will be removed.

issue - to which attachment belongs.

isExpandable

public boolean isExpandable(Attachment attachment)

Description copied from interface: AttachmentIndexManager

Checks if provided attachment is currently expandable.

Specified by:

isExpandable in interface AttachmentIndexManager

Parameters:

attachment - to be tested.

Returns:

true only if attachment can be expanded by JIRA.