com.atlassian.webresource.api.assembler

Interface WebResourceAssemblerBuilder

@ExperimentalApi
public interface WebResourceAssemblerBuilder

Builder for constructing WebResourceAssembler

Since:

v3.0

Method Summary

Modifier and Type	Method and Description
WebResourceAssemblerBuilder	asyncDataDeadline(long deadline, TimeUnit timeunit) Asynchronous data can be required with RequiredData.requireData(String, CompletionStage).
WebResourceAssemblerBuilder	autoIncludeFrontendRuntime(boolean include) Occasionally a WRM feature requires supporting frontend code to work, such as when the interactive or lazy-load resource phases are used.
WebResourceAssembler	build() Constructs a WebResourceAssembler
WebResourceAssemblerBuilder	includeSuperbatchResources(boolean include) Deprecated. since 5.5.0. Use RequiredResources.excludeSuperbatch() instead.
WebResourceAssemblerBuilder	includeSyncbatchResources(boolean include) The sync batch is implicitly included in every request.

Method Detail

includeSuperbatchResources

@Deprecated
WebResourceAssemblerBuilder includeSuperbatchResources(boolean include)

Deprecated. since 5.5.0. Use RequiredResources.excludeSuperbatch() instead.

In addition to any resources explicitly added to the WebResourceAssembler, always implicitly include resources from the superbatch. When disabled, superbatch resources are not implicitly included, but may be individually (and explicitly) included by requiring them with the WebResourceAssembler.

includeSyncbatchResources

WebResourceAssemblerBuilder includeSyncbatchResources(boolean include)

The sync batch is implicitly included in every request. When disabled, resources in the sync batch will not be served unless they are explicitly required with the WebResourceAssembler.

Parameters:

include - whether to serve the sync batch contents or not.

Since:

5.5.0

autoIncludeFrontendRuntime

WebResourceAssemblerBuilder autoIncludeFrontendRuntime(boolean include)

Occasionally a WRM feature requires supporting frontend code to work, such as when the interactive or lazy-load resource phases are used. When enabled (the default value), when such features are used, relevant frontend code will be added to the list of required resources and contexts. When disabled, these resources will not be served unless they are explicitly required with the WebResourceAssembler.

Parameters:

include - whether to automatically include frontend runtime modules or not.

Since:

5.5.0

asyncDataDeadline

WebResourceAssemblerBuilder asyncDataDeadline(long deadline,
                                              TimeUnit timeunit)

Asynchronous data can be required with RequiredData.requireData(String, CompletionStage). Such promises must complete within a deadline, otherwise they will considered as if they completed exceptionally and any value they may have returned will be discarded. The timer for the deadline starts when build() is called.

build

WebResourceAssembler build()

Constructs a WebResourceAssembler

Returns:

a WebResourceAssembler