com.atlassian.confluence.plugin.webresource

Class DefaultConfluenceWebResourceManager

java.lang.Object

com.atlassian.plugin.webresource.WebResourceManagerImpl

com.atlassian.confluence.plugin.webresource.DefaultConfluenceWebResourceManager

All Implemented Interfaces:

ConfluenceWebResourceManager, com.atlassian.plugin.webresource.WebResourceManager

public class DefaultConfluenceWebResourceManager
extends com.atlassian.plugin.webresource.WebResourceManagerImpl
implements ConfluenceWebResourceManager

Field Summary

Fields inherited from class com.atlassian.plugin.webresource.WebResourceManagerImpl

pageBuilderService, webResourceIntegration

Constructor Summary

Constructors

Constructor and Description
DefaultConfluenceWebResourceManager(com.atlassian.webresource.api.assembler.WebResourceAssemblerFactory webResourceAssemblerFactory, com.atlassian.plugin.webresource.assembler.LegacyPageBuilderService pageBuilderService, com.atlassian.plugin.webresource.PluginResourceLocator pluginResourceLocator, com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration, com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider, com.atlassian.plugin.webresource.ResourceBatchingConfiguration batchingConfiguration, com.atlassian.plugin.webresource.ResourceDependencyResolver resourceDependencyResolver, com.atlassian.plugin.PluginAccessor pluginAccessor, ResourceAccessor resourceAccessor, SettingsManager settingsManager, DefaultConfluenceWebResourceService confluenceWebResourceService) Deprecated. since 6.7.0
DefaultConfluenceWebResourceManager(com.atlassian.webresource.api.assembler.WebResourceAssemblerFactory webResourceAssemblerFactory, com.atlassian.plugin.webresource.assembler.LegacyPageBuilderService pageBuilderService, com.atlassian.plugin.webresource.PluginResourceLocator pluginResourceLocator, com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration, com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider, com.atlassian.plugin.webresource.ResourceBatchingConfiguration batchingConfiguration, com.atlassian.plugin.webresource.ResourceDependencyResolver resourceDependencyResolver, com.atlassian.plugin.PluginAccessor pluginAccessor, ResourceAccessor resourceAccessor, SettingsManager settingsManager, DefaultConfluenceWebResourceService confluenceWebResourceService, EditorContextCompatibility editorContextCompatibility)

Method Summary

Modifier and Type	Method and Description
String	getAdminCssResources()
String	getCssResources() Delegates to getCssResources(null)
String	getCssResources(String spaceKey) Returns the HTML output of WebResourceManager.includeResources(Writer, UrlMode, WebResourceFilter), which includes references to all the delayed CSS resources requested by WebResourceManager.requireResource(String).
String	getEditorCssResources(String spaceKey)
String	getGlobalCssResourcePrefix() Get the resource prefix for the global CSS file.
String	getJsResources() Returns the HTML output of WebResourceManager.includeResources(Writer, UrlMode, WebResourceFilter), which includes references to all the delayed Javascript resources requested by WebResourceManager.requireResource(String).
Map<String,String>	getMetadata() Returns the map of key-value pairs added via ConfluenceWebResourceManager.putMetadata(String, String).
String	getRequiredResources()
String	getResourceContent(String resourceName) Gets the content of a resource specified.
String	getResources() Returns the HTML output of WebResourceManager.includeResources(java.io.Writer, UrlMode), which includes references to all the delayed Javascript and CSS resources requested by WebResourceManager.requireResource(String).
String	getResourceTags(String moduleCompleteKey)
String	getResourceTagsForAdditionalContextsHtml(List<String> contexts) Create the HTML tags necessary for requesting the supplied contexts in addition to any contexts already requested of the WebResourceManager (using requireResourcesForContext(String)).
String	getSpaceCssPrefix(String spaceKey) Get the resource prefix for a particular space's CSS file.
String	getStaticResourcePrefix()
String	getStaticResourcePrefix(String resourceCounter)
String	getStaticResourcePrefix(String resourceCounter, com.atlassian.plugin.webresource.UrlMode urlMode)
String	getStaticResourcePrefix(com.atlassian.plugin.webresource.UrlMode urlMode)
String	getThemeJsResources(String spaceKey) Returns the script tags for the theme specific javascript resources.
void	includeResources(Writer writer)
boolean	putMetadata(String key, String value) Adds key-value String pairs to a map to be rendered later.
void	requireResource(String resourceName) Wraps the parent method to provide logging.
void	requireResource(String moduleCompleteKey, Writer writer)
void	requireResourcesForContext(String context) Requires all resources which have the given context specified in their descriptor

