com.atlassian.plugin.webresource.impl.helpers

Class UrlGenerationHelpers

java.lang.Object

com.atlassian.plugin.webresource.impl.helpers.BaseHelpers

com.atlassian.plugin.webresource.impl.helpers.UrlGenerationHelpers

Direct Known Subclasses:

ResourceServingHelpers

public class UrlGenerationHelpers
extends BaseHelpers

Stateless helper functions providing basic support for resource url generation.

Since:

v3.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UrlGenerationHelpers.CalculatedBatches DTO.
static class	UrlGenerationHelpers.ContextBatch Data structure representing Context Batch, it is used in cache and shouldn't contain any references.
static class	UrlGenerationHelpers.ContextBatchKey Data structure representing Web Resource Batch Key.
static class	UrlGenerationHelpers.ParamsComparator Comparator for sorting sub batches.
static class	UrlGenerationHelpers.Resolved DTO.
protected static class	UrlGenerationHelpers.SplitSubBatches Temporary data structure used during splitting batches into sub batches.
static class	UrlGenerationHelpers.SubBatch Data structure representing Sub Batch of both Web Resource Batch and Context Batch, it is used in cache and shouldn't contain any references.
static class	UrlGenerationHelpers.WebResourceBatch Data structure representing Web Resource Batch, it is used in cache and shouldn't contain any references.

Nested classes/interfaces inherited from class com.atlassian.plugin.webresource.impl.helpers.BaseHelpers

BaseHelpers.BundleFinder, BaseHelpers.Found, BaseHelpers.ResourceFinder

Constructor Summary

Constructors

Constructor and Description
UrlGenerationHelpers()

Method Summary

Modifier and Type	Method and Description
protected static LinkedHashMap<String,com.atlassian.json.marshal.Jsonable>	buildDataResources(RequestState requestState, List<String> webResourceKeys) Build data resources.
protected static UrlCache.IncludedExcludedConditionsAndBatchingOptions	buildIncludedExcludedConditionsAndBatchingOptions(RequestCache requestCache, UrlBuildingStrategy urlBuilderStrategy, LinkedHashSet<String> included, LinkedHashSet<String> excluded) Building the cache key of included, excluded and conditions.
protected static UrlGenerationHelpers.CalculatedBatches	calculateBatches(RequestCache requestCache, UrlBuildingStrategy urlBuilderStrategy, LinkedHashSet<String> included, LinkedHashSet<String> excluded) Calculate batches.
protected static List<ResourceUrl>	collectUrlStateAndBuildResourceUrls(RequestState requestState, UrlBuildingStrategy urlBuilderStrategy, List<UrlGenerationHelpers.ContextBatch> contextBatches, List<UrlGenerationHelpers.WebResourceBatch> webResourceBatches) Collect URL State for Conditions and Transformers and build Resource URLs.
protected static List<ResourceUrl>	createResourceUrlsForRedirectResources(RequestCache requestCache, UrlBuildingStrategy urlBuilderStrategy, List<Resource> resources) Creates Resource URLs for redirect resources.
protected static com.atlassian.plugin.webresource.impl.helpers.StateEncodedUrlResult	encodeStateInUrlIfSupported(RequestCache requestCache, UrlBuildingStrategy urlBuilderStrategy, String type, Map<String,String> params, Bundle bundle, List<Bundle> skipped, List<Bundle> excludedWithoutApplyingConditions) Collect and encode URL state for given Resources, it collects resource params, condition params and transformer params.
protected static com.atlassian.plugin.webresource.impl.helpers.StateEncodedUrlResult	encodeStateInUrlIfSupported(RequestCache requestCache, UrlBuildingStrategy urlBuilderStrategy, String type, Map<String,String> params, List<Bundle> bundles, List<Bundle> skipped, List<Bundle> excludedWithoutApplyingConditions) Collect and encode URL state for given Resources, it collects resource params, condition params and transformer params.
protected static Set<CachedCondition>	getConditions(RequestCache requestCache, UrlCache.IncludedAndExcluded includedAndExcluded, UrlBuildingStrategy urlBuilderStrategy) Get web resources with conditions, the subset of the resolve web resources for given set of included and excluded.
static UrlGenerationHelpers.Resolved	resolve(RequestState requestState) Resolve given included and excluded resources.
static LinkedHashSet<String>	resolveExcluded(RequestCache requestCache, UrlBuildingStrategy urlBuilderStrategy, List<String> allIncluded, LinkedHashSet<String> allExcluded) Resolves list of excluded resources.
static List<Resource>	resourcesOfType(Collection<Resource> resources, String type) Get resources of given type.
protected static UrlGenerationHelpers.SplitSubBatches	splitBatchIntoSubBatches(RequestCache requestCache, Iterable<String> completeKeys, boolean doSorting) Split batch into sub batches and standalone resources, same code used to split both context and resource batches.
protected static Tuple<List<UrlGenerationHelpers.ContextBatch>,List<UrlGenerationHelpers.WebResourceBatch>>	splitIntoSubBatches(RequestCache requestCache, UrlBuildingStrategy urlBuilderStrategy, List<UrlGenerationHelpers.ContextBatchKey> contextBatchKeys, List<String> webResourceBatchKeys) Split batches into sub batches grouped by URL parameters and set of standalone resources.

Methods inherited from class com.atlassian.plugin.webresource.impl.helpers.BaseHelpers

