com.atlassian.plugin.webresource
Interface PluginResourceLocator

All Known Implementing Classes:

PluginResourceLocatorImpl

public interface PluginResourceLocator

Assists in locating plugin resources in different ways.

Since:

2.2

Field Summary

static java.lang.String[]

BATCH_PARAMS

Method Summary

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

Field Detail

BATCH_PARAMS

static final java.lang.String[] BATCH_PARAMS

Method Detail

matches

boolean matches(java.lang.String url)

Returns true if this locator can parse the given url.

getDownloadableResource

DownloadableResource getDownloadableResource(java.lang.String url,
                                             java.util.Map<java.lang.String,java.lang.String> queryParams)

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

getPluginResources

java.util.List<PluginResource> getPluginResources(java.lang.String moduleCompleteKey)

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.

getResourceUrl

java.lang.String getResourceUrl(java.lang.String pluginModuleKey,
                                java.lang.String resourceName)

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

Parameters:

pluginModuleKey - a plugin module's complete key

resourceName - the name of the resource described in the module