com.atlassian.plugin.webresource.legacy

Interface ResourceDependencyResolver

All Known Implementing Classes:

DefaultResourceDependencyResolver

public interface ResourceDependencyResolver

Method Summary

Modifier and Type	Method and Description
Iterable<ModuleDescriptorStub>	getDependencies(RequestCache requestCache, UrlBuildingStrategy urlBuildingStrategy, String moduleKey, boolean excludeSuperBatchedResources, boolean includeDependenciesForFailedUrlReadingConditions) Returns an ordered set of the given resource and its dependencies.
Iterable<ModuleDescriptorStub>	getDependenciesInContext(RequestCache requestCache, UrlBuildingStrategy urlBuildingStrategy, String context, Set<String> skippedResources, boolean includeDependenciesForFailedUrlReadingConditions) Returns an ordered list of the resources in a given context and its dependencies.
Iterable<ModuleDescriptorStub>	getSuperBatchDependencies() Returns an ordered set of the super batch resources and its dependencies.

Method Detail

getSuperBatchDependencies

Iterable<ModuleDescriptorStub> getSuperBatchDependencies()

Returns an ordered set of the super batch resources and its dependencies. If no super batch resources are defined an empty set is returned. Implementations are expected to use the ResourceBatchingConfiguration provided.

Returns:

an ordered set of the super batch resources and its dependencies.

getDependencies

Iterable<ModuleDescriptorStub> getDependencies(RequestCache requestCache,
                                               UrlBuildingStrategy urlBuildingStrategy,
                                               String moduleKey,
                                               boolean excludeSuperBatchedResources,
                                               boolean includeDependenciesForFailedUrlReadingConditions)

Returns an ordered set of the given resource and its dependencies. To exclude resource dependencies in the super batch, pass excludeSuperBatchedResources as true. If the resources cannot be resolved an empty set is returned.

Parameters:

moduleKey - the complete module key of the web resource to retrieve dependencies for

excludeSuperBatchedResources - whether or not to exclude resources that are part of the super batch.

Returns:

an ordered set of the given resource and its dependencies

getDependenciesInContext

Iterable<ModuleDescriptorStub> getDependenciesInContext(RequestCache requestCache,
                                                        UrlBuildingStrategy urlBuildingStrategy,
                                                        @Nonnull
                                                        String context,
                                                        @Nonnull
                                                        Set<String> skippedResources,
                                                        boolean includeDependenciesForFailedUrlReadingConditions)

Returns an ordered list of the resources in a given context and its dependencies. Dependencies with conditions are not included and are added to the parameter skippedResources Resources also in the superbatch are not included. If no resources are defined for the given context an empty set is returned.

Parameters:

context - - the context to retrieve dependencies from.

skippedResources - - a list that all the resources that are skipped are added to.

Returns:

an ordered list of the resources in a given context and its dependencies.

Since:

2.9.0