com.atlassian.jira.util

Class AttachmentUtils

java.lang.Object

com.atlassian.jira.util.AttachmentUtils

Deprecated.

Use AttachmentManager only. Since v6.1

@Deprecated
public class AttachmentUtils
extends Object

Static utilities for working with the attachment files and their directories.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AttachmentUtils.AttachmentAdapter Deprecated. Use AttachmentStore with AttachmentStore.AttachmentAdapter. Since v6.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	THUMBS_SUBDIR Deprecated. Infix for generated thumbnail images.

Constructor Summary

Constructors

Constructor and Description
AttachmentUtils() Deprecated.

Method Summary

Modifier and Type	Method and Description
static void	checkValidAttachmentDirectory(Issue issue) Deprecated. Checks that the Attachment directory of the given issue is right to go - writable, accessible etc.
static void	checkValidTemporaryAttachmentDirectory() Deprecated.
static File	getAttachmentDirectory(Issue issue) Deprecated. Returns the physical directory of the attachments for the given issue.
static File	getAttachmentDirectory(Issue issue, boolean createDirectory) Deprecated. Returns the physical directory of the attachments for the given issue.
static File	getAttachmentDirectory(String attachmentDirectory, String projectKey, String issueKey) Deprecated. Get the attachment directory for the given attachment base directory, project key, and issue key.
static File	getAttachmentFile(Attachment attachment) Deprecated. Returns the physical File for the given Attachment.
static File	getAttachmentFile(AttachmentUtils.AttachmentAdapter attachment, File attachmentDir) Deprecated. This is intended for cases where you want more control over where the attachment actually lives and you just want something to handle the look up logic for the various possible filenames an attachment can have.
static File	getAttachmentFile(Issue issue, Attachment attachment) Deprecated. Returns the physical File for the given Attachment.
protected static AttachmentStore	getAttachmentStore() Deprecated.
static File	getLegacyThumbnailFile(Attachment attachment) Deprecated. Returns the old legacy file name for thumbnails
static File	getTemporaryAttachmentDirectory() Deprecated.
static File	getThumbnailDirectory(Issue issue) Deprecated. Returns the physical directory of the thumbnails for the given issue, creating if necessary.
static File	getThumbnailFile(Attachment attachment) Deprecated. Just like the attachments themselves, thumbnails can succumb to file system encoding problems.
static File	getThumbnailFile(Issue issue, Attachment attachment) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

THUMBS_SUBDIR

public static final String THUMBS_SUBDIR

Deprecated.

Infix for generated thumbnail images.

See Also:

Constant Field Values

Constructor Detail

AttachmentUtils

public AttachmentUtils()

Deprecated.

Method Detail

getThumbnailDirectory

public static File getThumbnailDirectory(Issue issue)

Deprecated.

Returns the physical directory of the thumbnails for the given issue, creating if necessary.

Parameters:

issue - the issue whose thumbnail directory you want.

Returns:

The issue's thumbnail directory.

getAttachmentDirectory

public static File getAttachmentDirectory(Issue issue)

Deprecated.

Returns the physical directory of the attachments for the given issue. This will create it if necessary.

Parameters:

issue - the issue whose attachment directory you want.

Returns:

The issue's attachment directory.

getAttachmentDirectory

public static File getAttachmentDirectory(Issue issue,
                                          boolean createDirectory)

Deprecated.

Returns the physical directory of the attachments for the given issue. This will create it if necessary.

Parameters:

issue - the issue whose attachment directory you want.

createDirectory - If true, and the directory does not currently exist, then the directory is created.

Returns:

The issue's attachment directory.

getAttachmentStore

protected static AttachmentStore getAttachmentStore()

Deprecated.

getTemporaryAttachmentDirectory

public static File getTemporaryAttachmentDirectory()

Deprecated.

getAttachmentDirectory

public static File getAttachmentDirectory(String attachmentDirectory,
                                          String projectKey,
                                          String issueKey)

Deprecated.

Get the attachment directory for the given attachment base directory, project key, and issue key.

The idea is to encapsulate all of the path-joinery magic to make future refactoring easier if we ever decide to move away from attachment-base/project-key/issue-ket

Parameters:

attachmentDirectory - base of attachments

projectKey - the project key the issue belongs to

issueKey - the issue key for the issue

Returns:

the directory attachments for this issue live in

getAttachmentFile

public static File getAttachmentFile(Issue issue,
                                     Attachment attachment)
                              throws DataAccessException

Deprecated.

Returns the physical File for the given Attachment. This method performs better as it does not need to look up the issue object.

Parameters:

issue - the issue the attachment belongs to.

attachment - the attachment.

Returns:

the file.

Throws:

DataAccessException - on failure getting required attachment info.

getAttachmentFile

public static File getAttachmentFile(Attachment attachment)
                              throws DataAccessException

Deprecated.

Returns the physical File for the given Attachment. If you are calling this on multiple attachments for the same issue, consider using the overriden method that passes in the issue. Else, this goes to the database for each call.

Parameters:

attachment - the attachment.

Returns:

the file.

Throws:

DataAccessException - on failure getting required attachment info.

getAttachmentFile

public static File getAttachmentFile(AttachmentUtils.AttachmentAdapter attachment,
                                     File attachmentDir)

Deprecated.

This is intended for cases where you want more control over where the attachment actually lives and you just want something to handle the look up logic for the various possible filenames an attachment can have.

In practice, this is just used during Project Import

Parameters:

attachment - it's not an attachment but it acts like one for our purposes.

attachmentDir - the directory the attachments live in. This is different that the system-wide attachment directory. i.e. this would "attachments/MKY/MKY-1" and not just "attachments"

Returns:

the actual attachment

getThumbnailFile

public static File getThumbnailFile(Attachment attachment)

Deprecated.

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 can't 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 attacment in play

Returns:

the full thumbnail file name

getThumbnailFile

public static File getThumbnailFile(Issue issue,
                                    Attachment attachment)

Deprecated.

getLegacyThumbnailFile

public static File getLegacyThumbnailFile(Attachment attachment)

Deprecated.

Returns the old legacy file name for thumbnails

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

Parameters:

attachment - the attacment in play

Returns:

the full legacy thumbnail file name

checkValidAttachmentDirectory

public static void checkValidAttachmentDirectory(Issue issue)
                                          throws AttachmentException

Deprecated.

Checks that the Attachment directory of the given issue is right to go - writable, accessible etc. Will create it if necessary.

Parameters:

issue - the issue whose attachment directory to check.

Throws:

AttachmentException - if the directory is not writable or missing and cannot be created.

checkValidTemporaryAttachmentDirectory

public static void checkValidTemporaryAttachmentDirectory()
                                                   throws AttachmentException

Deprecated.

Throws:

AttachmentException