com.atlassian.plugin.webresource.cdn.mapper

Interface WebResourceMapper

All Known Implementing Classes:

MemoryLocalWebResourceMapper, NoOpWebResourceMapper

public interface WebResourceMapper

Web resource mappings, i.e., URL transformations from local to pre-baked resources on CDN. Products should implement or use the default MemoryLocalWebResourceMapper.

Since:

v3.5.0

Method Summary

Modifier and Type	Method and Description
List<String>	map(String resourceUrl) Maps a local resource URL into a CDN-based URL list (a local resource could be mapped into multiple CDN resources).
MappingSet	mappings() Inspects mappings used by one instance.
Optional<String>	mapSingle(String resourceUrl) Maps a local resource URL into a CDN-based URL.

Method Detail

map

@Nonnull
List<String> map(@Nonnull
                          String resourceUrl)

Maps a local resource URL into a CDN-based URL list (a local resource could be mapped into multiple CDN resources).

For instance, it would transform a URL like /jira/my/resource/hash/batch.js into one or more domain-relative URLs like //my.cdn.com/my/resource/hash/batch.js.

Parameters:

resourceUrl - URL of wanted web resource (includes context).

Returns:

CDN-based URLs of local mapped resources, if any, otherwise returns an empty list.

mapSingle

@Nonnull
Optional<String> mapSingle(@Nonnull
                                    String resourceUrl)

Maps a local resource URL into a CDN-based URL.

For instance, it would transform a URL like /jira/my/resource/hash/batch.js into a domain-relative URL like //my.cdn.com/my/resource/hash/batch.js.

Parameters:

resourceUrl - URL of wanted web resource (includes context).

Returns:

Single CDN-based URL of a local mapped resource, if any, otherwise returns an empty list.

mappings

@Nonnull
MappingSet mappings()

Inspects mappings used by one instance.

Returns:

Current loaded mappings for this instance.

Since:

v3.5.7