com.atlassian.plugin.webresource
Class SuperBatchPluginResource

java.lang.Object
  com.atlassian.plugin.webresource.SuperBatchPluginResource

All Implemented Interfaces:

DownloadableResource, BatchResource, PluginResource

Direct Known Subclasses:

SuperBatchSubResource

public class SuperBatchPluginResource
extends java.lang.Object
implements DownloadableResource, BatchResource, PluginResource

Creates a batch of all like-typed resources that are declared as "super-batch="true"" in their plugin definitions. The URL for batch resources is /download/superbatch/<type>/batch.<type. The additional type part in the path is simply there to make the number of path-parts identical with other resources, so relative URLs will still work in CSS files.

Constructor Summary

	SuperBatchPluginResource(java.lang.String type, java.util.Map<java.lang.String,java.lang.String> params)
protected	SuperBatchPluginResource(java.lang.String resourceName, java.lang.String type, java.util.Map<java.lang.String,java.lang.String> params)

Method Summary

void	add(DownloadableResource downloadableResource)
static SuperBatchPluginResource	createBatchFor(PluginResource pluginResource)
java.lang.String	getContentType() Returns the content type for the resource.
java.lang.String	getModuleCompleteKey()
java.util.Map<java.lang.String,java.lang.String>	getParams()
java.lang.String	getResourceName()
java.lang.String	getType()
protected static java.lang.String	getType(java.lang.String path)
java.lang.String	getUrl()
java.lang.String	getVersion(WebResourceIntegration integration)
boolean	isCacheSupported()
boolean	isEmpty()
boolean	isResourceModified(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Returns true if the plugin resource has been modified.
static boolean	matches(java.lang.String path)
static SuperBatchPluginResource	parse(java.lang.String path, java.util.Map<java.lang.String,java.lang.String> params)
void	serveResource(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Writes the resource content out into the response.
void	streamResource(java.io.OutputStream out) Write the resource to the supplied OutputStream.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SuperBatchPluginResource

public SuperBatchPluginResource(java.lang.String type,
                                java.util.Map<java.lang.String,java.lang.String> params)

SuperBatchPluginResource

protected SuperBatchPluginResource(java.lang.String resourceName,
                                   java.lang.String type,
                                   java.util.Map<java.lang.String,java.lang.String> params)

Method Detail

matches

public static boolean matches(java.lang.String path)

createBatchFor

public static SuperBatchPluginResource createBatchFor(PluginResource pluginResource)

parse

public static SuperBatchPluginResource parse(java.lang.String path,
                                             java.util.Map<java.lang.String,java.lang.String> params)

getType

protected static java.lang.String getType(java.lang.String path)

isResourceModified

public boolean isResourceModified(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)

Description copied from interface: DownloadableResource

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.

Specified by:

isResourceModified in interface DownloadableResource

serveResource

public void serveResource(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws DownloadException

Description copied from interface: DownloadableResource

Writes the resource content out into the response.

Specified by:

serveResource in interface DownloadableResource

Throws:

DownloadException - if there were errors writing to the response.

streamResource

public void streamResource(java.io.OutputStream out)
                    throws DownloadException

Description copied from interface: DownloadableResource

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

Specified by:

streamResource in interface DownloadableResource

Parameters:

out - the stream to write to

Throws:

DownloadException - if there were errors writing to the response. Since 2.3.

getContentType

public java.lang.String getContentType()

Description copied from interface: DownloadableResource

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

Specified by:

getContentType in interface DownloadableResource

add

public void add(DownloadableResource downloadableResource)

isEmpty

public boolean isEmpty()

getUrl

public java.lang.String getUrl()

Specified by:

getUrl in interface PluginResource

Returns:

the url for this plugin resource.

getParams

public java.util.Map<java.lang.String,java.lang.String> getParams()

Specified by:

getParams in interface BatchResource

Specified by:

getParams in interface PluginResource

Returns:

a map of parameter key and value pairs for this resource.

getVersion

public java.lang.String getVersion(WebResourceIntegration integration)

Specified by:

getVersion in interface PluginResource

Returns:

the version prefix string for a cached resource

getType

public java.lang.String getType()

Specified by:

getType in interface BatchResource

isCacheSupported

public boolean isCacheSupported()

Specified by:

isCacheSupported in interface PluginResource

Returns:

true if caching for this resource is supported. Use this check to append a static caching url prefix to this resource's url.

getResourceName

public java.lang.String getResourceName()

Specified by:

getResourceName in interface PluginResource

Returns:

the resource name for the plugin resource.

getModuleCompleteKey

public java.lang.String getModuleCompleteKey()

Specified by:

getModuleCompleteKey in interface PluginResource

Returns:

the plugin module's complete key for which this resource belongs to.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object