Package com.atlassian.webresource.api

Interface WebResourceManager

public interface WebResourceManager

Manage 'css', 'javascript' and other 'resources' that are usually linked at the top of pages using <script> and <link> tags.

By using the WebResourceManager, components can declare dependencies on javascript and css that they would otherwise have to embed inline (which means that it can't be cached, and are often duplicated in a page).

Since:

6.3.0

See Also:

• PageBuilderService
• WebResourceAssembler
• WebResourceSet

Method Summary

Modifier and Type	Method	Description
String	getRequiredResources(UrlMode urlMode)	This is the equivalent of calling getRequiredResources(UrlMode, WebResourceFilter) with the given url mode and a default filter that is dependent on the implementation.
String	getRequiredResources(UrlMode urlMode, WebResourceFilter webResourceFilter)	Returns the resource tags for the previously required resources called via requireResource(String) that match the specified web resource filter.
String	getResourceTags(String moduleCompleteKey, UrlMode urlMode)	Returns the resource tags of the specified resource.
void	includeResources(Writer writer, UrlMode urlMode)	This is the equivalent of calling includeResources(Writer, UrlMode, WebResourceFilter) with the given url mode and a default web resource filter that is dependent on the implementation.
void	includeResources(Writer writer, UrlMode urlMode, WebResourceFilter webResourceFilter)	Writes out the resource tags to the previously required resources called via requireResource(String) for the specified resource type.
void	includeResources(Iterable<String> moduleCompleteKeys, Writer writer, UrlMode urlMode)	Writes out the resource tags for a specified set of required resources and their dependencies.
void	requireResource(String moduleCompleteKey)	Indicates that a given plugin web resource is required.
void	requireResource(String moduleCompleteKey, Writer writer, UrlMode urlMode)	Writes the resource tags of the specified resource to the writer.
void	requireResourcesForContext(String context)	Writes the resource tags of all resources that have the given context specified in their descriptor.

Method Details

requireResource

void requireResource(String moduleCompleteKey)

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

Parameters:

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

See Also:

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

includeResources

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

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 requireResource(String).

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

Since:

2.4.0

includeResources

void includeResources(Writer writer,
 UrlMode urlMode)

This is the equivalent of calling includeResources(Writer, UrlMode, WebResourceFilter) with the given url mode and a default web resource filter that is dependent on the implementation.

Since:

2.3.0

See Also:

• includeResources(Writer, UrlMode, WebResourceFilter)
• WebResourceSet.writeHtmlTags(Writer, UrlMode)

includeResources

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

Writes out the resource tags to the previously required resources called via requireResource(String) for the specified resource type. If you need it as a String to embed the tags in a template, use getRequiredResources(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.

Parameters:

writer - the writer to write the links to

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

webResourceFilter - the web resource filter to filter resources on

Since:

2.4

See Also:

• WebResourceSet.writeHtmlTags(Writer, UrlMode, Predicate)

getRequiredResources

String getRequiredResources(UrlMode urlMode)

This is the equivalent of calling getRequiredResources(UrlMode, WebResourceFilter) with the given url mode and a default filter that is dependent on the implementation.

Returns:

the resource tags for all resources previously required

Since:

2.3.1

See Also:

• includeResources(Writer, UrlMode)
• getRequiredResources(UrlMode, WebResourceFilter)
• WebResourceSet.writeHtmlTags(Writer, UrlMode)

getRequiredResources

String getRequiredResources(UrlMode urlMode,
 WebResourceFilter webResourceFilter)

Returns the resource tags for the previously required resources called via requireResource(String) that match the specified web resource filter. If you are outputting the value to a Writer, use includeResources(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.

Parameters:

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

webResourceFilter - the web resource filter to filter resources on

Returns:

the resource tags for all resources previously required

Since:

2.4

See Also:

• includeResources(Writer, UrlMode, WebResourceFilter)
• WebResourceSet.writeHtmlTags(Writer, UrlMode, Predicate)

requireResource

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

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 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.

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

Since:

2.3.0

requireResourcesForContext

void requireResourcesForContext(String context)

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

Parameters:

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

Since:

2.5.0

See Also:

• RequiredResources.requireContext(String)

getResourceTags

String getResourceTags(String moduleCompleteKey,
 UrlMode urlMode)

Returns the resource tags of the specified resource. If you are outputting the value to a Writer, use requireResource(String, 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.

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

Since:

2.3.0

See Also:

• requireResource(String, Writer, UrlMode)