Methods inherited from class com.atlassian.plugin.webresource.WebResourceManagerImpl

executeInNewContext, getRequestLocalAssembledResources, getRequestLocalRequiredResources, getRequiredResources, getRequiredResources, getRequiredResources, getResourceTags, getStaticPluginResource, getStaticPluginResource, getStaticPluginResource, getStaticPluginResource, includeResources, includeResources, includeResources, requireResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.plugin.webresource.WebResourceManager

executeInNewContext, getRequiredResources, getRequiredResources, getResourceTags, getStaticPluginResource, getStaticPluginResource, getStaticPluginResource, getStaticPluginResource, includeResources, includeResources, includeResources, requireResource

Constructor Detail

DefaultConfluenceWebResourceManager

public DefaultConfluenceWebResourceManager(com.atlassian.webresource.api.assembler.WebResourceAssemblerFactory webResourceAssemblerFactory,
                                           com.atlassian.plugin.webresource.assembler.LegacyPageBuilderService pageBuilderService,
                                           com.atlassian.plugin.webresource.PluginResourceLocator pluginResourceLocator,
                                           com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration,
                                           com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider,
                                           com.atlassian.plugin.webresource.ResourceBatchingConfiguration batchingConfiguration,
                                           com.atlassian.plugin.webresource.ResourceDependencyResolver resourceDependencyResolver,
                                           com.atlassian.plugin.PluginAccessor pluginAccessor,
                                           ResourceAccessor resourceAccessor,
                                           SettingsManager settingsManager,
                                           DefaultConfluenceWebResourceService confluenceWebResourceService,
                                           EditorContextCompatibility editorContextCompatibility)

Since:

6.7.0

DefaultConfluenceWebResourceManager

@Deprecated
public DefaultConfluenceWebResourceManager(com.atlassian.webresource.api.assembler.WebResourceAssemblerFactory webResourceAssemblerFactory,
                                                       com.atlassian.plugin.webresource.assembler.LegacyPageBuilderService pageBuilderService,
                                                       com.atlassian.plugin.webresource.PluginResourceLocator pluginResourceLocator,
                                                       com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration,
                                                       com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider,
                                                       com.atlassian.plugin.webresource.ResourceBatchingConfiguration batchingConfiguration,
                                                       com.atlassian.plugin.webresource.ResourceDependencyResolver resourceDependencyResolver,
                                                       com.atlassian.plugin.PluginAccessor pluginAccessor,
                                                       ResourceAccessor resourceAccessor,
                                                       SettingsManager settingsManager,
                                                       DefaultConfluenceWebResourceService confluenceWebResourceService)

Deprecated. since 6.7.0

Method Detail

includeResources

public void includeResources(Writer writer)

Specified by:

includeResources in interface ConfluenceWebResourceManager

Specified by:

includeResources in interface com.atlassian.plugin.webresource.WebResourceManager

Overrides:

includeResources in class com.atlassian.plugin.webresource.WebResourceManagerImpl

getRequiredResources

public String getRequiredResources()

Specified by:

getRequiredResources in interface ConfluenceWebResourceManager

Specified by:

getRequiredResources in interface com.atlassian.plugin.webresource.WebResourceManager

Overrides:

getRequiredResources in class com.atlassian.plugin.webresource.WebResourceManagerImpl

requireResource

