com.atlassian.plugin.webresource

Class WebResourceModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

com.atlassian.plugin.webresource.WebResourceModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<Void>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public class WebResourceModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

A way of linking to web 'resources', such as javascript or css. This allows us to include resources once on any given page, as well as ensuring that plugins can declare resources, even if they are included at the bottom of a page.

Field Summary

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources

Constructor Summary

Constructors

Constructor and Description
WebResourceModuleDescriptor(com.atlassian.plugin.hostcontainer.HostContainer hostContainer) Deprecated. Since 3.0.0 - use WebResourceModuleDescriptor(com.atlassian.plugin.module.ModuleFactory, com.atlassian.plugin.hostcontainer.HostContainer)
WebResourceModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory, com.atlassian.plugin.hostcontainer.HostContainer hostContainer)

Method Summary

Modifier and Type	Method and Description
boolean	canEncodeStateIntoUrl()
void	disabled()
void	enabled()
Set<String>	getAsyncContextDependencies() Returns the set of contexts that will be required asynchronously by the root page.
Set<String>	getAsyncDependencies() Returns the set of web resources that will be required asynchronously by the root page.
DecoratingCondition	getCondition()
Set<String>	getContextDependencies() Returns the set of contexts that this resource depends on.
Set<String>	getContexts() Returns the web resource contexts this resource is associated with.
Map<String,WebResourceDataProvider>	getDataProviders()
List<String>	getDependencies() Returns a list of dependencies on other web resources.
Set<String>	getDeprecatedConditionKeys() Deprecated. in 3.0.5
Set<String>	getDeprecatedTransformKeys(TransformerCache transformerCache) Deprecated. in 3.0.5
Deprecation	getDeprecation()
Void	getModule() As this descriptor just handles resources, you should never call this
List<String>	getModuleDependencies() Returns a list of dependencies on other web resources.
List<WebResourceTransformation>	getTransformations()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
boolean	isDeprecated()
boolean	isDisableMinification()
boolean	isRootPage() Returns an Option of the RootPage object.
static DecoratingCondition	parseCondition(UrlReadingConditionElementParser conditionElementParser, com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
static List<WebResourceTransformation>	parseTransformations(org.dom4j.Element element) Parse transformations.
boolean	shouldDisplay(QueryParams params)
boolean	shouldDisplayImmediate()

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

getDisplayName

Constructor Detail

WebResourceModuleDescriptor

@Deprecated
public WebResourceModuleDescriptor(com.atlassian.plugin.hostcontainer.HostContainer hostContainer)

Deprecated. Since 3.0.0 - use WebResourceModuleDescriptor(com.atlassian.plugin.module.ModuleFactory, com.atlassian.plugin.hostcontainer.HostContainer)

WebResourceModuleDescriptor

public WebResourceModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory,
                                   com.atlassian.plugin.hostcontainer.HostContainer hostContainer)

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<Void>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

Throws:

com.atlassian.plugin.PluginParseException

parseTransformations

public static List<WebResourceTransformation> parseTransformations(org.dom4j.Element element)

Parse transformations.

getModule

public Void getModule()

As this descriptor just handles resources, you should never call this

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<Void>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

parseCondition

public static DecoratingCondition parseCondition(UrlReadingConditionElementParser conditionElementParser,
                                                 com.atlassian.plugin.Plugin plugin,
                                                 org.dom4j.Element element)

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

isDeprecated

public boolean isDeprecated()

getDeprecation

public Deprecation getDeprecation()

getContexts

public Set<String> getContexts()

Returns the web resource contexts this resource is associated with.

Returns:

the web resource contexts this resource is associated with.

Since:

2.5.0

getDependencies

public List<String> getDependencies()

Returns a list of dependencies on other web resources.

Returns:

a list of module complete keys

getModuleDependencies

public List<String> getModuleDependencies()

Returns a list of dependencies on other web resources.

Returns:

a list of module complete keys

Since:

3.4.8

isRootPage

public boolean isRootPage()

Returns an Option of the RootPage object.

Returns:

an Option of the RootPage object

getContextDependencies

public Set<String> getContextDependencies()

Returns the set of contexts that this resource depends on.

Returns:

the set of contexts that this resource depends on

Since:

3.5.9

getAsyncDependencies

public Set<String> getAsyncDependencies()

Returns the set of web resources that will be required asynchronously by the root page.

Returns:

the set of web resources that will be required asynchronously by the root page

Since:

3.5.9

getAsyncContextDependencies

public Set<String> getAsyncContextDependencies()

Returns the set of contexts that will be required asynchronously by the root page.

Returns:

the set of contexts that will be required asynchronously by the root page

Since:

3.5.9

getTransformations

public List<WebResourceTransformation> getTransformations()

getCondition

public DecoratingCondition getCondition()

isDisableMinification

public boolean isDisableMinification()

Returns:

true if resource minification should be skipped, false otherwise.

canEncodeStateIntoUrl

public boolean canEncodeStateIntoUrl()

Returns:

true if this resource's conditions can fully encode themselves into the URL, false if they can't.

shouldDisplay

public boolean shouldDisplay(QueryParams params)

Parameters:

params - querystring params

Returns:

true if this resource should be displayed for the given query parameters, otherwise false

shouldDisplayImmediate

public boolean shouldDisplayImmediate()

Returns:

True if this web resource should be displayed based on the optional condition

Since:

2.7.0

getDataProviders

public Map<String,WebResourceDataProvider> getDataProviders()

Returns:

data providers specified by this web-resource

Since:

3.0

getDeprecatedConditionKeys

@Deprecated
public Set<String> getDeprecatedConditionKeys()

Deprecated. in 3.0.5

Returns all condition-1 keys used by this descriptor. This is a temporary method, used to extract all condition1's in a running instance.

getDeprecatedTransformKeys

@Deprecated
public Set<String> getDeprecatedTransformKeys(TransformerCache transformerCache)

Deprecated. in 3.0.5

Returns all transform-1 keys used by this descriptor. This is a temporary method, used to extract all transform1's in a running instance.