|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AttachmentManager
Manages all attachment related tasks in JIRA, which involves retrieving an attachment, creating an attachment and deleting an attachment.
Method Summary | |
---|---|
boolean |
attachmentsEnabled()
Determine if attachments have been enabled in JIRA and if the attachments directory exists. |
ChangeItemBean |
createAttachment(File file,
String filename,
String contentType,
User remoteUser,
org.ofbiz.core.entity.GenericValue issue)
Same as the createAttachment(java.io.File, String, String, com.opensymphony.user.User, org.ofbiz.core.entity.GenericValue, java.util.Map, java.util.Date) method, except it
submits no attachmentProperties and uses now() for the created time. |
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 |
isScreenshotAppletEnabled()
Determine if screenshot applet has been enabled in JIRA. |
boolean |
isScreenshotAppletSupportedByOS()
Determine if the screenshot applet is supported by the user's operating system. |
Method Detail |
---|
Attachment getAttachment(Long id) throws DataAccessException
DataAccessException
List getAttachments(org.ofbiz.core.entity.GenericValue issue) throws DataAccessException
Attachment
objects
DataAccessException
List getAttachments(Issue issue) throws DataAccessException
Attachment
objects
DataAccessException
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
file
- A file on a locally accessible filesystemfilename
- 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 appropriateremoteUser
- The use who created this attachmentissue
- The issue that this attachment is attached toattachmentProperties
- 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 propertiescreatedTime
-
AttachmentException
org.ofbiz.core.entity.GenericEntityException
ChangeItemBean createAttachment(File file, String filename, String contentType, User remoteUser, org.ofbiz.core.entity.GenericValue issue) throws AttachmentException, org.ofbiz.core.entity.GenericEntityException
createAttachment(java.io.File, String, String, com.opensymphony.user.User, org.ofbiz.core.entity.GenericValue, java.util.Map, java.util.Date)
method, except it
submits no attachmentProperties and uses now() for the created time.
file
- A file on a locally accessible filesystemfilename
- 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 appropriateremoteUser
- The use who created this attachmentissue
- The issue that this attachment is attached to
ChangeItemBean
with all the changes to the issue.
AttachmentException
org.ofbiz.core.entity.GenericEntityException
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
attachmentProperties
- Attachment properties (a Map of String -> Object properties).createdTime
-
org.ofbiz.core.entity.GenericEntityException
void deleteAttachment(Attachment attachment) throws RemoveException
RemoveException
- if the attachment cannot be removed from the diskvoid deleteAttachmentDirectory(org.ofbiz.core.entity.GenericValue issue) throws RemoveException, org.ofbiz.core.entity.GenericEntityException
issue
- the attachment directory for the issue
RemoveException
- if the directory can not be removed or is not empty
org.ofbiz.core.entity.GenericEntityException
boolean attachmentsEnabled()
boolean isScreenshotAppletEnabled()
boolean isScreenshotAppletSupportedByOS()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |