Package com.atlassian.plugin.webresource

Class WebResourceManagerImpl

java.lang.Object

com.atlassian.plugin.webresource.WebResourceManagerImpl

All Implemented Interfaces:

WebResourceManager

public class WebResourceManagerImpl
extends Object
implements WebResourceManager

A handy super-class that handles most of the resource management.

To use this manager, you need to have the following UrlRewriteFilter code:

 <rule>
 <from>^/s/(.*)/_/(.*)</from>
 <run class="com.atlassian.plugin.servlet.ResourceDownloadUtils" method="addCachingHeaders" />
 <to type="forward">/$2</to>
 </rule>
 

Sub-classes should implement the abstract methods

Field Summary

Fields

Modifier and Type	Field	Description
protected final LegacyPageBuilderService	pageBuilderService

Constructor Summary

Constructors

Constructor	Description
WebResourceManagerImpl(Globals globals, WebResourceIntegration webResourceIntegration, WebResourceUrlProvider webResourceUrlProvider)
WebResourceManagerImpl(Globals globals, WebResourceIntegration webResourceIntegration, WebResourceUrlProvider webResourceUrlProvider, ResourceBatchingConfiguration batchingConfiguration)
WebResourceManagerImpl(WebResourceAssemblerFactory webResourceAssemblerFactory, LegacyPageBuilderService pageBuilderService, PluginResourceLocator pluginResourceLocator, WebResourceUrlProvider webResourceUrlProvider, ResourceBatchingConfiguration batchingConfiguration)
WebResourceManagerImpl(WebResourceAssemblerFactory webResourceAssemblerFactory, PluginResourceLocator pluginResourceLocator, WebResourceIntegration webResourceIntegration, WebResourceUrlProvider webResourceUrlProvider, ResourceBatchingConfiguration batchingConfiguration)

Method Summary

Modifier and Type	Method	Description
protected AssembledResources	getRequestLocalAssembledResources()
protected RequiredResources	getRequestLocalRequiredResources()
String	getRequiredResources(UrlMode urlMode)	This is the equivalent of calling getRequiredResources(UrlMode, WebResourceFilter) with the given url mode and a DefaultWebResourceFilter.
String	getRequiredResources(UrlMode urlMode, WebResourceFilter filter)	Returns a String of the resources tags to the previously required resources called via requireResource methods for the specified url mode and resource filter.
protected String	getRequiredResources(UrlMode urlMode, WebResourceFilter webResourceFilter, Set<String> excludedResourceKeys, List<String> excludedContexts)	Get the resources that have been required but excluding certain resource keys and certain contexts.
String	getResourceTags(String moduleCompleteKey, UrlMode urlMode)
void	includeResources(Writer writer, UrlMode urlMode)	This is the equivalent of of calling includeResources(Writer, UrlMode, WebResourceFilter) with the given url mode and a DefaultWebResourceFilter.
void	includeResources(Writer writer, UrlMode urlMode, WebResourceFilter webResourceFilter)	Writes out the resource tags to the previously required resources called via requireResource methods for the specified url mode and resource filter.
void	includeResources(Iterable<String> moduleCompleteKeys, Writer writer, UrlMode urlMode)
void	requireResource(String moduleCompleteKey)
void	requireResource(String moduleCompleteKey, Writer writer, UrlMode urlMode)
void	requireResourcesForContext(String context)

Methods inherited from class java.lang.Object

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

Field Details

pageBuilderService

protected final LegacyPageBuilderService pageBuilderService

Constructor Details

WebResourceManagerImpl

public WebResourceManagerImpl(Globals globals,
 WebResourceIntegration webResourceIntegration,
 WebResourceUrlProvider webResourceUrlProvider)

WebResourceManagerImpl

public WebResourceManagerImpl(Globals globals,
 WebResourceIntegration webResourceIntegration,
 WebResourceUrlProvider webResourceUrlProvider,
 ResourceBatchingConfiguration batchingConfiguration)

WebResourceManagerImpl

public WebResourceManagerImpl(WebResourceAssemblerFactory webResourceAssemblerFactory,
 PluginResourceLocator pluginResourceLocator,
 WebResourceIntegration webResourceIntegration,
 WebResourceUrlProvider webResourceUrlProvider,
 ResourceBatchingConfiguration batchingConfiguration)

