com.atlassian.plugin.webresource.impl

Class RequestState

java.lang.Object

com.atlassian.plugin.webresource.impl.RequestState

public class RequestState
extends Object

State maintained during single request.

Since:

3.3

Constructor Summary

Constructors

Constructor and Description
RequestState(Globals globals, UrlBuildingStrategy urlBuildingStrategy)
RequestState(Globals globals, UrlBuildingStrategy urlBuildingStrategy, boolean autoIncludeFrontendRuntime)
RequestState(RequestState other)

Method Summary

Modifier and Type	Method and Description
void	clearIncludedAndUpdateExcluded(ResourcePhase resourcePhase, Set<String> excludedResolved) Called after generating urls, to clear current state and remember already included resources.
RequestState	deepClone()
BigPipe	getBigPipe()
long	getBigPipeDeadline()
LinkedHashSet<String>	getExcluded() Deprecated.
Set<String>	getExcludedData()
Set<String>	getExcludedResolved() Most UI code is not written to be idempotent, so content for each Requestable should only ever be served to the UI once.
Globals	getGlobals() Deprecated. since 5.0.0. There is no replacement. Don't use god objects.
LinkedHashSet<String>	getIncluded() Deprecated.
LinkedHashSet<String>	getIncluded(ResourcePhase phaseType) Deprecated.
LinkedHashMap<String,com.atlassian.json.marshal.Jsonable>	getIncludedData()
LinkedHashMap<String,com.atlassian.json.marshal.Jsonable>	getIncludedData(ResourcePhase resourcePhase)
RawRequest	getRawRequest()
RequestCache	getRequestCache()
Snapshot	getSnapshot() Get all bundles.
SuperbatchConfiguration	getSuperbatchConfiguration()
Optional<DefaultWebResourceSet>	getSyncResourceSet() Deprecated. since 5.6.0. Check sync resources via getRawRequest() with ResourcePhase.INLINE.
UrlBuildingStrategy	getUrlStrategy()
boolean	isAutoIncludeFrontendRuntimeEnabled() Whether to automatically include frontend runtime modules (e.g., WRM.require, WRM.data) automatically when the feature is used.
boolean	isSyncbatchEnabled()
void	markSyncResourcesAsWritten() Deprecated. since 5.6.0. Covered by existing excludedResolved mechanism and ResourcePhase.INLINE.
void	setBigPipeDeadline(long deadline)
void	setSyncbatchEnabled(boolean enabled)
void	setSyncResourceSet(DefaultWebResourceSet set) Deprecated. since 5.6.0. Use setSyncbatchEnabled(boolean) instead.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestState

public RequestState(Globals globals,
                    UrlBuildingStrategy urlBuildingStrategy)

RequestState

public RequestState(Globals globals,
                    UrlBuildingStrategy urlBuildingStrategy,
                    boolean autoIncludeFrontendRuntime)

RequestState

public RequestState(RequestState other)

Method Detail

clearIncludedAndUpdateExcluded

public void clearIncludedAndUpdateExcluded(@Nonnull
                                           ResourcePhase resourcePhase,
                                           @Nonnull
                                           Set<String> excludedResolved)

Called after generating urls, to clear current state and remember already included resources.

deepClone

@Nonnull
public RequestState deepClone()

getBigPipe

@Nonnull
public BigPipe getBigPipe()

getBigPipeDeadline

public long getBigPipeDeadline()

setBigPipeDeadline

public void setBigPipeDeadline(long deadline)

getRequestCache

@Nonnull
public RequestCache getRequestCache()

getExcluded

@Nonnull
 @Deprecated
public LinkedHashSet<String> getExcluded()

Deprecated.

See Also:

RawRequest.getExcludedAsLooseType()

getExcludedData

@Nonnull
public Set<String> getExcludedData()

getIncluded

@Nonnull
 @Deprecated
public LinkedHashSet<String> getIncluded()

Deprecated.

See Also:

RawRequest.getIncludedAsLooseType()

getIncluded

@Nonnull
 @Deprecated
public LinkedHashSet<String> getIncluded(@Nonnull
                                                               ResourcePhase phaseType)

Deprecated.

See Also:

RawRequest.getIncludedAsLooseType()

getIncludedData

@Nonnull
public LinkedHashMap<String,com.atlassian.json.marshal.Jsonable> getIncludedData()

getIncludedData

@Nonnull
public LinkedHashMap<String,com.atlassian.json.marshal.Jsonable> getIncludedData(@Nonnull
                                                                                          ResourcePhase resourcePhase)

getExcludedResolved

@Nonnull
public Set<String> getExcludedResolved()

Most UI code is not written to be idempotent, so content for each Requestable should only ever be served to the UI once. Use this list to avoid incurring the full graph traversal cost each time you need the complete list of "already used" content, such as:

• Bailing faster in graph traversal if an item in this list is encountered,
• Identifying content sets that would cause something to be served twice,
• Avoiding serving "empty" content sets once accounting for this list,
• and so on.

Since:

5.5

See Also:

BundleFinder.excludedResolved(Collection), Resolved, CalculatedBatches.getExcludedResolved(), RequiredResources.exclude(Set, Set)

getGlobals

@Nonnull
public Globals getGlobals()

Deprecated. since 5.0.0. There is no replacement. Don't use god objects.

getRawRequest

public RawRequest getRawRequest()

getSnapshot

@Nonnull
public Snapshot getSnapshot()

Get all bundles.

It is another layer of cache over the 'globals.getBundles()' because it is used very heavily, to avoid any performance drawbacks of atomic reference in the 'globals.getBundles()'.

isAutoIncludeFrontendRuntimeEnabled

public boolean isAutoIncludeFrontendRuntimeEnabled()

Whether to automatically include frontend runtime modules (e.g., WRM.require, WRM.data) automatically when the feature is used.

Returns:

true if modules should be automatically included; false if they should be manually required.

Since:

5.5.0

getSyncResourceSet

@Deprecated
 @Nonnull
public Optional<DefaultWebResourceSet> getSyncResourceSet()

Deprecated. since 5.6.0. Check sync resources via getRawRequest() with ResourcePhase.INLINE.

Returns:

Initial set of sync resources which should be written at the top of the page.

Since:

3.5.27

setSyncResourceSet

@Deprecated
public void setSyncResourceSet(@Nullable
                                           DefaultWebResourceSet set)

Deprecated. since 5.6.0. Use setSyncbatchEnabled(boolean) instead.

Set the initial set of sync resources which should be written at the top of the page.

Since:

3.5.27

getUrlStrategy

public UrlBuildingStrategy getUrlStrategy()

markSyncResourcesAsWritten

@Deprecated
public void markSyncResourcesAsWritten()

Deprecated. since 5.6.0. Covered by existing excludedResolved mechanism and ResourcePhase.INLINE.

Mark that the initial set of sync resources was already written into page.

Since:

3.5.27

getSuperbatchConfiguration

public SuperbatchConfiguration getSuperbatchConfiguration()

setSyncbatchEnabled

public void setSyncbatchEnabled(boolean enabled)

isSyncbatchEnabled

public boolean isSyncbatchEnabled()

toString

public String toString()

Overrides:

toString in class Object