com.atlassian.plugin.webresource.impl.config

Class Config

java.lang.Object

com.atlassian.plugin.webresource.impl.config.Config

public class Config
extends Object

Unites all the configurations in one place. Not exposed as API, so it is possible to change it and store settings that should not be exposed publicly.

Since:

3.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Config.IntermediaryContextData
protected static class	Config.WebModuleDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOW_PUBLIC_USE_PARAM_NAME
static String	ASYNC_SCRIPT_PARAM_NAME
static String	ATLASSIAN_MODULES_XML
static String	BATCH_PARAM_NAME
static String[]	BATCH_TYPES
static String	CACHE_PARAM_NAME
static String	CONDITIONAL_COMMENT_PARAM_NAME Deprecated. Since v4.0. Will be removed in v5.0.
static String	CONTENT_TYPE_PARAM_NAME
static String	CONTEXT_PREFIX
static String	CSS_CONTENT_TYPE
static String	CSS_EXTENSION
static String	CSS_TYPE
static String	DOWNLOAD_PARAM_VALUE
static int	GET_URL_MAX_LENGTH
static String[]	HTTP_PARAM_NAMES
static String	IEONLY_PARAM_NAME Deprecated. Since v4.0. Will be removed in v5.0.
static String	IN_ORDER_LOADER_RESOURCE_KEY
static String	INCREMENTAL_CACHE_SIZE
static String	INITIAL_RENDERED_SCRIPT_PARAM_NAME
static String	JS_CONTENT_TYPE
static String	JS_EXTENSION
static String	JS_TYPE
static String	LESS_EXTENSION
static String	MEDIA_PARAM_NAME
static List<String>	PARAMS_SORT_ORDER
static String	SOURCE_PARAM_NAME
static String	SOY_EXTENSION
static String	SOY_TYPE
static String	SUPER_BATCH_CONTEXT_KEY
static String	SUPERBATCH_KEY
static String	SYNCBATCH_CONTEXT_KEY
static String	SYNCBATCH_KEY
static String	WEB_RESOURCE_MODULE_LOADER
static String	WRM_BATCH_TYPE_PARAM_NAME
static String	WRM_KEY_PARAM_NAME

Constructor Summary

Constructors

Constructor and Description
Config(ResourceBatchingConfiguration batchingConfiguration, WebResourceIntegration integration, WebResourceUrlProvider urlProvider, com.atlassian.plugin.servlet.ServletContextFactory servletContextFactory, TransformerCache transformerCache, ResourceCompiler resourceCompiler)

Method Summary

