com.atlassian.plugin.webresource
Class PluginResourceLocatorImpl

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

All Implemented Interfaces:

PluginResourceLocator

public class PluginResourceLocatorImpl
extends Object
implements PluginResourceLocator

Default implementation of PluginResourceLocator.

Since:

2.2

Field Summary

Fields inherited from interface com.atlassian.plugin.webresource.PluginResourceLocator

BATCH_PARAMS

Constructor Summary

PluginResourceLocatorImpl(WebResourceIntegration webResourceIntegration, ServletContextFactory servletContextFactory, WebResourceUrlProvider webResourceUrlProvider)

PluginResourceLocatorImpl(WebResourceIntegration webResourceIntegration, ServletContextFactory servletContextFactory, WebResourceUrlProvider webResourceUrlProvider, ResourceBatchingConfiguration batchingConfiguration)

Method Summary

DownloadableResource	getDownloadableResource(String url, Map<String,String> queryParams) Returns a DownloadableResource represented by the given url and query params.
List<PluginResource>	getPluginResources(String moduleCompleteKey) Returns a list of PluginResources for a given plugin module's complete key.
String	getResourceUrl(String moduleCompleteKey, String resourceName) Constructs and returns url for the given resource.
boolean	matches(String url) Returns true if this locator can parse the given url.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginResourceLocatorImpl

public PluginResourceLocatorImpl(WebResourceIntegration webResourceIntegration,
                                 ServletContextFactory servletContextFactory,
                                 WebResourceUrlProvider webResourceUrlProvider)

PluginResourceLocatorImpl

public PluginResourceLocatorImpl(WebResourceIntegration webResourceIntegration,
                                 ServletContextFactory servletContextFactory,
                                 WebResourceUrlProvider webResourceUrlProvider,
                                 ResourceBatchingConfiguration batchingConfiguration)

Method Detail

matches

public boolean matches(String url)

Description copied from interface: PluginResourceLocator

Returns true if this locator can parse the given url.

Specified by:

matches in interface PluginResourceLocator

getDownloadableResource

public DownloadableResource getDownloadableResource(String url,
                                                    Map<String,String> queryParams)

Description copied from interface: PluginResourceLocator

Returns a DownloadableResource represented by the given url and query params. PluginResourceLocator.matches(String) should be called before invoking this method. If the url is not understood by the locator or the resource cannot be found, null will be returned.

Specified by:

getDownloadableResource in interface PluginResourceLocator

getPluginResources

public List<PluginResource> getPluginResources(String moduleCompleteKey)

Description copied from interface: PluginResourceLocator

Returns a list of PluginResources for a given plugin module's complete key. If the plugin the module belongs to is not enabled or does not exist, an empty list is returned.

Specified by:

getPluginResources in interface PluginResourceLocator

getResourceUrl

public String getResourceUrl(String moduleCompleteKey,
                             String resourceName)

Description copied from interface: PluginResourceLocator

Constructs and returns url for the given resource. This method is not responsible for adding any static caching url prefixes.

Specified by:

getResourceUrl in interface PluginResourceLocator

Parameters:

moduleCompleteKey - a plugin module's complete key

resourceName - the name of the resource described in the module