com.atlassian.plugin.webresource

Class WebResourceManagerImpl

java.lang.Object

com.atlassian.plugin.webresource.WebResourceManagerImpl

All Implemented Interfaces:

WebResourceManager

Deprecated.

@Deprecated
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 and Description
protected LegacyPageBuilderService	pageBuilderService Deprecated.
protected WebResourceIntegration	webResourceIntegration Deprecated.

Constructor Summary

Constructors

Constructor and Description
WebResourceManagerImpl(PluginResourceLocator pluginResourceLocator, WebResourceIntegration webResourceIntegration, WebResourceUrlProvider webResourceUrlProvider) Deprecated.
WebResourceManagerImpl(PluginResourceLocator pluginResourceLocator, WebResourceIntegration webResourceIntegration, WebResourceUrlProvider webResourceUrlProvider, ResourceBatchingConfiguration batchingConfiguration) Deprecated.
WebResourceManagerImpl(PrebakeWebResourceAssemblerFactory webResourceAssemblerFactory, PluginResourceLocator pluginResourceLocator, WebResourceIntegration webResourceIntegration, WebResourceUrlProvider webResourceUrlProvider, ResourceBatchingConfiguration batchingConfiguration) Deprecated.
WebResourceManagerImpl(WebResourceAssemblerFactory webResourceAssemblerFactory, LegacyPageBuilderService pageBuilderService, PluginResourceLocator pluginResourceLocator, WebResourceIntegration webResourceIntegration, WebResourceUrlProvider webResourceUrlProvider, ResourceBatchingConfiguration batchingConfiguration, ResourceDependencyResolver resourceDependencyResolver) Deprecated.

Method Summary

Modifier and Type	Method and Description
<T> T	executeInNewContext(com.google.common.base.Supplier<T> nestedExecution) Deprecated. Executes a Supplier within a new WebResourceManager context.
protected AssembledResources	getRequestLocalAssembledResources() Deprecated.
protected RequiredResources	getRequestLocalRequiredResources() Deprecated.
String	getRequiredResources() Deprecated.
String	getRequiredResources(UrlMode urlMode) Deprecated. This is the equivalent of calling getRequiredResources(UrlMode, WebResourceFilter) with the given url mode and a DefaultWebResourceFilter.
String	getRequiredResources(UrlMode urlMode, WebResourceFilter filter) Deprecated. 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) Deprecated. Get the resources that have been required but excluding certain resource keys and certain contexts.
String	getResourceTags(String moduleCompleteKey) Deprecated.
String	getResourceTags(String moduleCompleteKey, UrlMode urlMode) Deprecated. Returns the resource tags of the specified resource.
String	getStaticPluginResource(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor, String resourceName) Deprecated.
String	getStaticPluginResource(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor, String resourceName, UrlMode urlMode) Deprecated.
String	getStaticPluginResource(String moduleCompleteKey, String resourceName) Deprecated.
String	getStaticPluginResource(String moduleCompleteKey, String resourceName, UrlMode urlMode) Deprecated.
String	getStaticResourcePrefix() Deprecated.
String	getStaticResourcePrefix(String resourceCounter) Deprecated.
void	includeResources(Iterable<String> moduleCompleteKeys, Writer writer, UrlMode urlMode) Deprecated. Writes out the resource tags for a specified set of required resources and their dependencies.
void	includeResources(Writer writer) Deprecated.
void	includeResources(Writer writer, UrlMode urlMode) Deprecated. 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) Deprecated. Writes out the resource tags to the previously required resources called via requireResource methods for the specified url mode and resource filter.
void	requireResource(String moduleCompleteKey) Deprecated. Indicates that a given plugin web resource is required.
void	requireResource(String moduleCompleteKey, Writer writer) Deprecated.
void	requireResource(String moduleCompleteKey, Writer writer, UrlMode urlMode) Deprecated. Writes the resource tags of the specified resource to the writer.
void	requireResourcesForContext(String context) Deprecated. Writes the resource tags of all resources that have the given context specified in their descriptor.

Methods inherited from class java.lang.Object

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

Field Detail

pageBuilderService

protected final LegacyPageBuilderService pageBuilderService

Deprecated.

webResourceIntegration

@Deprecated
protected final WebResourceIntegration webResourceIntegration

Deprecated.

Constructor Detail

WebResourceManagerImpl

public WebResourceManagerImpl(PluginResourceLocator pluginResourceLocator,
                              WebResourceIntegration webResourceIntegration,
                              WebResourceUrlProvider webResourceUrlProvider)

Deprecated.

WebResourceManagerImpl

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