Modifier and Type	Method and Description
boolean	amdEnabled()
protected Resource	buildResource(Bundle bundle, com.atlassian.plugin.elements.ResourceLocation resourceLocation) Helper to hide bunch of integration code and simplify resource creation.
String	computeGlobalStateHash() Represents product state considering everything that contributes to content of resources.
protected void	ensureNoLegacyStuff(Snapshot snapshot) Analyzes current state of the plugin system and return web resources.
String	getBaseUrl()
String	getBaseUrl(boolean isAbsolute)
ResourceBatchingConfiguration	getBatchingConfiguration() Deprecated.
List<String>	getBeforeAllResources()
boolean	getBigPipeDeadlineDisabled()
File	getCacheDirectory()
CdnResourceUrlTransformer	getCdnResourceUrlTransformer() Returns a URL transformer to allow clients to map resource URLs as in getResourceCdnPrefix(String).
ResourceContentAnnotator	getContentAnnotator(String type)
int	getContentCacheSize()
String	getContentType(String path)
String	getCtCdnBaseUrl() Returns the CDN base URL to prefix all pre-baked resources mapped with WebResourceMapper.
TimeSpan	getDefaultBigPipeDeadline()
int	getIncrementalCacheSize()
WebResourceIntegration	getIntegration() Deprecated. since 3.3.2
Resource	getModuleResource(String completeKey, String name) Get not declared Resource.
Resource	getPluginResource(String pluginKey, String name) Get Resource for Plugin.
static String	getPluginVersionOrInstallTime(com.atlassian.plugin.Plugin plugin, boolean usePluginInstallTimeInsteadOfTheVersionForSnapshotPlugins) For SNAPSHOT plugins will return install time instead of the version.
String	getResourceCdnPrefix(String url)
ResourceCompiler	getResourceCompiler()
protected static List<com.atlassian.plugin.elements.ResourceLocation>	getResourceLocations(WebResourceModuleDescriptor webResourceModuleDescriptor, boolean compiledResourcesEnabled)
LinkedHashMap<String,Resource>	getResourcesWithoutCache(Bundle bundle) Queries the plugin system and return list of Resources for Web Resource.
String	getResourceUrlPrefix(String hash, String version, boolean isAbsolute)
StaticTransformers	getStaticTransformers()
InputStream	getStreamFor(Resource resource, String path) Returns stream for file with given location for given resource.
TransformerCache	getTransformerCache() Deprecated. since 3.3.2
int	getUrlCacheSize()
LinkedHashMap<String,com.atlassian.json.marshal.Jsonable>	getWebResourceData(String key) Get data resources for web resource.
WebResourceMapper	getWebResourceMapper() Returns the current instance of WebResourceMapper or no-op when WebResourceIntegration.isCtCdnMappingEnabled() is false.
Snapshot	getWebResourcesWithoutCache() Analyzes current state of the plugin system and return web resources.
boolean	ignorePrebakeWarnings() This property indicates if resources tainted only with PrebakeWarnings should be considered for prebaking.
boolean	isBatchContentTrackingEnabled()
boolean	isCdnEnabled()
boolean	isContentCacheEnabled()
boolean	isContextBatchingEnabled()
static boolean	isContextKey(String key) If the key is context or web resource key.
boolean	isCSSPrebakingEnabled() Returns true if CSS prebaking is enabled, false otherwise
boolean	isDeferJsAttributeEnabled()
boolean	isGlobalMinificationEnabled() Determines if global minification of resources is enabled based on a System Property.
boolean	isIncrementalCacheEnabled() If incremental cache enabled.
boolean	isJavaScriptTryCatchWrappingEnabled()
boolean	isMinificationEnabled() If minification enabled.
boolean	isPreBakeEnabled() Determines if pre-baker REST API is enabled based on a System Property..
boolean	isSourceMapEnabled()
boolean	isSourceMapEnabledFor(String typeOrContentType)
static boolean	isStaticContextOrderEnabled() Determines if batch URLs contexts' are sorted to ensure that the same URL is generated no matter what order the contexts are required in.
boolean	isSuperBatchingEnabled()
boolean	isSyncContextCreated()
boolean	isUrlCachingEnabled() If URL caching enabled, used mostly to simplify debugging.
boolean	isUrlGenerationCacheEnabled()
boolean	isWebResourceBatchingEnabled()
static boolean	isWebResourceKey(String completeKey) If `completeKey` is Web Resource key or Plugin key.
static String	nameAndLoaderToNameWithExtension(String loader, String name)
static String	nameAndLoaderToNameWithLoader(String loader, String name)
boolean	optimiseSourceMapsForDevelopment()
protected Map<String,List<Config.WebModuleDescriptor>>	parseAtlassianModules(com.atlassian.plugin.Plugin plugin)
protected void	parseModules(Snapshot snapshot, Map<String,Bundle> cachedBundles, ConditionInstanceCache conditionInstanceCache, Map<WebResource,CachedCondition> webResourcesCondition, Map<WebResource,CachedTransformers> webResourcesTransformations, Map<String,Config.IntermediaryContextData> intermediaryContexts)
static Tuple<String,String>	parseNameWithLoader(String name)
int	partialHashCode() Hash code representing the state of config.
void	reloadWebResourceMapper() Forces the creation of a new instance of WebResourceMapper, resetting the current reference to it.
boolean	resplitMergedContextBatchesForThisRequest()
void	runResourceCompilation(Snapshot snapshot)
void	setContentTypeResolver(com.atlassian.plugin.servlet.ContentTypeResolver contentTypeResolver) Needed because `contentTypeResolver` isn't available at the time Config is created and set up a bit later.
void	setStaticTransformers(StaticTransformers staticTransformers)
boolean	useAsyncAttributeForScripts() Use async attribute for script tags.
boolean	useConditionsForWebModules() If conditions should be enabled for AMD modules.
static String	virtualContextKeyToWebResourceKey(String virtualContextKey) Convert virtual context key to web resource key.

