com.atlassian.jira.issue
Interface AttachmentManager

All Known Implementing Classes:

DefaultAttachmentManager

public interface AttachmentManager

Method Summary

ChangeItemBean	createAttachment(File file, String filename, String contentType, User remoteUser, org.ofbiz.core.entity.GenericValue issue)
ChangeItemBean	createAttachment(File file, String filename, String contentType, User remoteUser, org.ofbiz.core.entity.GenericValue issue, Map attachmentProperties, Date createdTime) Create an attachment both on disk, and in the database.
Attachment	createAttachment(org.ofbiz.core.entity.GenericValue issue, User author, String mimetype, String filename, Long filesize, Map attachmentProperties, Date createdTime) Create an attachment in the database.
void	deleteAttachment(Attachment attachment) Delete an attachment from the database and from disk
void	deleteAttachmentDirectory(org.ofbiz.core.entity.GenericValue issue) Delete the attachment directory from disk if the directory is empty
Attachment	getAttachment(Long id) Get a single attachment by its id
List	getAttachments(org.ofbiz.core.entity.GenericValue issue) Get a list of all attachments for a certain issue
List	getAttachments(Issue issue) Get a list of all attachments for a certain issue
boolean	isAttachable(User user, org.ofbiz.core.entity.GenericValue entity) Determine if this user can attach a file to this issue.
boolean	isAttachable(User user, org.ofbiz.core.entity.GenericValue entity, boolean issueCreation)

Method Detail

getAttachment

public Attachment getAttachment(Long id)
                         throws org.ofbiz.core.entity.GenericEntityException

Get a single attachment by its id

Throws:

org.ofbiz.core.entity.GenericEntityException

getAttachments

public List getAttachments(org.ofbiz.core.entity.GenericValue issue)
                    throws DataAccessException

Get a list of all attachments for a certain issue

Returns:

a list of Attachment objects

Throws:

DataAccessException

getAttachments

public List getAttachments(Issue issue)
                    throws DataAccessException

Get a list of all attachments for a certain issue

Returns:

a list of Attachment objects

Throws:

DataAccessException

createAttachment

public ChangeItemBean createAttachment(File file,
                                       String filename,
                                       String contentType,
                                       User remoteUser,
                                       org.ofbiz.core.entity.GenericValue issue,
                                       Map attachmentProperties,
                                       Date createdTime)
                                throws AttachmentException,
                                       org.ofbiz.core.entity.GenericEntityException

Create an attachment both on disk, and in the database.

Parameters:

file - A file on a locally accessible filesystem

filename - The desired filename for this attachment. This may be different to the filename on disk (for example with temp files used in file uploads)

contentType - The desired contentType. Implementations of this interface can choose to override this value as appropriate

remoteUser - The use who created this attachment

issue - The issue that this attachment is attached to

attachmentProperties - Attachment properties (a Map of String -> Object properties). These are optional, and are used to populate a PropertySet on the Attachment (Attachment.getProperties(). Pass null to set no properties

createdTime -

Throws:

AttachmentException

org.ofbiz.core.entity.GenericEntityException

createAttachment

public ChangeItemBean createAttachment(File file,
                                       String filename,
                                       String contentType,
                                       User remoteUser,
                                       org.ofbiz.core.entity.GenericValue issue)
                                throws AttachmentException,
                                       org.ofbiz.core.entity.GenericEntityException

Throws:

AttachmentException

org.ofbiz.core.entity.GenericEntityException

createAttachment

public Attachment createAttachment(org.ofbiz.core.entity.GenericValue issue,
                                   User author,
                                   String mimetype,
                                   String filename,
                                   Long filesize,
                                   Map attachmentProperties,
                                   Date createdTime)
                            throws org.ofbiz.core.entity.GenericEntityException

Create an attachment in the database. Note that this does not create it on disk, nor does it create a change item.

Parameters:

attachmentProperties - Attachment properties (a Map of String -> Object properties).

createdTime -

Throws:

org.ofbiz.core.entity.GenericEntityException

deleteAttachment

public void deleteAttachment(Attachment attachment)
                      throws org.ofbiz.core.entity.GenericEntityException,
                             RemoveException

Delete an attachment from the database and from disk

Throws:

RemoveException - if the attachment cannot be removed from the disk

org.ofbiz.core.entity.GenericEntityException

deleteAttachmentDirectory

public void deleteAttachmentDirectory(org.ofbiz.core.entity.GenericValue issue)
                               throws RemoveException,
                                      org.ofbiz.core.entity.GenericEntityException

Delete the attachment directory from disk if the directory is empty

Parameters:

issue - the attachment directory for the issue

Throws:

RemoveException - if the directory can not be removed or is not empty

org.ofbiz.core.entity.GenericEntityException

isAttachable

public boolean isAttachable(User user,
                            org.ofbiz.core.entity.GenericValue entity)

Determine if this user can attach a file to this issue. This method will return true if the user both has the permissions to attach the file, and attachments are enabled and working.

Parameters:

entity - Either a project or an Issue

isAttachable

public boolean isAttachable(User user,
                            org.ofbiz.core.entity.GenericValue entity,
                            boolean issueCreation)