com.atlassian.jira.web.servlet

Class AbstractViewFileServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.atlassian.jira.web.servlet.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

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	copyRange(InputStream is, OutputStream out, RangeResponse rangeResponse)
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected Attachment	getAttachment(String query) Looks up the attachment by reading the id from the query string.
protected abstract int	getContentLength(String attachmentPath)
protected abstract void	getInputStream(String attachmentPath, InputStreamConsumer<com.atlassian.fugue.Unit> consumer) Gets the attachment file (not the file name) that corresponds to the requested attachment.
protected ApplicationUser	getLoggedInUser()
protected boolean	loggedInUserHasPermissionToViewAttachment(Attachment attachment) Checks if the currently logged in user has permission to see the attachemnt.
protected abstract void	setResponseHeaders(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

Constructor Detail

AbstractViewFileServlet

public AbstractViewFileServlet()

Method Detail

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:

setResponseHeaders(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 query)

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

Parameters:

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

Returns:

attachment found

Throws:

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

DataAccessException - if there is a problem accessing the database.

loggedInUserHasPermissionToViewAttachment

protected boolean loggedInUserHasPermissionToViewAttachment(Attachment attachment)
                                                     throws DataAccessException

Checks if the currently logged in user has permission to see the attachemnt.

Parameters:

attachment - attachment to be checked

Returns:

true if user can see the attachment, false otherwise

Throws:

DataAccessException - if no such user exists.

getInputStream

protected abstract void getInputStream(String attachmentPath,
                                       InputStreamConsumer<com.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.

PermissionException - if the user has insufficient permission to see the attachment.

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.

setResponseHeaders

protected abstract void setResponseHeaders(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()

getLoggedInUser

protected final ApplicationUser getLoggedInUser()