Methods inherited from class java.lang.Object

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

Field Detail

IEONLY_PARAM_NAME

public static final String IEONLY_PARAM_NAME

Deprecated. Since v4.0. Will be removed in v5.0.

See Also:

Constant Field Values

SOURCE_PARAM_NAME

public static final String SOURCE_PARAM_NAME

See Also:

Constant Field Values

BATCH_PARAM_NAME

public static final String BATCH_PARAM_NAME

See Also:

Constant Field Values

MEDIA_PARAM_NAME

public static final String MEDIA_PARAM_NAME

See Also:

Constant Field Values

CONTENT_TYPE_PARAM_NAME

public static final String CONTENT_TYPE_PARAM_NAME

See Also:

Constant Field Values

CACHE_PARAM_NAME

public static final String CACHE_PARAM_NAME

See Also:

Constant Field Values

ALLOW_PUBLIC_USE_PARAM_NAME

public static final String ALLOW_PUBLIC_USE_PARAM_NAME

See Also:

Constant Field Values

CONDITIONAL_COMMENT_PARAM_NAME

public static final String CONDITIONAL_COMMENT_PARAM_NAME

Deprecated. Since v4.0. Will be removed in v5.0.

See Also:

Constant Field Values

ASYNC_SCRIPT_PARAM_NAME

public static final String ASYNC_SCRIPT_PARAM_NAME

See Also:

Constant Field Values

INITIAL_RENDERED_SCRIPT_PARAM_NAME

public static final String INITIAL_RENDERED_SCRIPT_PARAM_NAME

See Also:

Constant Field Values

WRM_KEY_PARAM_NAME

public static final String WRM_KEY_PARAM_NAME

See Also:

Constant Field Values

WRM_BATCH_TYPE_PARAM_NAME

public static final String WRM_BATCH_TYPE_PARAM_NAME

See Also:

Constant Field Values

DOWNLOAD_PARAM_VALUE

public static final String DOWNLOAD_PARAM_VALUE

See Also:

Constant Field Values

JS_TYPE

public static final String JS_TYPE

See Also:

Constant Field Values

JS_CONTENT_TYPE

public static final String JS_CONTENT_TYPE

See Also:

Constant Field Values

CSS_TYPE

public static final String CSS_TYPE

See Also:

Constant Field Values

CSS_CONTENT_TYPE

public static final String CSS_CONTENT_TYPE

See Also:

Constant Field Values

SOY_TYPE

public static final String SOY_TYPE

See Also:

Constant Field Values

CSS_EXTENSION

public static final String CSS_EXTENSION

See Also:

Constant Field Values

LESS_EXTENSION

public static final String LESS_EXTENSION

See Also:

Constant Field Values

JS_EXTENSION

public static final String JS_EXTENSION

See Also:

Constant Field Values

SOY_EXTENSION

public static final String SOY_EXTENSION

See Also:

Constant Field Values

BATCH_TYPES

public static final String[] BATCH_TYPES

WEB_RESOURCE_MODULE_LOADER

public static final String WEB_RESOURCE_MODULE_LOADER

See Also:

Constant Field Values

GET_URL_MAX_LENGTH

public static final int GET_URL_MAX_LENGTH

