Package com.atlassian.jira.rest.util

Class AttachmentHelper

java.lang.Object

com.atlassian.jira.rest.util.AttachmentHelper

@Component
public class AttachmentHelper
extends Object

Since:

v5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AttachmentHelper.ValidationError
static class	AttachmentHelper.ValidationResult

Field Summary

Fields

Modifier and Type	Field	Description
static final List<com.atlassian.platform.security.file.DetectableFileType>	IMAGE_CONTENT_TYPES

Constructor Summary

Constructors

Constructor	Description
AttachmentHelper(XsrfInvocationChecker xsrfChecker, JiraAuthenticationContext jiraAuthenticationContext)

Method Summary

Modifier and Type	Method	Description
AttachmentHelper.ValidationResult	validate(jakarta.servlet.http.HttpServletRequest request, String filename, Long size)	Validates the uploaded image.
AttachmentHelper.ValidationResult	validateImage(jakarta.servlet.http.HttpServletRequest request, String filename, Long size)
AttachmentHelper.ValidationResult	validateImage(jakarta.servlet.http.HttpServletRequest request, String filename, Long size, String contentType)
AttachmentHelper.ValidationResult	validateImage(InputStream inputStream, String filename, Long size, String contentType)
List<AttachmentHelper.ValidationResult>	validateImageAfterUpload(File uploadedFile)

Methods inherited from class java.lang.Object

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

Field Details

IMAGE_CONTENT_TYPES

public static final List<com.atlassian.platform.security.file.DetectableFileType> IMAGE_CONTENT_TYPES

Constructor Details

AttachmentHelper

public AttachmentHelper(XsrfInvocationChecker xsrfChecker,
 JiraAuthenticationContext jiraAuthenticationContext)

Method Details

validate

public AttachmentHelper.ValidationResult validate(jakarta.servlet.http.HttpServletRequest request,
 String filename,
 @Nullable
 Long size)

Validates the uploaded image. Validation includes:

• XSRF token check
• Filename check (is it blank)
• Size is not valid (Either not supplied by the client or is 0)
• Filesize is above the max attachment size

Parameters:

request - where the image data is

filename - filename of image

size - size of image

Returns:

Validation result

validateImage

public AttachmentHelper.ValidationResult validateImage(jakarta.servlet.http.HttpServletRequest request,
 String filename,
 @Nullable
 Long size)

validateImage

public AttachmentHelper.ValidationResult validateImage(jakarta.servlet.http.HttpServletRequest request,
 String filename,
 @Nullable
 Long size,
 String contentType)

validateImage

public AttachmentHelper.ValidationResult validateImage(InputStream inputStream,
 String filename,
 Long size,
 String contentType)

validateImageAfterUpload

public List<AttachmentHelper.ValidationResult> validateImageAfterUpload(File uploadedFile)
                                                                 throws IOException

Throws:

IOException