Deprecated.

WebResourceManagerImpl

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

Deprecated.

WebResourceManagerImpl

public WebResourceManagerImpl(WebResourceAssemblerFactory webResourceAssemblerFactory,
                              LegacyPageBuilderService pageBuilderService,
                              PluginResourceLocator pluginResourceLocator,
                              WebResourceIntegration webResourceIntegration,
                              WebResourceUrlProvider webResourceUrlProvider,
                              ResourceBatchingConfiguration batchingConfiguration,
                              ResourceDependencyResolver resourceDependencyResolver)

Deprecated.

Method Detail

requireResource

public void requireResource(String moduleCompleteKey)

Deprecated.

Description copied from interface: WebResourceManager

Indicates that a given plugin web resource is required. All resources called via this method must be included when WebResourceManager.includeResources(Writer, UrlMode) is called.

Specified by:

requireResource in interface WebResourceManager

Parameters:

moduleCompleteKey - The fully qualified plugin web resource module (eg jira.webresources:scriptaculous)

See Also:

WebResourceManager.includeResources(Writer, UrlMode), RequiredResources.requireWebResource(String)

requireResourcesForContext

public void requireResourcesForContext(String context)

Deprecated.

Description copied from interface: WebResourceManager

Writes the resource tags of all resources that have the given context specified in their descriptor.

Specified by:

requireResourcesForContext in interface WebResourceManager

Parameters:

context - The name of the context for which you want to require resources (eg "atl.admin")

See Also:

RequiredResources.requireContext(String)

includeResources

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

Deprecated.

Description copied from interface: WebResourceManager

Writes out the resource tags for a specified set of required resources and their dependencies. Does not write out tags for resources specified in calls to WebResourceManager.requireResource(String).

Specified by:

includeResources in interface WebResourceManager

Parameters:

moduleCompleteKeys - The set of web resource modules to include

writer - the writer to write the links to

urlMode - specifies whether to use absolute URLs, relative URLs, or allow the concrete implementation to decide

includeResources

public void includeResources(Writer writer,
                             UrlMode urlMode)

Deprecated.

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)

Deprecated.

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

See Also:

WebResourceSet.writeHtmlTags(java.io.Writer, com.atlassian.webresource.api.UrlMode, com.google.common.base.Predicate)

getRequiredResources

public String getRequiredResources(UrlMode urlMode)

Deprecated.

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

Specified by:

getRequiredResources in interface WebResourceManager

Returns:

the resource tags for all resources previously required

See Also:

getRequiredResources(UrlMode, WebResourceFilter)

getRequiredResources

public String getRequiredResources(UrlMode urlMode,
                                   WebResourceFilter filter)

Deprecated.

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

See Also:

WebResourceManager.includeResources(Writer, UrlMode, WebResourceFilter), WebResourceSet.writeHtmlTags(java.io.Writer, com.atlassian.webresource.api.UrlMode, com.google.common.base.Predicate)

getRequiredResources

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

Deprecated.

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)

Deprecated.

Description copied from interface: WebResourceManager

Writes the resource tags of the specified resource to the writer. If you need it as a String to embed the tags in a template, use WebResourceManager.getResourceTags(String, UrlMode).

This method formats resource URLs in either relative or absolute format, depending on the value of urlMode. See UrlMode for details of the different options for URL format.

Specified by:

requireResource in interface WebResourceManager

Parameters:

moduleCompleteKey - The fully qualified plugin web resource module (eg jira.webresources:scriptaculous)

writer - The writer to write the resource tags to.

urlMode - specifies whether to use absolute URLs, relative URLs, or allow the concrete implementation to decide

getResourceTags

public String getResourceTags(String moduleCompleteKey,
                              UrlMode urlMode)

Deprecated.

Description copied from interface: WebResourceManager

Returns the resource tags of the specified resource. If you are outputting the value to a Writer, use WebResourceManager.requireResource(String, java.io.Writer, UrlMode).

This method formats resource URLs in either relative or absolute format, depending on the value of urlMode. See UrlMode for details of the different options for URL format.

Specified by:

getResourceTags in interface WebResourceManager

Parameters:

moduleCompleteKey - The fully qualified plugin web resource module (eg jira.webresources:scriptaculous)

urlMode - specifies whether to use absolute URLs, relative URLs, or allow the concrete implementation to decide

Returns:

the resource tags for the specified resource

See Also:

WebResourceManager.requireResource(String, Writer, UrlMode)

getStaticPluginResource

@Deprecated
public String getStaticPluginResource(String moduleCompleteKey,
                                                  String resourceName,
                                                  UrlMode urlMode)