See Also:

Constant Field Values

HTTP_PARAM_NAMES

public static final String[] HTTP_PARAM_NAMES

PARAMS_SORT_ORDER

public static final List<String> PARAMS_SORT_ORDER

ATLASSIAN_MODULES_XML

public static final String ATLASSIAN_MODULES_XML

See Also:

Constant Field Values

CONTEXT_PREFIX

public static final String CONTEXT_PREFIX

See Also:

Constant Field Values

SUPER_BATCH_CONTEXT_KEY

public static final String SUPER_BATCH_CONTEXT_KEY

See Also:

Constant Field Values

SUPERBATCH_KEY

public static final String SUPERBATCH_KEY

See Also:

Constant Field Values

SYNCBATCH_CONTEXT_KEY

public static final String SYNCBATCH_CONTEXT_KEY

See Also:

Constant Field Values

SYNCBATCH_KEY

public static final String SYNCBATCH_KEY

See Also:

Constant Field Values

IN_ORDER_LOADER_RESOURCE_KEY

public static final String IN_ORDER_LOADER_RESOURCE_KEY

See Also:

Constant Field Values

INCREMENTAL_CACHE_SIZE

public static final String INCREMENTAL_CACHE_SIZE

See Also:

Constant Field Values

Constructor Detail

Config

public Config(ResourceBatchingConfiguration batchingConfiguration,
              WebResourceIntegration integration,
              WebResourceUrlProvider urlProvider,
              com.atlassian.plugin.servlet.ServletContextFactory servletContextFactory,
              TransformerCache transformerCache,
              ResourceCompiler resourceCompiler)

Method Detail

setContentTypeResolver

public void setContentTypeResolver(com.atlassian.plugin.servlet.ContentTypeResolver contentTypeResolver)

Needed because `contentTypeResolver` isn't available at the time Config is created and set up a bit later.

setStaticTransformers

public void setStaticTransformers(StaticTransformers staticTransformers)

isContentCacheEnabled

public boolean isContentCacheEnabled()

Returns:

if cache should be enabled.

getContentCacheSize

public int getContentCacheSize()

Returns:

amount of files to be stored in cache.

getIncrementalCacheSize

public int getIncrementalCacheSize()

Returns:

amount of files to be stored in cache.

getCacheDirectory

public File getCacheDirectory()

Returns:

directory where cache content would be stored as files.

isSourceMapEnabledFor

public boolean isSourceMapEnabledFor(String typeOrContentType)

Parameters:

typeOrContentType - type or content type.

Returns:

if source map enabled for this type or content type.

isSourceMapEnabled

public boolean isSourceMapEnabled()

Returns:

if source map enabled.

isCdnEnabled

public boolean isCdnEnabled()

Returns:

if CDN is globally enabled.

getBaseUrl

public String getBaseUrl()

Returns:

base url, where web resources is mounted to.

getBaseUrl

public String getBaseUrl(boolean isAbsolute)

Parameters:

isAbsolute - if url should be absolute or relative.

Returns:

base url, where web resources is mounted to.

getResourceUrlPrefix

public String getResourceUrlPrefix(String hash,
                                   String version,
                                   boolean isAbsolute)

Returns:

url prefix for resource, including base url.

getResourceCdnPrefix

public String getResourceCdnPrefix(String url)

Returns:

url prefixed with CDN prefix.

getContentType

public String getContentType(String path)

Returns:

content type for given path.

getContentAnnotator

public ResourceContentAnnotator getContentAnnotator(String type)

Returns:

content annotators for given type.

useAsyncAttributeForScripts

public boolean useAsyncAttributeForScripts()

Use async attribute for script tags.

getStaticTransformers

public StaticTransformers getStaticTransformers()

Returns:

static transformers.

isContextKey

public static boolean isContextKey(String key)

If the key is context or web resource key.

virtualContextKeyToWebResourceKey

public static String virtualContextKeyToWebResourceKey(String virtualContextKey)

