com.atlassian.jira.web.servlet.viewfile

Class AbstractViewFileServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.atlassian.jira.web.servlet.viewfile.AbstractViewFileServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

ViewAttachmentServlet, ViewThumbnailServlet

public abstract class AbstractViewFileServlet
extends javax.servlet.http.HttpServlet

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractViewFileServlet.JwtAttachmentPermissionException

Field Summary

Fields

Modifier and Type	Field and Description
static String	IMAGE_ATTACHMENT_JWT_TOKEN_QUERY_PARAM_NAME
static String	IMAGE_DISPLAYING_CANNOT_DISPLAY_IMAGE_PATH

Constructor Summary

Constructors

Constructor and Description
AbstractViewFileServlet()

Method Summary

Modifier and Type	Method and Description
protected String	attachmentQuery(javax.servlet.http.HttpServletRequest request) Validates that path is valid attachment path.
protected void	checkRequesterIsPermittedToViewTheAttachment(Attachment attachment, javax.servlet.http.HttpServletRequest request, String exceptionMessage)
protected void	copyRange(InputStream is, OutputStream out, RangeResponse rangeResponse)
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected Attachment	getAttachment(String queryWithIdAndFilenameToIgnore) Looks up the attachment by reading the id from the queryWithIdAndFilenameToIgnore string.
protected AttachmentManager	getAttachmentManager()
protected abstract int	getContentLength(String attachmentPath)
protected abstract void	getInputStream(javax.servlet.http.HttpServletRequest request, String attachmentPath, InputStreamConsumer<io.atlassian.fugue.Unit> consumer) Gets the attachment file (not the file name) that corresponds to the requested attachment.
protected ApplicationUser	getLoggedInUser()
protected boolean	isAnonymousUserPermittedToViewAttachment(Attachment attachment)
protected boolean	isImageAttachmentJwtTokenPresent(javax.servlet.http.HttpServletRequest request)
protected boolean	isJwtTokenUserPermittedToViewAttachment_andSendAnalyticsEvent(javax.servlet.http.HttpServletRequest request, Attachment attachment)
protected boolean	isLoggedInUserPermittedToViewAttachment(Attachment attachment)
protected boolean	isUserLoggedIn()
protected boolean	isUserPermittedToViewAttachment(ApplicationUser user, Attachment attachment)
protected abstract void	setResponseContentHeaders(javax.servlet.http.HttpServletRequest request, Optional<RangeResponse> rangeResponse, javax.servlet.http.HttpServletResponse response) Sets the content type, content length and "Content-Disposition" header of the response based on the values of the attachment found.
protected abstract boolean	supportsRangeRequests() Returns true if this implementation supports RFC 7233 "Range Requests".

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

IMAGE_DISPLAYING_CANNOT_DISPLAY_IMAGE_PATH

public static String IMAGE_DISPLAYING_CANNOT_DISPLAY_IMAGE_PATH

IMAGE_ATTACHMENT_JWT_TOKEN_QUERY_PARAM_NAME

public static final String IMAGE_ATTACHMENT_JWT_TOKEN_QUERY_PARAM_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractViewFileServlet

public AbstractViewFileServlet()

Method Detail

getAttachmentManager

protected AttachmentManager getAttachmentManager()

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

getContentLength

protected abstract int getContentLength(String attachmentPath)

supportsRangeRequests

protected abstract boolean supportsRangeRequests()

Returns true if this implementation supports RFC 7233 "Range Requests".

Returning true means that you must set the appropriate "Content-Range" and "Content-Length" headers for the partial range we will return in the #setResponseHeaders implementation.

Returns:

true if this servlet supports RFC 7233 "Range Requests".

See Also:

setResponseContentHeaders(HttpServletRequest, Optional, HttpServletResponse)

copyRange

protected void copyRange(InputStream is,
                         OutputStream out,
                         RangeResponse rangeResponse)
                  throws IOException

Throws:

IOException

attachmentQuery

protected final String attachmentQuery(javax.servlet.http.HttpServletRequest request)

Validates that path is valid attachment path.

Parameters:

request - HTTP request

Returns:

attachment path

getAttachment

protected Attachment getAttachment(String queryWithIdAndFilenameToIgnore)

Looks up the attachment by reading the id from the queryWithIdAndFilenameToIgnore string.

Parameters:

queryWithIdAndFilenameToIgnore - eg. '/10000/foo.txt'

Returns:

attachment found

Throws:

AttachmentNotFoundException - if no attachment is found after parsing the queryWithIdAndFilenameToIgnore string or if the resulting attachment id does not exist.

DataAccessException - if there is a problem accessing the database.

isLoggedInUserPermittedToViewAttachment

protected boolean isLoggedInUserPermittedToViewAttachment(Attachment attachment)

isJwtTokenUserPermittedToViewAttachment_andSendAnalyticsEvent

protected boolean isJwtTokenUserPermittedToViewAttachment_andSendAnalyticsEvent(javax.servlet.http.HttpServletRequest request,
                                                                                Attachment attachment)

isUserPermittedToViewAttachment

protected boolean isUserPermittedToViewAttachment(ApplicationUser user,
                                                  Attachment attachment)

checkRequesterIsPermittedToViewTheAttachment

protected void checkRequesterIsPermittedToViewTheAttachment(Attachment attachment,
                                                            javax.servlet.http.HttpServletRequest request,
                                                            String exceptionMessage)
                                                     throws PermissionException

Throws:

PermissionException

getInputStream

protected abstract void getInputStream(javax.servlet.http.HttpServletRequest request,
                                       String attachmentPath,
                                       InputStreamConsumer<io.atlassian.fugue.Unit> consumer)
                                throws IOException,
                                       PermissionException

Gets the attachment file (not the file name) that corresponds to the requested attachment.

Parameters:

attachmentPath - the attachment path

consumer - a procedure that consumes the stream with the attachment data.

Throws:

DataAccessException - If there is a problem looking up the data to support the attachment.

AttachmentNotFoundException - if the attachment does not exist.

IOException - if there is a problem getting the attachment.

NoAttachmentDataException - if the attachment's contents cannot be found.

AttachmentReadException - if a problem occurs when the consumer processes the attachment's contents.

PermissionException

setResponseContentHeaders

protected abstract void setResponseContentHeaders(javax.servlet.http.HttpServletRequest request,
                                                  Optional<RangeResponse> rangeResponse,
                                                  javax.servlet.http.HttpServletResponse response)
                                           throws InvalidAttachmentPathException,
                                                  DataAccessException,
                                                  IOException

Sets the content type, content length and "Content-Disposition" header of the response based on the values of the attachment found.

The rangeResponse parameter will only be present if this Concrete class declares it supports Range Requests, and the request actually contains a Range header.

Parameters:

request - HTTP request

rangeResponse - If present, the partial byte range we will return

response - HTTP response

Throws:

InvalidAttachmentPathException

DataAccessException

IOException

See Also:

supportsRangeRequests()

isUserLoggedIn

protected boolean isUserLoggedIn()

getLoggedInUser

protected final ApplicationUser getLoggedInUser()

isAnonymousUserPermittedToViewAttachment

protected final boolean isAnonymousUserPermittedToViewAttachment(Attachment attachment)

isImageAttachmentJwtTokenPresent

protected boolean isImageAttachmentJwtTokenPresent(javax.servlet.http.HttpServletRequest request)