com.atlassian.plugin.webresource.legacy

Class LegacyUrlGenerationHelpers

java.lang.Object

com.atlassian.plugin.webresource.legacy.LegacyUrlGenerationHelpers

public class LegacyUrlGenerationHelpers
extends Object

Nested Class Summary

Nested Classes

Modifier and Type

Class and Description

static class

LegacyUrlGenerationHelpers.Resolved DTO representing three collections: 1) ordered list of context batches to serve, 2) ordered list of web resource batches to serve, and 3) unordered "excluded resolved" list, which is a combination of all web resources and contexts discovered in the dependency graph while constructing the first two lists, whose content will either be served in these batch files or was omitted from them.

Constructor Summary

Constructors

Constructor and Description
LegacyUrlGenerationHelpers()

Method Summary

Modifier and Type	Method and Description
static LegacyUrlGenerationHelpers.Resolved	calculateBatches(RequestCache requestCache, UrlBuildingStrategy urlBuildingStrategy, Collection<String> topLevelIncluded, Collection<String> excludedResolved, boolean includeDependenciesForFailedUrlReadingConditions) Deprecated. since 5.5.0. Use calculateBatches(RequestCache, UrlBuildingStrategy, Collection, Collection, Set, boolean) instead.
static LegacyUrlGenerationHelpers.Resolved	calculateBatches(RequestCache requestCache, UrlBuildingStrategy urlBuildingStrategy, Collection<String> topLevelIncluded, Collection<String> allExcluded, Set<String> topLevelExcluded, boolean includeDependenciesForFailedUrlReadingConditions) Groups given web resources and contexts in to batches, taking any content that has already been served in to account.

Methods inherited from class java.lang.Object

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

Constructor Detail

LegacyUrlGenerationHelpers

public LegacyUrlGenerationHelpers()

Method Detail

calculateBatches

public static LegacyUrlGenerationHelpers.Resolved calculateBatches(RequestCache requestCache,
                                                                   UrlBuildingStrategy urlBuildingStrategy,
                                                                   Collection<String> topLevelIncluded,
                                                                   Collection<String> excludedResolved,
                                                                   boolean includeDependenciesForFailedUrlReadingConditions)

Deprecated. since 5.5.0. Use calculateBatches(RequestCache, UrlBuildingStrategy, Collection, Collection, Set, boolean) instead.

calculateBatches

public static LegacyUrlGenerationHelpers.Resolved calculateBatches(RequestCache requestCache,
                                                                   UrlBuildingStrategy urlBuildingStrategy,
                                                                   Collection<String> topLevelIncluded,
                                                                   Collection<String> allExcluded,
                                                                   Set<String> topLevelExcluded,
                                                                   boolean includeDependenciesForFailedUrlReadingConditions)

Groups given web resources and contexts in to batches, taking any content that has already been served in to account.

Parameters:

requestCache - request cache.

urlBuildingStrategy - how conditions and transformers contribute to generated URLs.

topLevelIncluded - the "entry point" web resources and contexts the client has requested.

topLevelExcluded - the "entry point" web resources and contexts that were explicitly excluded from the request by the client. Used to encode in batch URLs

allExcluded - all web resources discoverable through the topLevelExcluded set. This should be a superset of topLevelExcluded - that is, all "entry point" web-resources and contexts should also be present here. Used to determine what has already been served to the client and avoid re-serving the same content.

Returns:

a LegacyUrlGenerationHelpers.Resolved that represents the batch groups to serve to the client, along with a list of all items that should be omitted from subsequent client requests.