com.atlassian.jira.issue

Interface AttachmentIndexManager

All Known Implementing Classes:

DefaultAttachmentIndexManager

public interface AttachmentIndexManager

Provides possibility to save cache contents of archive files to database.

Since:

v6.3

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.
void	removeAttachmentIndex(Attachment attachment, Issue issue) Removes the index data of the specified attachment.

Method Detail

processAttachmentAndCreateIndex

void processAttachmentAndCreateIndex(File file,
                                     Attachment attachment,
                                     Issue issue)

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.

Parameters:

file - attachment.

attachment - for which index provided.

issue - to which attachment belongs.

getAttachmentContents

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

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.

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

void removeAttachmentIndex(Attachment attachment,
                           Issue issue)

Removes the index data of the specified attachment.

Parameters:

attachment - for which index file will be removed.

issue - to which attachment belongs.

isExpandable

boolean isExpandable(Attachment attachment)

Checks if provided attachment is currently expandable.

Parameters:

attachment - to be tested.

Returns:

true only if attachment can be expanded by JIRA.