com.atlassian.plugin.webresource.transformer
Interface WebResourceTransformer

public interface WebResourceTransformer

Transforms a downloadable resource. Instances are created per request, though it is assumed the resource will have the appropriate caching headers to ensure the same user doesn't download it twice.

Since:

2.5.0

Method Summary

DownloadableResource

transform(org.dom4j.Element configElement, ResourceLocation location, String filePath, DownloadableResource nextResource) Transforms the downloadable resource by returning a new one.

Method Detail

transform

DownloadableResource transform(org.dom4j.Element configElement,
                               ResourceLocation location,
                               String filePath,
                               DownloadableResource nextResource)

Transforms the downloadable resource by returning a new one.

Parameters:

configElement - The element where it was used. This is provided to allow the transformer to take additional configuration in the form of custom attributes or sub-elements.

location - The original resource location

filePath - Extra path information. Cannot be null, but can be an empty string if no extra path information

nextResource - The original resource

Returns:

The new resource representing the transformed resource