Package com.atlassian.confluence.plugin.webresource

Interface WebResourceDependenciesRecorder

All Known Implementing Classes:

ThreadlocalWebResourceDependenciesRecorder

public interface WebResourceDependenciesRecorder

Records the usages of various web resources when they are rendered.

Since:

5.9

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WebResourceDependenciesRecorder.RecordedResources	Holds the various resources that are recorded from recordResources(Callable).

Method Summary

Modifier and Type	Method	Description
<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>	record(Iterable<String> additionalContexts, Iterable<String> additionalResources, boolean includeSuperbatch, Callable<T> callback)	Deprecated. since 7.0.1.
<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>	record(Iterable<String> additionalContexts, Iterable<String> additionalResources, Iterable<String> excludeContexts, Iterable<String> excludeResources, boolean includeSuperbatch, Callable<T> callback)	Deprecated. since 7.0.1.
<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>	record(Iterable<String> additionalContexts, Iterable<String> additionalResources, Callable<T> callback)	Deprecated. since 7.0.1.
<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>	record(Callable<T> callback)	Deprecated. since 7.0.1.
default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>	recordResources(Iterable<String> additionalContexts, Iterable<String> additionalResources, boolean includeSuperbatch, Callable<T> callback)	Records the webresources used during the execution of the given callback.
default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>	recordResources(Iterable<String> additionalContexts, Iterable<String> additionalResources, Iterable<String> excludeContexts, Iterable<String> excludeResources, boolean includeSuperbatch, Callable<T> callback)
default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>	recordResources(Iterable<String> additionalContexts, Iterable<String> additionalResources, Callable<T> callback)	Same as calling recordResources(Iterable, Iterable, boolean, Callable), but with superbatch set to false.
default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources>	recordResources(Callable<T> callback)	Records the webresources used during the execution of the given callback.

Method Detail

record

@Deprecated
<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> record(Callable<T> callback)
                                                                                        throws Exception

Deprecated.

since 7.0.1. Use recordResources(Callable)

Records the webresources used during the execution of the given callback. Same as calling recordResources(Iterable, Iterable, Callable) without any overrides.

Type Parameters:

T - the return value of the callback

Parameters:

callback - the code to execute during recording

Returns:

a pair of objects. Left is the value returned by the callback, right is the set of webresources that is assembled during the execution of the given callback.

Throws:

Exception - if the callback threw an exception.

recordResources

default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> recordResources(Callable<T> callback)
                                                                                                        throws Exception

Records the webresources used during the execution of the given callback. Same as calling recordResources(Iterable, Iterable, Callable) without any overrides.

Type Parameters:

T - the return value of the callback

Parameters:

callback - the code to execute during recording

Returns:

a pair of objects. Left is the value returned by the callback, right is the set of webresources that is assembled during the execution of the given callback.

Throws:

Exception - if the callback threw an exception.

Since:

7.0.1

record

@Deprecated
<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> record(Iterable<String> additionalContexts,
                                                                                               Iterable<String> additionalResources,
                                                                                               Callable<T> callback)
                                                                                        throws Exception

Deprecated.

since 7.0.1. Use recordResources(Iterable, Iterable, Callable)

Same as calling recordResources(Iterable, Iterable, boolean, Callable), but with superbatch set to false.

Type Parameters:

T - the return value of the callback.

Parameters:

additionalContexts - the context that should be added to the set of webresources (which may not be in the callback)

additionalResources - the additional resources that should be added to the set of webresources (which may not be in the callback)

callback - the code to execute during recording

Returns:

a pair of objects. Left is the value returned by the callback, right is the set of webresources that is assembled during the execution of the given callback.

Throws:

Exception - if the callback threw an exception.

recordResources

default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> recordResources(Iterable<String> additionalContexts,
                                                                                                               Iterable<String> additionalResources,
                                                                                                               Callable<T> callback)
                                                                                                        throws Exception

Same as calling recordResources(Iterable, Iterable, boolean, Callable), but with superbatch set to false.

Type Parameters:

T - the return value of the callback.

Parameters:

additionalContexts - the context that should be added to the set of webresources (which may not be in the callback)

additionalResources - the additional resources that should be added to the set of webresources (which may not be in the callback)

callback - the code to execute during recording

Returns:

a pair of objects. Left is the value returned by the callback, right is the set of webresources that is assembled during the execution of the given callback.

Throws:

Exception - if the callback threw an exception.

Since:

7.0.1

record

@Deprecated
<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> record(Iterable<String> additionalContexts,
                                                                                               Iterable<String> additionalResources,
                                                                                               boolean includeSuperbatch,
                                                                                               Callable<T> callback)
                                                                                        throws Exception

Deprecated.

since 7.0.1. Use recordResources(Iterable, Iterable, boolean, Callable)

Records the webresources used during the execution of the given callback.

Type Parameters:

T - the return value of the callback.

Parameters:

additionalContexts - the context that should be added to the set of webresources (which may not be in the callback)

additionalResources - the additional resources that should be added to the set of webresources (which may not be in the callback)

includeSuperbatch - true if the record should include the superbatch.

callback - the code to execute during recording

Returns:

a pair of objects. Left is the value returned by the callback, right is the set of webresources that is assembled during the execution of the given callback.

Throws:

Exception - if the callback threw an exception.

recordResources

default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> recordResources(Iterable<String> additionalContexts,
                                                                                                               Iterable<String> additionalResources,
                                                                                                               boolean includeSuperbatch,
                                                                                                               Callable<T> callback)
                                                                                                        throws Exception

Records the webresources used during the execution of the given callback.

Type Parameters:

T - the return value of the callback.

Parameters:

additionalContexts - the context that should be added to the set of webresources (which may not be in the callback)

additionalResources - the additional resources that should be added to the set of webresources (which may not be in the callback)

includeSuperbatch - true if the record should include the superbatch.

callback - the code to execute during recording

Returns:

a pair of objects. Left is the value returned by the callback, right is the set of webresources that is assembled during the execution of the given callback.

Throws:

Exception - if the callback threw an exception.

Since:

7.0.1

record

@Deprecated
<T> com.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> record(Iterable<String> additionalContexts,
                                                                                               Iterable<String> additionalResources,
                                                                                               Iterable<String> excludeContexts,
                                                                                               Iterable<String> excludeResources,
                                                                                               boolean includeSuperbatch,
                                                                                               Callable<T> callback)
                                                                                        throws Exception

Deprecated.

since 7.0.1. Use recordResources(Iterable, Iterable, Iterable, Iterable, boolean, Callable)

Throws:

Exception

recordResources

default <T> io.atlassian.fugue.Pair<T,WebResourceDependenciesRecorder.RecordedResources> recordResources(Iterable<String> additionalContexts,
                                                                                                               Iterable<String> additionalResources,
                                                                                                               Iterable<String> excludeContexts,
                                                                                                               Iterable<String> excludeResources,
                                                                                                               boolean includeSuperbatch,
                                                                                                               Callable<T> callback)
                                                                                                        throws Exception

Throws:

Exception

Since:

7.0.1