|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WebAttachmentManager
Manager for issue attachments.
AttachmentManager
Method Summary | |
---|---|
ChangeItemBean |
createAttachment(webwork.multipart.MultiPartRequestWrapper requestWrapper,
com.atlassian.crowd.embedded.api.User remoteUser,
org.ofbiz.core.entity.GenericValue issue,
String fileParamName,
Map<String,Object> attachmentProperties)
Deprecated. Use createAttachment(webwork.multipart.MultiPartRequestWrapper, com.atlassian.crowd.embedded.api.User, com.atlassian.jira.issue.Issue, String, java.util.Map) instead. Since v5.0. |
ChangeItemBean |
createAttachment(webwork.multipart.MultiPartRequestWrapper requestWrapper,
com.atlassian.crowd.embedded.api.User remoteUser,
Issue issue,
String fileParamName,
Map<String,Object> attachmentProperties)
Create an issue's attachment. |
TemporaryAttachment |
createTemporaryAttachment(InputStream stream,
String fileName,
String contentType,
long size,
Issue issue,
Project project)
Creates a temporary attachment on disk. |
TemporaryAttachment |
createTemporaryAttachment(webwork.multipart.MultiPartRequestWrapper requestWrapper,
String fileParamName,
Issue issue,
Project project)
Creates a temporary attachment on disk. |
boolean |
validateAttachmentIfExists(webwork.multipart.MultiPartRequestWrapper requestWrapper,
String fileParamName,
boolean required)
Determine whether an attachment exists and is valid (i.e. |
Method Detail |
---|
ChangeItemBean createAttachment(webwork.multipart.MultiPartRequestWrapper requestWrapper, com.atlassian.crowd.embedded.api.User remoteUser, Issue issue, String fileParamName, Map<String,Object> attachmentProperties) throws AttachmentException
requestWrapper
- eg. obtained from ServletActionContext.getMultiPartRequest()
remoteUser
- eg. from JiraWebActionSupport.getLoggedInUser()
issue
- Issue to associate attachment withfileParamName
- Name of form parameter specifying filename (in requestWrapper).attachmentProperties
- Arbitrary key:value properties to store with this attachment. Key is a String, value is an Object mappable to a PropertySet
.
Eg. {"attachment.copyright.licensed" -> Boolean.TRUE}
AttachmentException
ChangeItemBean createAttachment(webwork.multipart.MultiPartRequestWrapper requestWrapper, com.atlassian.crowd.embedded.api.User remoteUser, org.ofbiz.core.entity.GenericValue issue, String fileParamName, Map<String,Object> attachmentProperties) throws AttachmentException, org.ofbiz.core.entity.GenericEntityException
createAttachment(webwork.multipart.MultiPartRequestWrapper, com.atlassian.crowd.embedded.api.User, com.atlassian.jira.issue.Issue, String, java.util.Map)
instead. Since v5.0.
requestWrapper
- eg. obtained from ServletActionContext.getMultiPartRequest()
remoteUser
- eg. from JiraWebActionSupport.getLoggedInUser()
issue
- Issue to associate attachment withfileParamName
- Name of form parameter specifying filename (in requestWrapper).attachmentProperties
- Arbitrary key:value properties to store with this attachment. Key is a String, value is an Object mappable to a PropertySet
.
Eg. {"attachment.copyright.licensed" -> Boolean.TRUE}
AttachmentException
org.ofbiz.core.entity.GenericEntityException
TemporaryAttachment createTemporaryAttachment(webwork.multipart.MultiPartRequestWrapper requestWrapper, String fileParamName, Issue issue, Project project) throws AttachmentException
TemporaryAttachment
object
requestWrapper
- the wrapper containing getFile() and getFilesystemName() describing the attachmentfileParamName
- ame of form parameter specifying filename (in requestWrapper).issue
- The issue that this temporary attachment is for. Can be null when creating a new issueproject
- The project where the attachment is to be placed. This is used to do security checks when creating an issue and
there is no issue to run a check on. Will be ignored when issue is not null.
TemporaryAttachment
containing details about where the temp attachment was created
AttachmentException
- if there was an error saving the temporary attachment.TemporaryAttachment createTemporaryAttachment(InputStream stream, String fileName, String contentType, long size, Issue issue, Project project) throws AttachmentException
TemporaryAttachment
object
stream
- the input stream for the attachment.fileName
- the name of the attachment.contentType
- the content type of the passed stream.size
- the size of the passed stream.issue
- The issue that this temporary attachment is for. Can be null when creating a new issue.project
- The project where the attachment is to be placed. This is used to do security checks when creating an issue and
there is no issue to run a check on. Will be ignored when issue is not null.
TemporaryAttachment
containing details about where the temp attachment was created
AttachmentException
- if there was an error saving the temporary attachment.boolean validateAttachmentIfExists(webwork.multipart.MultiPartRequestWrapper requestWrapper, String fileParamName, boolean required) throws AttachmentException
requestWrapper
- the wrapper containing getFile() and getFilesystemName() describing the attachmentfileParamName
- the parameter in the wrapper to use to find attachment inforequired
- whether having an valid and existent attachment is mandatory
AttachmentException
- if the attachment is zero-length, contains invalid characters, or simply doesn't exist
when required
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |