Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Interfaces

Interface and Description
com.atlassian.plugin.webresource.assembler.LegacyPageBuilderService since 3.0. This only exists to support the broken behaviour of WebResourceManagerImpl.
com.atlassian.plugin.webresource.PluginResourceLocator since 3.3.2
com.atlassian.plugin.webresource.ResourceDependencyResolver since v3.3.2
com.atlassian.plugin.webresource.WebResourceManager since 3.0. WebResourceManager has been superseded by PageBuilderService.
com.atlassian.plugin.webresource.transformer.WebResourceTransformer since 3.0. Use WebResourceTransformerFactory, will be removed at next major version (6.0.0)

Deprecated Classes

Class and Description
com.atlassian.plugin.webresource.transformer.CompileTimeTransformer This class is deprecated due to the fact that it mislead the developer to assume that it is a transform, but that is not.
com.atlassian.plugin.webresource.DefaultResourceDependencyResolver since 3.3.2
com.atlassian.plugin.webresource.prebake.DimensionUnawareOverride
com.atlassian.plugin.webresource.prebake.DimensionUnawareOverride.DimensionOverride
com.atlassian.plugin.webresource.models.LooselyTypedRequestExpander A short-term refactoring measure that puts a strong type around poor ones. Any usage of this class should be replaced with NormalizedRequest.
com.atlassian.plugin.webresource.PluginResourceLocatorImpl since 3.3.2
com.atlassian.plugin.webresource.transformer.SearchAndReplaceDownloadableResource Since 3.0.10. See SearchAndReplacer
com.atlassian.plugin.webresource.transformer.SearchAndReplacer Since 3.0.10. This class' purpose is to enable web-resource transforms that do search and replace on javascript files, eg to insert json data. All clients using this technique should move to the page data api.
com.atlassian.plugin.webresource.transformer.TransformerParametersFactory
com.atlassian.plugin.webresource.WebResourceManagerImpl
com.atlassian.plugin.webresource.transformer.WebResourceTransformerModuleDescriptor since 3.0. Use WebResourceTransformerFactory

Deprecated Fields

Field and Description
com.atlassian.plugin.webresource.impl.config.Config.CONDITIONAL_COMMENT_PARAM_NAME Since v4.0. Will be removed in v5.0.
com.atlassian.plugin.webresource.impl.config.Config.IEONLY_PARAM_NAME Since v4.0. Will be removed in v5.0.
com.atlassian.plugin.webresource.transformer.instance.RelativeUrlTransformerFactory.RELATIVE_URL_QUERY_KEY since 4.2.1 without a replacement. Used only for deprecated relative to absolute resource URL conversions.
com.atlassian.plugin.webresource.WebResourceManagerImpl.webResourceIntegration

Deprecated Methods