public void requireResource(String moduleCompleteKey,
                            Writer writer)

Specified by:

requireResource in interface ConfluenceWebResourceManager

Specified by:

requireResource in interface com.atlassian.plugin.webresource.WebResourceManager

Overrides:

requireResource in class com.atlassian.plugin.webresource.WebResourceManagerImpl

getResourceTags

public String getResourceTags(String moduleCompleteKey)

Specified by:

getResourceTags in interface ConfluenceWebResourceManager

Specified by:

getResourceTags in interface com.atlassian.plugin.webresource.WebResourceManager

Overrides:

getResourceTags in class com.atlassian.plugin.webresource.WebResourceManagerImpl

getStaticResourcePrefix

public String getStaticResourcePrefix()

Specified by:

getStaticResourcePrefix in interface ConfluenceWebResourceManager

Specified by:

getStaticResourcePrefix in interface com.atlassian.plugin.webresource.WebResourceManager

Overrides:

getStaticResourcePrefix in class com.atlassian.plugin.webresource.WebResourceManagerImpl

getStaticResourcePrefix

public String getStaticResourcePrefix(com.atlassian.plugin.webresource.UrlMode urlMode)

Specified by:

getStaticResourcePrefix in interface ConfluenceWebResourceManager

getStaticResourcePrefix

public String getStaticResourcePrefix(String resourceCounter)

Specified by:

getStaticResourcePrefix in interface ConfluenceWebResourceManager

Specified by:

getStaticResourcePrefix in interface com.atlassian.plugin.webresource.WebResourceManager

Overrides:

getStaticResourcePrefix in class com.atlassian.plugin.webresource.WebResourceManagerImpl

getStaticResourcePrefix

public String getStaticResourcePrefix(String resourceCounter,
                                      com.atlassian.plugin.webresource.UrlMode urlMode)

Specified by:

getStaticResourcePrefix in interface ConfluenceWebResourceManager

getResources

public String getResources()

Description copied from interface: ConfluenceWebResourceManager

Returns the HTML output of WebResourceManager.includeResources(java.io.Writer, UrlMode), which includes references to all the delayed Javascript and CSS resources requested by WebResourceManager.requireResource(String).

This is a convenience method for velocity templates and is equivalent to calling includeResources with UrlMode.AUTO and DefaultWebResourceFilter.

Specified by:

getResources in interface ConfluenceWebResourceManager

getCssResources

public String getCssResources()

Description copied from interface: ConfluenceWebResourceManager

Delegates to getCssResources(null)

Specified by:

getCssResources in interface ConfluenceWebResourceManager

See Also:

ConfluenceWebResourceManager.getCssResources(String)

getCssResources

public String getCssResources(String spaceKey)

Description copied from interface: ConfluenceWebResourceManager

Returns the HTML output of WebResourceManager.includeResources(Writer, UrlMode, WebResourceFilter), which includes references to all the delayed CSS resources requested by WebResourceManager.requireResource(String).

This method should only be called once for each request. Multiple calls to this method will result with null being returned.

This is a convenience method for velocity templates and is equivalent to calling includeResources with UrlMode.AUTO and CssWebResource.

Specified by:

getCssResources in interface ConfluenceWebResourceManager

Parameters:

spaceKey - spaceKey if null global theme is used.

getJsResources

public String getJsResources()

Description copied from interface: ConfluenceWebResourceManager

Returns the HTML output of WebResourceManager.includeResources(Writer, UrlMode, WebResourceFilter), which includes references to all the delayed Javascript resources requested by WebResourceManager.requireResource(String).

This method should only be called once for each request. Multiple calls to this method will result with null being returned.

This is a convenience method for velocity templates and is equivalent to calling includeResources with UrlMode.AUTO and JavascriptWebResource.

Specified by:

getJsResources in interface ConfluenceWebResourceManager

getThemeJsResources

public String getThemeJsResources(String spaceKey)

Description copied from interface: ConfluenceWebResourceManager

