com.atlassian.plugin.webresource

Class DefaultResourceBatchingConfiguration

java.lang.Object

com.atlassian.plugin.webresource.DefaultResourceBatchingConfiguration

All Implemented Interfaces:

ResourceBatchingConfiguration

public class DefaultResourceBatchingConfiguration
extends Object
implements ResourceBatchingConfiguration

Default configuration for the plugin resource locator, for those applications that do not want to perform any super-batching.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_WEB_RESOURCE_BATCH_CONTENT_TRACKING
static String	PLUGIN_WEB_RESOURCE_JAVASCRIPT_TRY_CATCH_WRAPPING
static String	PLUGIN_WEB_RESOURCE_SOURCE_MAP_ENABLED
static String	PLUGIN_WEB_RESOURCE_SOURCE_MAP_OPTIMISED_FOR_DEVELOPMENT
static String	PLUGIN_WEBRESOURCE_BATCHING_OFF

Constructor Summary

Constructors

Constructor and Description
DefaultResourceBatchingConfiguration()

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() Currently (as of v2.14) this is false by default.
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()

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_WEBRESOURCE_BATCHING_OFF

public static final String PLUGIN_WEBRESOURCE_BATCHING_OFF

See Also:

Constant Field Values

PLUGIN_WEB_RESOURCE_BATCH_CONTENT_TRACKING

public static final String PLUGIN_WEB_RESOURCE_BATCH_CONTENT_TRACKING

See Also:

Constant Field Values

PLUGIN_WEB_RESOURCE_JAVASCRIPT_TRY_CATCH_WRAPPING

public static final String PLUGIN_WEB_RESOURCE_JAVASCRIPT_TRY_CATCH_WRAPPING

See Also:

Constant Field Values

PLUGIN_WEB_RESOURCE_SOURCE_MAP_ENABLED

public static final String PLUGIN_WEB_RESOURCE_SOURCE_MAP_ENABLED

See Also:

Constant Field Values

PLUGIN_WEB_RESOURCE_SOURCE_MAP_OPTIMISED_FOR_DEVELOPMENT

public static final String PLUGIN_WEB_RESOURCE_SOURCE_MAP_OPTIMISED_FOR_DEVELOPMENT

See Also:

Constant Field Values

Constructor Detail

DefaultResourceBatchingConfiguration

public DefaultResourceBatchingConfiguration()

Method Detail

isSuperBatchingEnabled

public boolean isSuperBatchingEnabled()

Description copied from interface: ResourceBatchingConfiguration

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

Specified by:

isSuperBatchingEnabled in interface ResourceBatchingConfiguration

Returns:

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

getSuperBatchModuleCompleteKeys

public List<String> getSuperBatchModuleCompleteKeys()

Description copied from interface: ResourceBatchingConfiguration

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.

Specified by:

getSuperBatchModuleCompleteKeys in interface ResourceBatchingConfiguration

Returns:

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

isContextBatchingEnabled

public boolean isContextBatchingEnabled()

Description copied from interface: ResourceBatchingConfiguration

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

Specified by:

isContextBatchingEnabled in interface ResourceBatchingConfiguration

Returns:

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

isPluginWebResourceBatchingEnabled

public boolean isPluginWebResourceBatchingEnabled()

Description copied from interface: ResourceBatchingConfiguration

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

Specified by:

isPluginWebResourceBatchingEnabled in interface ResourceBatchingConfiguration

Returns:

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

isJavaScriptTryCatchWrappingEnabled

public boolean isJavaScriptTryCatchWrappingEnabled()

Currently (as of v2.14) this is false by default. It is likely to become true by default in the future.

Specified by:

isJavaScriptTryCatchWrappingEnabled in interface ResourceBatchingConfiguration

Returns:

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

isBatchContentTrackingEnabled

public boolean isBatchContentTrackingEnabled()

Specified by:

isBatchContentTrackingEnabled in interface ResourceBatchingConfiguration

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.

resplitMergedContextBatchesForThisRequest

public boolean resplitMergedContextBatchesForThisRequest()

Specified by:

resplitMergedContextBatchesForThisRequest in interface ResourceBatchingConfiguration

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

public boolean isSourceMapEnabled()

Description copied from interface: ResourceBatchingConfiguration

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.

Specified by:

isSourceMapEnabled in interface ResourceBatchingConfiguration

optimiseSourceMapsForDevelopment

public boolean optimiseSourceMapsForDevelopment()

Description copied from interface: ResourceBatchingConfiguration

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).

Specified by:

optimiseSourceMapsForDevelopment in interface ResourceBatchingConfiguration