Method and Description
com.atlassian.plugin.webresource.legacy.LegacyUrlGenerationHelpers.calculateBatches(RequestCache, UrlBuildingStrategy, Collection<String>, Collection<String>, boolean) since 5.5.0. Use LegacyUrlGenerationHelpers.calculateBatches(RequestCache, UrlBuildingStrategy, Collection, Collection, Set, boolean) instead.
com.atlassian.plugin.webresource.impl.helpers.url.UrlGenerationHelpers.calculateBatches(RequestCache, UrlBuildingStrategy, LinkedHashSet<String>, LinkedHashSet<String>) since 5.5.0. Use UrlGenerationHelpers.calculateBatches(RequestCache, UrlBuildingStrategy, LinkedHashSet, LinkedHashSet, Set) instead.
com.atlassian.plugin.webresource.impl.support.http.BaseRouter.canDispatch(String) since 3.3.2
com.atlassian.plugin.webresource.impl.support.http.Response.checkRequestHelper(LastModifiedHandler)
com.atlassian.plugin.webresource.assembler.DefaultWebResourceAssemblerFactory.clearCache() since 3.3.2
com.atlassian.plugin.webresource.assembler.LegacyPageBuilderService.clearRequestLocal() since 3.0. This only exists to support the broken behaviour of WebResourceManagerImpl.
com.atlassian.plugin.webresource.impl.snapshot.resource.ResourceFactory.createResourceWithRelativePath(Bundle, ResourceLocation, String, String, String)
com.atlassian.plugin.webresource.impl.snapshot.Snapshot.find() since 5.0. It's simple enough to construct the finder yourself ;)
com.atlassian.plugin.webresource.impl.config.Config.getBatchingConfiguration()
com.atlassian.plugin.webresource.WebResourceModuleDescriptor.getDeprecatedConditionKeys() in 3.0.5
com.atlassian.plugin.webresource.WebResourceModuleDescriptor.getDeprecatedTransformKeys(TransformerCache) in 3.0.5
com.atlassian.plugin.webresource.PluginResourceLocator.getDownloadableResource(String, Map<String, String>) since 3.3.2
com.atlassian.plugin.webresource.impl.RequestState.getExcluded()
com.atlassian.plugin.webresource.models.RawRequest.getExcludedAsLooseType() In the future the only method to be used will be RawRequest.getExcluded().
com.atlassian.plugin.webresource.impl.RequestState.getGlobals() since 5.0.0. There is no replacement. Don't use god objects.
com.atlassian.plugin.webresource.impl.RequestState.getIncluded()
com.atlassian.plugin.webresource.impl.RequestState.getIncluded(ResourcePhase)
com.atlassian.plugin.webresource.models.RawRequest.getIncludedAsLooseType() In the future the only method to be used will be RawRequest.getIncluded().
com.atlassian.plugin.webresource.impl.config.Config.getIntegration() since 3.3.2
com.atlassian.plugin.webresource.WebResourceIntegration.getPluginEventManager() since v3.3.2
com.atlassian.plugin.webresource.impl.snapshot.WebResource.getPluginKey() since v3.3.2
com.atlassian.plugin.webresource.WebResourceManager.getRequiredResources() As of 2.3.0, replaced by WebResourceManager.getRequiredResources(UrlMode)
com.atlassian.plugin.webresource.impl.snapshot.resource.Resource.getResourceLocation() since 3.3.2
com.atlassian.plugin.webresource.impl.helpers.ResourceServingHelpers.getResourceRelativeToPlugin(Globals, String, String) since v3.3.2
com.atlassian.plugin.webresource.impl.helpers.ResourceServingHelpers.getResourceRelativeToWebResource(RequestCache, String, String) since v3.3.2
com.atlassian.plugin.webresource.WebResourceManager.getResourceTags(String) As of 2.3.0, replaced by WebResourceManager.getResourceTags(String, UrlMode)
com.atlassian.plugin.webresource.WebResourceManager.getStaticPluginResource(ModuleDescriptor<?>, String) As of 2.3.0, replaced by WebResourceManager.getStaticPluginResource(ModuleDescriptor, String, UrlMode)
com.atlassian.plugin.webresource.WebResourceManagerImpl.getStaticPluginResource(ModuleDescriptor<?>, String)
com.atlassian.plugin.webresource.WebResourceManager.getStaticPluginResource(ModuleDescriptor<?>, String, UrlMode) As of 2.9.0, replaced by WebResourceUrlProvider.getStaticPluginResourceUrl(com.atlassian.plugin.ModuleDescriptor, String, UrlMode)
com.atlassian.plugin.webresource.WebResourceManagerImpl.getStaticPluginResource(ModuleDescriptor<?>, String, UrlMode)
com.atlassian.plugin.webresource.WebResourceManager.getStaticPluginResource(String, String) As of 2.3.0, replaced by WebResourceManager.getStaticPluginResource(String, String, UrlMode)
com.atlassian.plugin.webresource.WebResourceManagerImpl.getStaticPluginResource(String, String)
com.atlassian.plugin.webresource.WebResourceManager.getStaticPluginResource(String, String, UrlMode) As of 2.9.0, replaced by WebResourceUrlProvider.getStaticPluginResourceUrl(String, String, UrlMode)
com.atlassian.plugin.webresource.WebResourceManagerImpl.getStaticPluginResource(String, String, UrlMode)
com.atlassian.plugin.webresource.WebResourceIntegration.getStaticResourceLocale() since 3.5.22 - This method includes current locale in URL hash which is unnecessary since it's already in a query parameter. The current behaviour causes unnecessary cache misses of pre-baked resources since it'll only work for instances with the same locale in which the pre-baker ran. Use WebResourceIntegration.getI18nStateHash() instead.
com.atlassian.plugin.webresource.WebResourceManager.getStaticResourcePrefix() As of 2.3.0, replaced by WebResourceUrlProvider.getStaticResourcePrefix(UrlMode)
com.atlassian.plugin.webresource.WebResourceManager.getStaticResourcePrefix(String) As of 2.3.0, replaced by WebResourceUrlProvider.getStaticResourcePrefix(String, UrlMode)
com.atlassian.plugin.webresource.impl.RequestState.getSyncResourceSet() since 5.6.0. Check sync resources via RequestState.getRawRequest() with ResourcePhase.INLINE.
com.atlassian.plugin.webresource.WebResourceIntegration.getSystemCounter() since 5.0 implement WebResourceIntegration.getResourceUrlPrefix() instead
com.atlassian.plugin.webresource.impl.config.Config.getTransformerCache() since 3.3.2
com.atlassian.plugin.webresource.impl.snapshot.WebResource.getWebResourceKey() since v3.3.2
com.atlassian.plugin.webresource.WebResourceManager.includeResources(Writer) As of 2.3.0, replaced by WebResourceManager.includeResources(Writer, UrlMode)
com.atlassian.plugin.webresource.assembler.DefaultWebResourceAssemblerBuilder.includeSuperbatchResources(boolean) since 5.5.0. Use RequiredResources.excludeSuperbatch() instead.
com.atlassian.plugin.webresource.WebResourceIntegration.isDeferJsAttributeEnabled() since 5.0.0, use ResourcePriority.DEFER instead
com.atlassian.plugin.webresource.impl.config.Config.isDeferJsAttributeEnabled() since 5.0.0, use ResourcePriority.DEFER instead
com.atlassian.plugin.webresource.impl.snapshot.Bundle.isMinificationEnabled()
com.atlassian.plugin.webresource.impl.config.Config.isUrlGenerationCacheEnabled() since 5.0.0. Use Config.isUrlCachingEnabled instead.
com.atlassian.plugin.webresource.impl.RequestState.markSyncResourcesAsWritten() since 5.6.0. Covered by existing excludedResolved mechanism and ResourcePhase.INLINE.
com.atlassian.plugin.webresource.PluginResourceLocator.matches(String) since 3.3.2
com.atlassian.plugin.webresource.models.RawRequest.removeExcluded(Requestable) It is deprecated due to the fact that the performance will be affected.
com.atlassian.plugin.webresource.WebResourceManager.requireResource(String, Writer) As of 2.3.0, replaced by WebResourceManager.requireResource(String, Writer, UrlMode)
com.atlassian.plugin.webresource.impl.helpers.url.UrlGenerationHelpers.resolveExcluded(RequestCache, UrlBuildingStrategy, Collection<String>, Collection<String>) use DependencyGraph or BundleFinder instead to avoid generating an entire URL set just to traverse the dependency graph.
com.atlassian.plugin.webresource.impl.helpers.url.UrlGenerationHelpers.resolveExcluded(RequestCache, UrlCache, UrlBuildingStrategy, Collection<String>, Collection<String>) use DependencyGraph or BundleFinder instead to avoid generating an entire URL set just to traverse the dependency graph.
com.atlassian.plugin.webresource.impl.support.http.Request.setRequestedResources(Collection<String>) use Request.setRequestedResources(RawRequest) instead.
com.atlassian.plugin.webresource.impl.support.http.Request.setRequestedResources(Collection<String>, Collection<String>) use Request.setRequestedResources(RawRequest) instead.
com.atlassian.plugin.webresource.impl.RequestState.setSyncResourceSet(DefaultWebResourceSet) since 5.6.0. Use RequestState.setSyncbatchEnabled(boolean) instead.
com.atlassian.plugin.webresource.impl.helpers.ResourceServingHelpers.splitLastPathPart(String) since v3.3.2
com.atlassian.plugin.webresource.PluginResourceLocator.temporaryWayToGetGlobalsDoNotUseIt() since 3.3.2
com.atlassian.plugin.webresource.models.Requestable.toLooseType()
com.atlassian.plugin.webresource.models.WebResourceContextKey.toLooseType()
com.atlassian.plugin.webresource.transformer.WebResourceTransformer.transform(Element, ResourceLocation, DownloadableResource) since 3.0. Use WebResourceTransformerFactory, will be removed at next major version (6.0.0)
com.atlassian.plugin.webresource.transformer.WebResourceTransformer.transform(Element, ResourceLocation, String, DownloadableResource) since 3.0. Use WebResourceTransformerFactory, will be removed at next major version (6.0.0)

Deprecated Constructors

Constructor and Description
com.atlassian.plugin.webresource.impl.snapshot.Context(Snapshot, String, List<String>, List<String>, Date, String, boolean)
com.atlassian.plugin.webresource.DefaultResourceDependencyResolver(WebResourceIntegration, ResourceBatchingConfiguration) since 3.3.2
com.atlassian.plugin.webresource.impl.discovery.Found(List<Found.Item>)
com.atlassian.plugin.webresource.WebResourceModuleDescriptor(HostContainer) Since 3.0.0 - use WebResourceModuleDescriptor(com.atlassian.plugin.module.ModuleFactory, com.atlassian.plugin.hostcontainer.HostContainer)