Package com.atlassian.confluence.servlet.download

Class AttachmentDownload

java.lang.Object

com.atlassian.confluence.servlet.download.ServeAfterTransactionDownload

com.atlassian.confluence.servlet.download.AttachmentDownload

All Implemented Interfaces:

com.atlassian.plugin.servlet.DownloadStrategy

Direct Known Subclasses:

ThumbnailDownload

public class AttachmentDownload
extends ServeAfterTransactionDownload

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.confluence.servlet.download.ServeAfterTransactionDownload

ServeAfterTransactionDownload.StreamResultCallback

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JWT_REQUEST_USERNAME

Constructor Summary

Constructors

Constructor	Description
AttachmentDownload()

Method Summary

Modifier and Type	Method	Description
com.atlassian.event.api.EventPublisher	getEventPublisher()
@Nullable InputStream	getStreamForDownload(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse)	Get the input stream to serve to the client outside of the database transaction.
protected Optional<String>	getStreamingAnalyticsEventName()
protected String	getUrlPrefix()
boolean	matches(String urlPath)
protected void	publishEvents(Attachment attachment, boolean download)
void	setAttachmentSafeContentHeaderGuesser(SafeContentHeaderGuesser attachmentSafeContentHeaderGuesser)
void	setAttachmentUrlParser(AttachmentUrlParser attachmentUrlParser)
void	setDownloadResourceManager(DownloadResourceManager downloadResourceManager)
void	setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)
protected void	setHeadersForAttachment(InputStream contents, String name, long contentLength, String contentType, jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse)
void	setTokenGenerator(com.atlassian.struts.xsrf.XsrfTokenGenerator tokenGenerator)
protected void	streamResponse(InputStream fromStream, OutputStream toStream)	Captures and publishes analytics about the attachment streaming.

Methods inherited from class com.atlassian.confluence.servlet.download.ServeAfterTransactionDownload

getDecodedPathInfo, getStreamResultCallback, serveFile, setTransactionManager

Methods inherited from class java.lang.Object

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

Field Details

JWT_REQUEST_USERNAME

public static final String JWT_REQUEST_USERNAME

See Also:

• Constant Field Values

Constructor Details

AttachmentDownload

public AttachmentDownload()

Method Details

matches

public boolean matches(String urlPath)

setDownloadResourceManager

public void setDownloadResourceManager(DownloadResourceManager downloadResourceManager)

setAttachmentUrlParser

public void setAttachmentUrlParser(AttachmentUrlParser attachmentUrlParser)

setEventPublisher

public void setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)

getEventPublisher

public com.atlassian.event.api.EventPublisher getEventPublisher()

setTokenGenerator

public void setTokenGenerator(com.atlassian.struts.xsrf.XsrfTokenGenerator tokenGenerator)

getStreamForDownload

public @Nullable InputStream getStreamForDownload(jakarta.servlet.http.HttpServletRequest httpServletRequest,
 jakarta.servlet.http.HttpServletResponse httpServletResponse)
                                           throws IOException

Description copied from class: ServeAfterTransactionDownload

Get the input stream to serve to the client outside of the database transaction. The inputstream must be useable outside of the database transaction that created it

Specified by:

getStreamForDownload in class ServeAfterTransactionDownload

Returns:

The input stream to serve, or null if nothing to serve.

Throws:

IOException

publishEvents

protected void publishEvents(Attachment attachment,
 boolean download)

getUrlPrefix

protected String getUrlPrefix()

setHeadersForAttachment

protected void setHeadersForAttachment(InputStream contents,
 String name,
 long contentLength,
 String contentType,
 jakarta.servlet.http.HttpServletRequest httpServletRequest,
 jakarta.servlet.http.HttpServletResponse httpServletResponse)
                                throws IOException

Throws:

IOException

setAttachmentSafeContentHeaderGuesser

public void setAttachmentSafeContentHeaderGuesser(SafeContentHeaderGuesser attachmentSafeContentHeaderGuesser)

streamResponse

protected void streamResponse(InputStream fromStream,
 OutputStream toStream)
                       throws IOException

Captures and publishes analytics about the attachment streaming.

Overrides:

streamResponse in class ServeAfterTransactionDownload

Throws:

IOException

Since:

7.12

getStreamingAnalyticsEventName

protected Optional<String> getStreamingAnalyticsEventName()

Since:

7.12