com.atlassian.plugin.webresource.prebake

Interface PrebakeWebResourceAssemblerFactory

All Superinterfaces:

WebResourceAssemblerFactory

All Known Implementing Classes:

DefaultWebResourceAssemblerFactory

public interface PrebakeWebResourceAssemblerFactory
extends WebResourceAssemblerFactory

A WebResourceAssemblerFactory that exposes prebake capabilities (also see com.atlassian.webresource.api.prebake).

This factory provides direct capability to produce all possible dimensions via computeDimensions(). For any given coordinate within those dimensions, you can create a PrebakeWebResourceAssembler locked to that coordinate via PrebakeWebResourceAssemblerBuilder.withCoordinate(Coordinate). Subsequent calls to requireResource()/requireContext()/drain()/poll() will deal with the given coordinate, and not the thread-local behaviour a condition/transform would normally have.

If a condition or transform is encountered that is not dimension-aware, then the attempt to prebake that resource will fail, and this can be detected with PluginUrlResource.getPrebakeErrors(). This should be checked on each webresource after each call to drain() or poll().

Since:

v3.5.0

Method Summary

Modifier and Type	Method and Description
Dimensions	computeBundleDimensions(Bundle bundle)
Dimensions	computeDimensions()
String	computeGlobalStateHash() Produce a hash that indicates the "state" of the WRM.
PrebakeWebResourceAssemblerBuilder	create()

Methods inherited from interface com.atlassian.webresource.api.assembler.WebResourceAssemblerFactory

clearCache

Method Detail

create

PrebakeWebResourceAssemblerBuilder create()

Specified by:

create in interface WebResourceAssemblerFactory

computeDimensions

Dimensions computeDimensions()

computeBundleDimensions

Dimensions computeBundleDimensions(Bundle bundle)

Parameters:

bundle - for which you want to get dimensions.

Returns:

Dimensions related to given bundle.

Since:

3.5.22

computeGlobalStateHash

String computeGlobalStateHash()

Produce a hash that indicates the "state" of the WRM. Two WRMs in two different JVMs will produce the same state hash if they would produce the same pre-bake.