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:

ViewTemporaryAttachmentServlet

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 com.atlassian.jira.web.servlet.CommonAttachment	getCommonAttachment(String query)
protected int	getContentLength(String attachmentPath)
protected void	getInputStream(String attachmentQuery, InputStreamConsumer<com.atlassian.fugue.Unit> consumer) Gets the attachment file (not the file name) that corresponds to the requested attachment.
protected 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 attachement found.
protected boolean	supportsRangeRequests() Returns true if this implementation supports RFC 7233 "Range Requests".

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

attachmentQuery, copyRange, doGet, getAttachment, getLoggedInUser, loggedInUserHasPermissionToViewAttachment

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

getContentLength

protected int getContentLength(String attachmentPath)

Specified by:

getContentLength in class AbstractViewFileServlet

supportsRangeRequests

protected boolean supportsRangeRequests()

Description copied from class: AbstractViewFileServlet

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.

Specified by:

supportsRangeRequests in class AbstractViewFileServlet

Returns:

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

See Also:

AbstractViewFileServlet.setResponseHeaders(HttpServletRequest, Optional, HttpServletResponse)

getInputStream

protected void getInputStream(String attachmentQuery,
                              InputStreamConsumer<com.atlassian.fugue.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)

setResponseHeaders

protected void setResponseHeaders(javax.servlet.http.HttpServletRequest request,
                                  Optional<RangeResponse> rangeResponse,
                                  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

rangeResponse - if we are doing a partial response this holds teh range we will return

response - HTTP response

Throws:

AttachmentNotFoundException

IOException

See Also:

AbstractViewFileServlet.supportsRangeRequests()

getCommonAttachment

protected com.atlassian.jira.web.servlet.CommonAttachment getCommonAttachment(String query)