com.atlassian.confluence.plugin.webresource

Interface ConfluenceWebResourceService

All Known Implementing Classes:

DefaultConfluenceWebResourceService

public interface ConfluenceWebResourceService

Provides services related to writing Confluence html resource tags.

This service is meant to replace ConfluenceWebResourceManager that implements the now deprecated WebResourceManager interface.

Since:

5.5

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConfluenceWebResourceService.Style Style of a page.

Method Summary

Modifier and Type	Method and Description
Map<ResourceType,Iterable<String>>	computeConfluenceResourceUris(com.atlassian.fugue.Option<ConfluenceWebResourceService.Style> style, com.atlassian.fugue.Option<String> spaceKey) Computes the resource uris required by the given space.
void	writeConfluenceColorCssTags(Writer writer, ConfluenceWebResourceService.Style style, String spaceKey) Write color css resource tags to the given writer.
void	writeConfluenceCssTags(Writer writer, ConfluenceWebResourceService.Style style, String spaceKey) Write all css resource tags to the given writer.
void	writeConfluenceScriptTags(Writer writer, String spaceKey) Write all script resource tags to the given writer.

Method Detail

writeConfluenceCssTags

void writeConfluenceCssTags(@Nonnull
                            Writer writer,
                            @Nullable
                            ConfluenceWebResourceService.Style style,
                            @Nullable
                            String spaceKey)

Write all css resource tags to the given writer.

Parameters:

writer - writer to write the tags to

style - style to apply if any

spaceKey - current space if any

writeConfluenceColorCssTags

void writeConfluenceColorCssTags(@Nonnull
                                 Writer writer,
                                 @Nullable
                                 ConfluenceWebResourceService.Style style,
                                 @Nullable
                                 String spaceKey)

Write color css resource tags to the given writer.

Parameters:

writer - writer to write the tags to

style - style to apply if any

spaceKey - current space if any

writeConfluenceScriptTags

void writeConfluenceScriptTags(@Nonnull
                               Writer writer,
                               @Nullable
                               String spaceKey)

Write all script resource tags to the given writer.

Parameters:

writer - writer to write the tags to

spaceKey - current space if any

computeConfluenceResourceUris

Map<ResourceType,Iterable<String>> computeConfluenceResourceUris(com.atlassian.fugue.Option<ConfluenceWebResourceService.Style> style,
                                                                 com.atlassian.fugue.Option<String> spaceKey)

Computes the resource uris required by the given space. If null is given for spaceKey, then this method will not take space styles into account.

Parameters:

style - style to apply, or none() if not displaying an admin page.

spaceKey - current space or none() if not displaying in the context of a space

Returns:

a map of resource types to the list of uris of that type. The list of uris should be in a deterministic, and correct order.