Convert virtual context key to web resource key.

ensureNoLegacyStuff

protected void ensureNoLegacyStuff(Snapshot snapshot)

Analyzes current state of the plugin system and return web resources.

isSyncContextCreated

public boolean isSyncContextCreated()

Returns:

true if sync context has been created (is not empty)

Since:

3.5.27

getWebResourcesWithoutCache

public Snapshot getWebResourcesWithoutCache()

Analyzes current state of the plugin system and return web resources.

parseModules

protected void parseModules(Snapshot snapshot,
                            Map<String,Bundle> cachedBundles,
                            ConditionInstanceCache conditionInstanceCache,
                            Map<WebResource,CachedCondition> webResourcesCondition,
                            Map<WebResource,CachedTransformers> webResourcesTransformations,
                            Map<String,Config.IntermediaryContextData> intermediaryContexts)

parseNameWithLoader

public static Tuple<String,String> parseNameWithLoader(String name)

nameAndLoaderToNameWithExtension

public static String nameAndLoaderToNameWithExtension(String loader,
                                                      String name)

nameAndLoaderToNameWithLoader

public static String nameAndLoaderToNameWithLoader(String loader,
                                                   String name)

parseAtlassianModules

protected Map<String,List<Config.WebModuleDescriptor>> parseAtlassianModules(com.atlassian.plugin.Plugin plugin)

getResourcesWithoutCache

public LinkedHashMap<String,Resource> getResourcesWithoutCache(Bundle bundle)

Queries the plugin system and return list of Resources for Web Resource.

getResourceLocations

protected static List<com.atlassian.plugin.elements.ResourceLocation> getResourceLocations(WebResourceModuleDescriptor webResourceModuleDescriptor,
                                                                                           boolean compiledResourcesEnabled)

getWebResourceData

public LinkedHashMap<String,com.atlassian.json.marshal.Jsonable> getWebResourceData(String key)

Get data resources for web resource.

getStreamFor

public InputStream getStreamFor(Resource resource,
                                String path)

Returns stream for file with given location for given resource.

isMinificationEnabled

public boolean isMinificationEnabled()

If minification enabled.

buildResource

protected Resource buildResource(Bundle bundle,
                                 com.atlassian.plugin.elements.ResourceLocation resourceLocation)

Helper to hide bunch of integration code and simplify resource creation.

getModuleResource

public Resource getModuleResource(String completeKey,
                                  String name)

Get not declared Resource.

getPluginResource

public Resource getPluginResource(String pluginKey,
                                  String name)

Get Resource for Plugin.

optimiseSourceMapsForDevelopment

public boolean optimiseSourceMapsForDevelopment()

isSuperBatchingEnabled

public boolean isSuperBatchingEnabled()

isBatchContentTrackingEnabled

public boolean isBatchContentTrackingEnabled()

isContextBatchingEnabled

public boolean isContextBatchingEnabled()

isWebResourceBatchingEnabled

public boolean isWebResourceBatchingEnabled()

isIncrementalCacheEnabled

public boolean isIncrementalCacheEnabled()

If incremental cache enabled.

isWebResourceKey

public static boolean isWebResourceKey(String completeKey)

If `completeKey` is Web Resource key or Plugin key.

partialHashCode

public int partialHashCode()

Hash code representing the state of config. State of the system could change not only on plugin system changes but also some properties of config could change too. In such cases the cache additionally checked against the version of config it's build for.

Strictly speaking this hash should include the full state of config, but it would be too slow, so instead we check only for some of its properties.

getIntegration

@Deprecated
public WebResourceIntegration getIntegration()

Deprecated. since 3.3.2

getTransformerCache

@Deprecated
public TransformerCache getTransformerCache()

Deprecated. since 3.3.2

isUrlGenerationCacheEnabled

public boolean isUrlGenerationCacheEnabled()

getUrlCacheSize

public int getUrlCacheSize()