find, find, findItChangesArguments, getResources, hasConditions, hasLegacyCondition, isConditionsSatisfied, isConditionsSatisfied

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlGenerationHelpers

public UrlGenerationHelpers()

Method Detail

resolve

public static UrlGenerationHelpers.Resolved resolve(RequestState requestState)

Resolve given included and excluded resources.

Returns:

data resources, url resources, resolved excluded resources.

buildIncludedExcludedConditionsAndBatchingOptions

protected static UrlCache.IncludedExcludedConditionsAndBatchingOptions buildIncludedExcludedConditionsAndBatchingOptions(RequestCache requestCache,
                                                                                                                         UrlBuildingStrategy urlBuilderStrategy,
                                                                                                                         LinkedHashSet<String> included,
                                                                                                                         LinkedHashSet<String> excluded)

Building the cache key of included, excluded and conditions.

getConditions

protected static Set<CachedCondition> getConditions(RequestCache requestCache,
                                                    UrlCache.IncludedAndExcluded includedAndExcluded,
                                                    UrlBuildingStrategy urlBuilderStrategy)

Get web resources with conditions, the subset of the resolve web resources for given set of included and excluded.

resolveExcluded

public static LinkedHashSet<String> resolveExcluded(RequestCache requestCache,
                                                    UrlBuildingStrategy urlBuilderStrategy,
                                                    List<String> allIncluded,
                                                    LinkedHashSet<String> allExcluded)

Resolves list of excluded resources.

Parameters:

requestCache - request cache.

allIncluded - included web resources and contexts.

allExcluded - excluded web resources and contexts.

Returns:

list of actually excluded web resources and contexts.

calculateBatches

protected static UrlGenerationHelpers.CalculatedBatches calculateBatches(RequestCache requestCache,
                                                                         UrlBuildingStrategy urlBuilderStrategy,
                                                                         LinkedHashSet<String> included,
                                                                         LinkedHashSet<String> excluded)

Calculate batches.

buildDataResources

protected static LinkedHashMap<String,com.atlassian.json.marshal.Jsonable> buildDataResources(RequestState requestState,
                                                                                              List<String> webResourceKeys)

Build data resources.

collectUrlStateAndBuildResourceUrls

protected static List<ResourceUrl> collectUrlStateAndBuildResourceUrls(RequestState requestState,
                                                                       UrlBuildingStrategy urlBuilderStrategy,
                                                                       List<UrlGenerationHelpers.ContextBatch> contextBatches,
                                                                       List<UrlGenerationHelpers.WebResourceBatch> webResourceBatches)

Collect URL State for Conditions and Transformers and build Resource URLs.

Returns:

list of Resource URLs.

splitIntoSubBatches

protected static Tuple<List<UrlGenerationHelpers.ContextBatch>,List<UrlGenerationHelpers.WebResourceBatch>> splitIntoSubBatches(RequestCache requestCache,
                                                                                                                                UrlBuildingStrategy urlBuilderStrategy,
                                                                                                                                List<UrlGenerationHelpers.ContextBatchKey> contextBatchKeys,
                                                                                                                                List<String> webResourceBatchKeys)

Split batches into sub batches grouped by URL parameters and set of standalone resources.

Parameters:

contextBatchKeys - keys of context batches

webResourceBatchKeys - keys of web resource batches.

Returns:

context batches and web resource batches split into sub batches.

splitBatchIntoSubBatches

protected static UrlGenerationHelpers.SplitSubBatches splitBatchIntoSubBatches(RequestCache requestCache,
                                                                               Iterable<String> completeKeys,
                                                                               boolean doSorting)

Split batch into sub batches and standalone resources, same code used to split both context and resource batches.

Parameters:

completeKeys - list of complete keys that the batch contains.

doSorting - some legacy stuff, in some cases it sorted in some not.

Returns:

batch split into sub batches and

resourcesOfType

public static List<Resource> resourcesOfType(Collection<Resource> resources,
                                             String type)

Get resources of given type.

encodeStateInUrlIfSupported

protected static com.atlassian.plugin.webresource.impl.helpers.StateEncodedUrlResult encodeStateInUrlIfSupported(RequestCache requestCache,
                                                                                                                 UrlBuildingStrategy urlBuilderStrategy,
                                                                                                                 String type,
                                                                                                                 Map<String,String> params,
                                                                                                                 Bundle bundle,
                                                                                                                 List<Bundle> skipped,
                                                                                                                 List<Bundle> excludedWithoutApplyingConditions)

Collect and encode URL state for given Resources, it collects resource params, condition params and transformer params.

encodeStateInUrlIfSupported

protected static com.atlassian.plugin.webresource.impl.helpers.StateEncodedUrlResult encodeStateInUrlIfSupported(RequestCache requestCache,
                                                                                                                 UrlBuildingStrategy urlBuilderStrategy,
                                                                                                                 String type,
                                                                                                                 Map<String,String> params,
                                                                                                                 List<Bundle> bundles,
                                                                                                                 List<Bundle> skipped,
                                                                                                                 List<Bundle> excludedWithoutApplyingConditions)

Collect and encode URL state for given Resources, it collects resource params, condition params and transformer params.

createResourceUrlsForRedirectResources

protected static List<ResourceUrl> createResourceUrlsForRedirectResources(RequestCache requestCache,
                                                                          UrlBuildingStrategy urlBuilderStrategy,
                                                                          List<Resource> resources)

Creates Resource URLs for redirect resources.