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

static String	PLUGIN_WEB_RESOURCE_BATCH_CONTENT_TRACKING
static String	PLUGIN_WEBRESOURCE_BATCHING_OFF
static String	PLUGIN_WEBRESOURCE_TRY_CATCH_WRAPPING

Constructor Summary

DefaultResourceBatchingConfiguration()

Method Summary

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	isPluginWebResourceBatchingEnabled() Determines whether plugin resources of the same type defined within a single web resource are batched into one file.
boolean	isSuperBatchingEnabled() Gets whether web resources in different resource modules should be batched together.

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_WEBRESOURCE_TRY_CATCH_WRAPPING

public static final String PLUGIN_WEBRESOURCE_TRY_CATCH_WRAPPING

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

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.

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.