com.atlassian.jira.web.servlet.viewfile

Class ViewAttachmentServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

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

com.atlassian.jira.web.servlet.viewfile.ViewAttachmentServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

ViewTemporaryAttachmentServlet

public class ViewAttachmentServlet
extends AbstractViewFileServlet

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.web.servlet.viewfile.AbstractViewFileServlet

AbstractViewFileServlet.JwtAttachmentPermissionException

Field Summary

Fields inherited from class com.atlassian.jira.web.servlet.viewfile.AbstractViewFileServlet

IMAGE_ATTACHMENT_JWT_TOKEN_QUERY_PARAM_NAME, IMAGE_DISPLAYING_CANNOT_DISPLAY_IMAGE_PATH

Constructor Summary

Constructors

Constructor and Description
ViewAttachmentServlet()

Method Summary

Modifier and Type	Method and Description
protected CommonAttachment	getCommonAttachment(String query)
protected int	getContentLength(String attachmentPath)
protected void	getInputStream(javax.servlet.http.HttpServletRequest request, String attachmentQuery, InputStreamConsumer<io.atlassian.fugue.Unit> consumer) Gets the attachment file (not the file name) that corresponds to the requested attachment.
protected 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 boolean	supportsRangeRequests() Returns true if this implementation supports RFC 7233 "Range Requests".

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

attachmentQuery, checkRequesterIsPermittedToViewTheAttachment, copyRange, doGet, getAttachment, getAttachmentManager, getLoggedInUser, isAnonymousUserPermittedToViewAttachment, isImageAttachmentJwtTokenPresent, isJwtTokenUserPermittedToViewAttachment_andSendAnalyticsEvent, isLoggedInUserPermittedToViewAttachment, isUserLoggedIn, isUserPermittedToViewAttachment

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.setResponseContentHeaders(HttpServletRequest, Optional, HttpServletResponse)

getInputStream

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

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

attachmentQuery - the attachment path

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

Throws:

IOException - if there is a problem getting the attachment.

PermissionException

setResponseContentHeaders

protected void setResponseContentHeaders(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 attachment found.

Specified by:

setResponseContentHeaders in class AbstractViewFileServlet

Parameters:

request - HTTP request

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

response - HTTP response

Throws:

AttachmentNotFoundException

IOException

See Also:

AbstractViewFileServlet.supportsRangeRequests()

getCommonAttachment

protected CommonAttachment getCommonAttachment(String query)