com.atlassian.webresource.api.assembler

Interface WebResourceAssembler

@ExperimentalApi
public interface WebResourceAssembler

Stateful component that handles inclusion of css, javascript and data resources. This may be used as a request-local for rendering the current page but it can also be constructed as a standalone instance for other use cases requiring sets of resources.

Within a single instance of this class, previously drained resources are tracked such that any subsequent calls to assembled().drainIncludedResources() will not return the resources that were previously 'drained' - regardless of any require calls made.

This class supports tracking promises of data resources (see RequiredData.requireData(String, CompletionStage). Draining *does not block* or wait for any of those promises to become available, but it will return any complete promises. See AssembledResources.pollIncludedResources() for a blocking operation.

WebResourceAssemblers are constructed by calling WebResourceAssemblerFactory.create().

The WebResourceAssembler, for rendering the current page in the current HTTP request is found by calling PageBuilderService.assembler().

Note, WebResourceAssembler is currently an experimental API and may break between versions of web resources. It is advised that you use WebResourceManager in the mean time if you require a stable API.

Since:

v3.0

See Also:

PageBuilderService

Method Summary

Modifier and Type	Method and Description
AssembledResources	assembled()
WebResourceAssembler	copy()
RequiredData	data()
RequiredResources	resources()

Method Detail

assembled

AssembledResources assembled()

Returns:

AssembledResources for rendering included resources onto the page

resources

RequiredResources resources()

Returns:

RequiredResources for requesting resources to be included or excluded

data

RequiredData data()

Returns:

RequiredData for requesting data to be included or excluded

copy

WebResourceAssembler copy()

Returns:

a deep clone of this WebResourceAssembler's current state, including the list of previously drained resources and resources that have been required by not yet drained. Calls to any methods in the cloned instance will not affect this instance.

The returned copy will be disconnected from this assembler's bigpipe. The copy will not contain any complete but undrained promises, and any subsequent promise completions will not be visible in the copy.