com.atlassian.plugin.webresource

Interface ResourceBatchingConfiguration

All Known Implementing Classes:

DefaultResourceBatchingConfiguration

public interface ResourceBatchingConfiguration

Resource batching configuration for the WebResourceManagerImpl. Currently contains the configuration for batch support.

Method Summary

Modifier and Type	Method and Description
List<String>	getSuperBatchModuleCompleteKeys() Gets the list of resource plugin modules that should be included in the superbatch, in the order that they should be batched.
boolean	isBatchContentTrackingEnabled()
boolean	isContextBatchingEnabled() Determines whether web resources in the same context should be batched together.
boolean	isJavaScriptTryCatchWrappingEnabled() When JavaScript resources are batched, each script within the batch can be wrapped in its own try/catch block to prevent an exception breaking the whole batch.
boolean	isPluginWebResourceBatchingEnabled() Determines whether plugin resources of the same type defined within a single web resource are batched into one file.
boolean	isSourceMapEnabled() Enables generation of the Source Map.
boolean	isSuperBatchingEnabled() Gets whether web resources in different resource modules should be batched together.
boolean	optimiseSourceMapsForDevelopment() Source Map could be optimised for production or development.
boolean	resplitMergedContextBatchesForThisRequest()

Method Detail

isSuperBatchingEnabled

boolean isSuperBatchingEnabled()

Gets whether web resources in different resource modules should be batched together.

Returns:

true if web resources in different resource modules should be batched together

getSuperBatchModuleCompleteKeys

List<String> getSuperBatchModuleCompleteKeys()

Gets the list of resource plugin modules that should be included in the superbatch, in the order that they should be batched. No dependency resolution is performed, so it is important that the configuration includes all dependent resources in the right order. Any call to WebResourceManager.requireResource(java.lang.String) for one of these resources will be a no-op, and any dependency resolution for resources will stop if the dependency is in the superbatch.

Returns:

a list of resource plugin modules that should be included in the superbatch.

isContextBatchingEnabled

boolean isContextBatchingEnabled()

Determines whether web resources in the same context should be batched together.

Returns:

true if web resources in the same context are batched together.

Since:

2.9.0

isPluginWebResourceBatchingEnabled

boolean isPluginWebResourceBatchingEnabled()

Determines whether plugin resources of the same type defined within a single web resource are batched into one file.

Returns:

true if plugin resources in the same web resource are batched together.

Since:

2.9.0

isJavaScriptTryCatchWrappingEnabled

boolean isJavaScriptTryCatchWrappingEnabled()

When JavaScript resources are batched, each script within the batch can be wrapped in its own try/catch block to prevent an exception breaking the whole batch. This behaviour is controlled by this property.

Returns:

true if try/catch wrapping of JavaScript batches is enabled.

Since:

2.14

isBatchContentTrackingEnabled

boolean isBatchContentTrackingEnabled()

Returns:

true if the HTML tags created for batch resources should include data attributes listing the contents of the batch. This would be useful to turn on if you want the front end client to be able to track what resources and contexts it is loading.

Since:

2.13.0

resplitMergedContextBatchesForThisRequest

@ExperimentalApi
boolean resplitMergedContextBatchesForThisRequest()

Returns:

true if you want the WRM to split context batches it would otherwise merge together. This may be necessary in IE8,IE9 because they have a 4095 rules-per-css limit, and merged context batches are likely to produce big files.

This method is called multiple times (at least once per request) and its value is not cached. Therefore, implementations can perform request-local logic. That is, they can browser-sniff for IE.

isSourceMapEnabled

@ExperimentalApi
boolean isSourceMapEnabled()

Enables generation of the Source Map.

Could be enabled in production too with `optimiseSourceMapsForDevelopment` set to `false`, with such setting it won't slow down the instance.

Since:

3.3

optimiseSourceMapsForDevelopment

@ExperimentalApi
boolean optimiseSourceMapsForDevelopment()

Source Map could be optimised for production or development.

In production the JS & CSS generation will be fast (exactly the same as without the Source Map) but the Source Map generation will be slow.

In development the JS & CSS generation will be a little slower but the Source Map generation will be fast.

It's better to enable this option during development (it **must** be disabled in production).

Since:

3.4