Package com.atlassian.confluence.vcache

Interface VCacheRequestContextOperations

All Known Implementing Classes:

DummyVCacheRequestContextOperations, VCacheRequestContextManager

public interface VCacheRequestContextOperations

Since:

5.10

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	VCacheRequestContextOperations.Action<T,X extends Throwable>

Method Summary

Modifier and Type	Method	Description
<T, X extends Throwable> T	doInRequestContext(VCacheRequestContextOperations.Action<T,X> action)	Executes the supplied action callback within a VCache RequestContext, using the system default partition identifier.
default void	doInRequestContext(Runnable action)	A simplified form of doInRequestContext(VCacheRequestContextManager.Action) that takes a Runnable callback.
<T, X extends Throwable> T	doInRequestContext(String partitionIdentifier, VCacheRequestContextOperations.Action<T,X> action)	Deprecated. since 6.0.
default Runnable	withRequestContext(Runnable task)	Wraps the supplied Runnable in a request context
default <T> Callable<T>	withRequestContext(Callable<T> task)	Wraps the supplied Callable in a request context

Method Details

doInRequestContext

<T,
X extends Throwable> T doInRequestContext(VCacheRequestContextOperations.Action<T,X> action)
                                      throws X

Executes the supplied action callback within a VCache RequestContext, using the system default partition identifier.

Type Parameters:

T - the return type of the callback

X - the exception type thrown by the callback

Parameters:

action - the callback to be executed within the request context

Returns:

the value returned by the callback

Throws:

X - the exception thrown by the callback

IllegalArgumentException - if the partition identifier is not the same as that provided by previous calls

doInRequestContext

@Deprecated
<T,
X extends Throwable> T doInRequestContext(String partitionIdentifier,
 VCacheRequestContextOperations.Action<T,X> action)
                                      throws X

Deprecated.

since 6.0. Partitions are not supported in Confluence Server

Executes the supplied action callback within a VCache RequestContext. If no request context is bound to the current thread, then one will be set up with the supplied partition identifier. Calls to this method may be nested. Nested calls will re-use the existing context bound by the first call. Nested calls must supply the same partition identifier as the first call.

Type Parameters:

T - the return type of the callback

X - the exception type thrown by the callback

Parameters:

partitionIdentifier - the partition identifier that will be used to create new request context, if necessary

action - the callback to be executed within the request context

Returns:

the value returned by the callback

Throws:

X - the exception thrown by the callback

IllegalArgumentException - if the partition identifier is not the same as that provided by previous calls

doInRequestContext

default void doInRequestContext(Runnable action)

A simplified form of doInRequestContext(VCacheRequestContextManager.Action) that takes a Runnable callback.

withRequestContext

default <T> Callable<T> withRequestContext(Callable<T> task)

Wraps the supplied Callable in a request context

withRequestContext

default Runnable withRequestContext(Runnable task)

Wraps the supplied Runnable in a request context