public interface

DownloadableResource

com.atlassian.plugin.servlet.DownloadableResource
Known Indirect Subclasses

Class Overview

Represents a plugin resource that can be downloaded. It is up to the calling class to check if the resource is modified before calling serveResource(HttpServletRequest, HttpServletResponse) to serve the resource.

Summary

Public Methods
String getContentType()
Returns the content type for the resource.
boolean isResourceModified(HttpServletRequest request, HttpServletResponse response)
Returns true if the plugin resource has been modified.
void serveResource(HttpServletRequest request, HttpServletResponse response)
Writes the resource content out into the response.
void streamResource(OutputStream out)
Write the resource to the supplied OutputStream.

Public Methods

public String getContentType ()

Returns the content type for the resource. May return null if it cannot resolve its own content type.

public boolean isResourceModified (HttpServletRequest request, HttpServletResponse response)

Returns true if the plugin resource has been modified. The implementing class is responsible for setting any appropriate response codes or headers on the response. If the resource has been modified, the resource shouldn't be served.

public void serveResource (HttpServletRequest request, HttpServletResponse response)

Writes the resource content out into the response.

Throws
DownloadException if there were errors writing to the response.

public void streamResource (OutputStream out)

Write the resource to the supplied OutputStream. Note that the OutputStream will not be closed by this method.

Parameters
out the stream to write to
Throws
DownloadException if there were errors writing to the response. Since 2.3.