WebResourceManagerImpl

public WebResourceManagerImpl(WebResourceAssemblerFactory webResourceAssemblerFactory,
 LegacyPageBuilderService pageBuilderService,
 PluginResourceLocator pluginResourceLocator,
 WebResourceUrlProvider webResourceUrlProvider,
 ResourceBatchingConfiguration batchingConfiguration)

Method Details

requireResource

public void requireResource(String moduleCompleteKey)

Specified by:

requireResource in interface WebResourceManager

requireResourcesForContext

public void requireResourcesForContext(String context)

Specified by:

requireResourcesForContext in interface WebResourceManager

includeResources

public void includeResources(Iterable<String> moduleCompleteKeys,
 Writer writer,
 UrlMode urlMode)

Specified by:

includeResources in interface WebResourceManager

includeResources

public void includeResources(Writer writer,
 UrlMode urlMode)

This is the equivalent of of calling includeResources(Writer, UrlMode, WebResourceFilter) with the given url mode and a DefaultWebResourceFilter.

Specified by:

includeResources in interface WebResourceManager

See Also:

• includeResources(Writer, UrlMode, WebResourceFilter)

includeResources

public void includeResources(Writer writer,
 UrlMode urlMode,
 WebResourceFilter webResourceFilter)

Writes out the resource tags to the previously required resources called via requireResource methods for the specified url mode and resource filter. Note that this method will clear the list of previously required resources.

Specified by:

includeResources in interface WebResourceManager

Parameters:

writer - the writer to write the links to

urlMode - the url mode to write resource url links in

webResourceFilter - the resource filter to filter resources on

Since:

2.4

getRequiredResources

public String getRequiredResources(UrlMode urlMode)

This is the equivalent of calling getRequiredResources(UrlMode, WebResourceFilter) with the given url mode and a DefaultWebResourceFilter.

Specified by:

getRequiredResources in interface WebResourceManager

See Also:

• getRequiredResources(UrlMode, WebResourceFilter)

getRequiredResources

public String getRequiredResources(UrlMode urlMode,
 WebResourceFilter filter)

Returns a String of the resources tags to the previously required resources called via requireResource methods for the specified url mode and resource filter. Note that this method will NOT clear the list of previously required resources.

Specified by:

getRequiredResources in interface WebResourceManager

Parameters:

urlMode - the url mode to write out the resource tags

filter - the web resource filter to filter resources on

Returns:

a String of the resource tags

Since:

2.4

getRequiredResources

protected String getRequiredResources(UrlMode urlMode,
 WebResourceFilter webResourceFilter,
 Set<String> excludedResourceKeys,
 List<String> excludedContexts)

Get the resources that have been required but excluding certain resource keys and certain contexts.

You should note that the WebResourceManager cannot break context batch resources down beyond the granularity of the context so excluding particular resource keys does not necessary exclude them from a context batch. To safely use this method it is expected that after the initial page load any subsequent "dynamic" requests for resources should be at the granularity of individual resources and not contexts. However you can request contexts if you are confident that there hasn't been an overlap of contexts and dynamically requested macros. A typical safe example is in Confluence when rendering macros the macro rendering process will have requested individual resources which will not exist in any contexts.

This method is available for use by sub-classes but is not part of the public interface since it does not form a complete solution for dynamic resource handling.

Parameters:

urlMode - the url mode to write out the resource tags

webResourceFilter - the web resource filter to filter resources on

excludedResourceKeys - the complete key of resources to be excluded. These exclusion will not apply to any requested contexts so if a context happens to include these resource keys it will still be served (unless excluded as a context).

excludedContexts - contexts to be excluded when the tags are written

Returns:

a String of the resource tags

Since:

2.12.5

requireResource

public void requireResource(String moduleCompleteKey,
 Writer writer,
 UrlMode urlMode)

Specified by:

requireResource in interface WebResourceManager

getResourceTags

public String getResourceTags(String moduleCompleteKey,
 UrlMode urlMode)

Specified by:

getResourceTags in interface WebResourceManager

getRequestLocalAssembledResources

protected AssembledResources getRequestLocalAssembledResources()

getRequestLocalRequiredResources

protected RequiredResources getRequestLocalRequiredResources()