com.atlassian.plugin.webresource.transformer

Interface WebResourceTransformer

Deprecated.

since 3.0. Use WebResourceTransformerFactory, will be removed at next major version (6.0.0)

@Deprecated
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.

Transformers based on this interface cannot contribute to the URL, meaning they must make decisions based on request state (for example, getting the current user from the incoming request). They also cannot affect the URL to force browsers to refresh something when the underlying transformation changes. This has been deprecated in favour of UrlReadingWebResourceTransformer which fixes these issues.

Since:

2.5.0

Method Summary

Modifier and Type	Method and Description
default com.atlassian.plugin.servlet.DownloadableResource	transform(org.dom4j.Element configElement, com.atlassian.plugin.elements.ResourceLocation location, com.atlassian.plugin.servlet.DownloadableResource nextResource) Deprecated. since 3.0. Use WebResourceTransformerFactory, will be removed at next major version (6.0.0)
com.atlassian.plugin.servlet.DownloadableResource	transform(org.dom4j.Element configElement, com.atlassian.plugin.elements.ResourceLocation location, String filePath, com.atlassian.plugin.servlet.DownloadableResource nextResource) Deprecated. since 3.0. Use WebResourceTransformerFactory, will be removed at next major version (6.0.0)

Method Detail

transform

@Deprecated
com.atlassian.plugin.servlet.DownloadableResource transform(org.dom4j.Element configElement,
                                                                        com.atlassian.plugin.elements.ResourceLocation location,
                                                                        String filePath,
                                                                        com.atlassian.plugin.servlet.DownloadableResource nextResource)

Deprecated. since 3.0. Use WebResourceTransformerFactory, will be removed at next major version (6.0.0)

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

transform

@Deprecated
default com.atlassian.plugin.servlet.DownloadableResource transform(org.dom4j.Element configElement,
                                                                                com.atlassian.plugin.elements.ResourceLocation location,
                                                                                com.atlassian.plugin.servlet.DownloadableResource nextResource)

Deprecated. since 3.0. Use WebResourceTransformerFactory, will be removed at next major version (6.0.0)

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

nextResource - The original resource

Returns:

The new resource representing the transformed resource