Deprecated.

Description copied from interface: WebResourceManager

A helper method to return a url for 'plugin' resources. Generally the implementation will return

/s/{build num}/{system counter}/{plugin version}/_/download/resources/plugin.key:module.key/resource.name

Note that the servlet context is prepended, and there is no trailing slash.

Typical usage is to replace:

<%= request.getContextPath() %>/download/resources/plugin.key:module.key/resource.name with <%= webResourceManager.getStaticPluginResource(descriptor, resourceName) %>

This method returns a URL in either a relative or an absolute format, depending on the value of urlMode. See UrlMode for details of the different options for URL format.

Specified by:

getStaticPluginResource in interface WebResourceManager

Parameters:

moduleCompleteKey - complete plugin module key

resourceName - the name of the resource as defined in the plugin manifest

urlMode - specifies whether to use absolute URLs, relative URLs, or allow the concrete implementation to decide

Returns:

A url that can be used to request 'plugin' resources.

getStaticPluginResource

@Deprecated
public String getStaticPluginResource(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor,
                                                  String resourceName,
                                                  UrlMode urlMode)

Deprecated.

Description copied from interface: WebResourceManager

A helper method to return a url for 'plugin' resources. Generally the implementation will return

/s/{build num}/{system counter}/{plugin version}/_/download/resources/plugin.key:module.key/resource.name

Note that the servlet context is prepended, and there is no trailing slash.

Typical usage is to replace:

<%= request.getContextPath() %>/download/resources/plugin.key:module.key/resource.name with <%= webResourceManager.getStaticPluginResource(descriptor, resourceName) %>

This method returns a URL in either a relative or an absolute format, depending on the value of urlMode. See UrlMode for details of the different options for URL format.

Specified by:

getStaticPluginResource in interface WebResourceManager

Parameters:

moduleDescriptor - plugin module descriptor that contains the resource

resourceName - the name of the resource as defined in the plugin manifest

urlMode - specifies whether to use absolute URLs, relative URLs, or allow the concrete implementation to decide

Returns:

"{base url}/s/{build num}/{system counter}/{plugin version}/_/download/resources/{plugin.key:module.key}/{resource.name}"

See Also:

WebResourceManager.getStaticPluginResource(String, String, UrlMode)

getStaticPluginResource

@Deprecated
public String getStaticPluginResource(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor,
                                                  String resourceName)

Deprecated.

Specified by:

getStaticPluginResource in interface WebResourceManager

getStaticPluginResource

@Deprecated
public String getStaticPluginResource(String moduleCompleteKey,
                                                  String resourceName)

Deprecated.

Specified by:

getStaticPluginResource in interface WebResourceManager

executeInNewContext

public <T> T executeInNewContext(com.google.common.base.Supplier<T> nestedExecution)

Deprecated.

Description copied from interface: WebResourceManager

Executes a Supplier within a new WebResourceManager context. The request-local state manipulated by requireResource and requireResourcesForContext is preserved, an empty state is initialized for the execution of nestedExecution and after the nestedExecution is run, the old state is restored. If no return is required from the nestedExecution then Supplier<Void> can be used. Useful for rendering of pages which include nested pages (such as gadgets), which need to resolve the requirements of the inner pages without polluting the outer page's resources.

Specified by:

executeInNewContext in interface WebResourceManager

Parameters:

nestedExecution - the code to be executed in the empty context.

Returns:

the value returned by nestedExection.get()

getRequestLocalAssembledResources

protected AssembledResources getRequestLocalAssembledResources()

Deprecated.

getRequestLocalRequiredResources

protected RequiredResources getRequestLocalRequiredResources()

Deprecated.

includeResources

public void includeResources(Writer writer)

Deprecated.

Specified by:

includeResources in interface WebResourceManager

getRequiredResources

public String getRequiredResources()

Deprecated.

Specified by:

getRequiredResources in interface WebResourceManager

requireResource

public void requireResource(String moduleCompleteKey,
                            Writer writer)

Deprecated.

Specified by:

requireResource in interface WebResourceManager

getResourceTags

public String getResourceTags(String moduleCompleteKey)

Deprecated.

Specified by:

getResourceTags in interface WebResourceManager

getStaticResourcePrefix

public String getStaticResourcePrefix()

Deprecated.

Specified by:

getStaticResourcePrefix in interface WebResourceManager

getStaticResourcePrefix

public String getStaticResourcePrefix(String resourceCounter)

Deprecated.

Specified by:

getStaticResourcePrefix in interface WebResourceManager