com.atlassian.jira.web.servlet

Class ViewAttachmentServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.atlassian.jira.web.servlet.AbstractViewFileServlet

com.atlassian.jira.web.servlet.ViewAttachmentServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

ViewThumbnailServlet

public class ViewAttachmentServlet
extends AbstractViewFileServlet

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ViewAttachmentServlet()

Method Summary

Modifier and Type	Method and Description
protected Attachment	getAttachment(String query) Looks up the attachment by reading the id from the query string.
protected void	getInputStream(String attachmentQuery, InputStreamConsumer<io.atlassian.blobstore.client.api.Unit> consumer) Gets the attachment file (not the file name) that corresponds to the requested attachment.
protected boolean	hasPermissionToViewAttachment(String username, Attachment attachment) Checks if the given user had permission to see the attachemnt.
protected void	setResponseHeaders(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Sets the content type, content length and "Content-Disposition" header of the response based on the values of the attachement found.

Methods inherited from class com.atlassian.jira.web.servlet.AbstractViewFileServlet

attachmentQuery, doGet, getJiraAuthenticationContext, getUserName

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

ViewAttachmentServlet

public ViewAttachmentServlet()

Method Detail

getInputStream

protected void getInputStream(String attachmentQuery,
                              InputStreamConsumer<io.atlassian.blobstore.client.api.Unit> consumer)
                       throws PermissionException,
                              IOException

Description copied from class: AbstractViewFileServlet

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

Specified by:

getInputStream in class AbstractViewFileServlet

Parameters:

attachmentQuery - the attachment path

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

Throws:

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

IOException - if there is a problem getting the attachment.

See Also:

AbstractViewFileServlet.getInputStream(String, com.atlassian.jira.util.io.InputStreamConsumer)

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.

setResponseHeaders

protected void setResponseHeaders(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws AttachmentNotFoundException,
                                  IOException

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

Specified by:

setResponseHeaders in class AbstractViewFileServlet

Parameters:

request - HTTP request

response - HTTP response

Throws:

AttachmentNotFoundException

IOException

hasPermissionToViewAttachment

protected boolean hasPermissionToViewAttachment(String username,
                                                Attachment attachment)
                                         throws DataAccessException

Checks if the given user had permission to see the attachemnt.

Parameters:

username - username of the user who wants to see the attachment

attachment - attachment to be checked

Returns:

true if user can see the attachment, false otherwise

Throws:

DataAccessException - if no such user exists.