Returns the script tags for the theme specific javascript resources. If spaceKey is null or invalid, the globally configured theme resources are returned.

Specified by:

getThemeJsResources in interface ConfluenceWebResourceManager

requireResource

public void requireResource(String resourceName)

Wraps the parent method to provide logging.

Specified by:

requireResource in interface com.atlassian.plugin.webresource.WebResourceManager

Overrides:

requireResource in class com.atlassian.plugin.webresource.WebResourceManagerImpl

getGlobalCssResourcePrefix

public String getGlobalCssResourcePrefix()

Description copied from interface: ConfluenceWebResourceManager

Get the resource prefix for the global CSS file. This prefix should be updated every time there is a change to the global theme or colour scheme.

Specified by:

getGlobalCssResourcePrefix in interface ConfluenceWebResourceManager

getSpaceCssPrefix

public String getSpaceCssPrefix(String spaceKey)

Description copied from interface: ConfluenceWebResourceManager

Get the resource prefix for a particular space's CSS file. This prefix should be updated every time there is a change to the space's theme or colour scheme.

Specified by:

getSpaceCssPrefix in interface ConfluenceWebResourceManager

Parameters:

spaceKey - the key of the space we're viewing the CSS for, or null for the global CSS.

getResourceContent

public String getResourceContent(String resourceName)

Description copied from interface: ConfluenceWebResourceManager

Gets the content of a resource specified.

Specified by:

getResourceContent in interface ConfluenceWebResourceManager

Parameters:

resourceName - The fully qualified plugin name and resource to include (eg confluence.web.resources:legacy-styles)

Returns:

the content of the resource

putMetadata

public boolean putMetadata(String key,
                           String value)

Description copied from interface: ConfluenceWebResourceManager

Adds key-value String pairs to a map to be rendered later.

Specified by:

putMetadata in interface ConfluenceWebResourceManager

Parameters:

key - a unique key to store the value against

value - an HTML-safe string

Returns:

true if metadata added to map successfully

getMetadata

public Map<String,String> getMetadata()

Description copied from interface: ConfluenceWebResourceManager

Returns the map of key-value pairs added via ConfluenceWebResourceManager.putMetadata(String, String). Should report an error if called more than once in a request.

Specified by:

getMetadata in interface ConfluenceWebResourceManager

getAdminCssResources

public String getAdminCssResources()

Specified by:

getAdminCssResources in interface ConfluenceWebResourceManager

Returns:

the CSS for the admin pages. This should not include any custom/dangerous/user configured CSS

getEditorCssResources

public String getEditorCssResources(String spaceKey)

Specified by:

getEditorCssResources in interface ConfluenceWebResourceManager

Parameters:

spaceKey - space key to allow custom styling. Can be null to use global configured theme.

Returns:

link tags for all the CSS used by the editor iframe.

getResourceTagsForAdditionalContextsHtml

public String getResourceTagsForAdditionalContextsHtml(List<String> contexts)

Create the HTML tags necessary for requesting the supplied contexts in addition to any contexts already requested of the WebResourceManager (using requireResourcesForContext(String)).

This is intended to be useful in the case of storing in a page render the requests that will need to be made if you want to dynamically add additional contexts after the initial render. This doesn't form a complete solution to dynamically adding resources to a page which is the reason this method is not part of the public API.

Specified by:

getResourceTagsForAdditionalContextsHtml in interface ConfluenceWebResourceManager

Parameters:

contexts - the additional contexts to create tags for

Returns:

the HTML tags required to request the additional context resources

requireResourcesForContext

public void requireResourcesForContext(String context)

Description copied from interface: ConfluenceWebResourceManager

Requires all resources which have the given context specified in their descriptor

Specified by:

requireResourcesForContext in interface ConfluenceWebResourceManager

Specified by:

requireResourcesForContext in interface com.atlassian.plugin.webresource.WebResourceManager

Overrides:

requireResourcesForContext in class com.atlassian.plugin.webresource.WebResourceManagerImpl

Parameters:

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