getBatchingConfiguration

@Deprecated
public ResourceBatchingConfiguration getBatchingConfiguration()

Deprecated.

isDeferJsAttributeEnabled

public boolean isDeferJsAttributeEnabled()

getDefaultBigPipeDeadline

public TimeSpan getDefaultBigPipeDeadline()

getBigPipeDeadlineDisabled

public boolean getBigPipeDeadlineDisabled()

computeGlobalStateHash

public String computeGlobalStateHash()

Represents product state considering everything that contributes to content of resources.

Since:

v3.5.0

useConditionsForWebModules

public boolean useConditionsForWebModules()

If conditions should be enabled for AMD modules.

getBeforeAllResources

public List<String> getBeforeAllResources()

getCdnResourceUrlTransformer

public CdnResourceUrlTransformer getCdnResourceUrlTransformer()

Returns a URL transformer to allow clients to map resource URLs as in getResourceCdnPrefix(String).

Since:

v3.5.0

isPreBakeEnabled

public boolean isPreBakeEnabled()

Determines if pre-baker REST API is enabled based on a System Property..

Since:

v3.5.0

isStaticContextOrderEnabled

public static boolean isStaticContextOrderEnabled()

Determines if batch URLs contexts' are sorted to ensure that the same URL is generated no matter what order the contexts are required in.

Since:

3.6.0

isGlobalMinificationEnabled

public boolean isGlobalMinificationEnabled()

Determines if global minification of resources is enabled based on a System Property.

Since:

v3.6.0

getCtCdnBaseUrl

public String getCtCdnBaseUrl()

Returns the CDN base URL to prefix all pre-baked resources mapped with WebResourceMapper.

Since:

v3.5.0

getResourceCompiler

public ResourceCompiler getResourceCompiler()

runResourceCompilation

public void runResourceCompilation(Snapshot snapshot)

resplitMergedContextBatchesForThisRequest

public boolean resplitMergedContextBatchesForThisRequest()

amdEnabled

public boolean amdEnabled()

getWebResourceMapper

public WebResourceMapper getWebResourceMapper()

Returns the current instance of WebResourceMapper or no-op when WebResourceIntegration.isCtCdnMappingEnabled() is false.

Since:

v3.5.7

reloadWebResourceMapper

public void reloadWebResourceMapper()
                             throws Exception

Forces the creation of a new instance of WebResourceMapper, resetting the current reference to it. If the new instance is NoOpWebResourceMapper and NoOpWebResourceMapper.reason() returns an exception, then this exception is thrown.

Throws:

Exception - Reason why NoOpWebResourceMapper and not an operational instance was created.

Since:

v3.5.7

isJavaScriptTryCatchWrappingEnabled

public boolean isJavaScriptTryCatchWrappingEnabled()

getPluginVersionOrInstallTime

public static String getPluginVersionOrInstallTime(com.atlassian.plugin.Plugin plugin,
                                                   boolean usePluginInstallTimeInsteadOfTheVersionForSnapshotPlugins)

For SNAPSHOT plugins will return install time instead of the version. Needed to simplify working with SNAPSHOT plugins and flushing cache when new SNAPSHOT plugin installed with same version but different content.

isCSSPrebakingEnabled

public boolean isCSSPrebakingEnabled()

Returns true if CSS prebaking is enabled, false otherwise

Returns:

true if CSS prebaking is enabled, false otherwise

Since:

v3.5.13

ignorePrebakeWarnings

public boolean ignorePrebakeWarnings()

This property indicates if resources tainted only with PrebakeWarnings should be considered for prebaking.

It is important to note that resources tainted with PrebakeErrors will never be considered safe for prebaking, even when this property is set.

Returns:

true to allow prebaking of resources tainted with PrebakeWarnings, false otherwise

Since:

v3.5.23

isUrlCachingEnabled

public boolean isUrlCachingEnabled()

If URL caching enabled, used mostly to simplify debugging.