com.atlassian.confluence.internal.bigpipe

Interface ConfluenceBigPipeManager

All Known Implementing Classes:

DefaultConfluenceBigPipeManager

@ThreadSafe
 @ExperimentalApi
public interface ConfluenceBigPipeManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ConfluenceBigPipeManager.ConfluenceBigPipe

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIGPIPE_MACRO_CONTEXT_FLAG

Method Summary

Modifier and Type	Method and Description
ConfluenceBigPipeManager.ConfluenceBigPipe	consume() This method is very similar to getRequestBigPipe(), but this method also deletes ConfluenceBigPipeManager.ConfluenceBigPipe from request cache.
ConfluenceBigPipeManager.ConfluenceBigPipe	getRequestBigPipe() Returns the BigPipe instance for the current request.
boolean	isBigPipeEnabled() Returns true if BigPipe is available for use.
boolean	isNestedExecution() Returns true if any macro is executing at the moment, false otherwise.
void	macroExecutionFinished() Macro may be executed in a body of another macro.
void	macroExecutionStarted() Macro may be executed in a body of another macro.

Field Detail

BIGPIPE_MACRO_CONTEXT_FLAG

static final String BIGPIPE_MACRO_CONTEXT_FLAG

See Also:

Constant Field Values

Method Detail

isBigPipeEnabled

boolean isBigPipeEnabled()

Returns true if BigPipe is available for use. Criteria for returning true is that current thread is in a request context, and bigpipe has not been otherwise disabled (via url parameters or system properties)

getRequestBigPipe

ConfluenceBigPipeManager.ConfluenceBigPipe getRequestBigPipe()

Returns the BigPipe instance for the current request. Throws an exception if not in a request context.

macroExecutionStarted

void macroExecutionStarted()

Macro may be executed in a body of another macro. All "nested" macros should be opted out for deferred execution. Unfortunately Confluence doesn't provide any way of defining execution context (page vs macro body), so we have to use this hack to notify ConfluenceBigPipeManager about execution context.

macroExecutionStarted() should be called at the beginning of macro execution, and macroExecutionFinished() should be called right after macro execution is finished. These methods are used in ViewMacroMarshaller.

isNestedExecution

boolean isNestedExecution()

Returns true if any macro is executing at the moment, false otherwise.

macroExecutionFinished

void macroExecutionFinished()

Macro may be executed in a body of another macro. All "nested" macros should be opted out for deferred execution. Unfortunately Confluence doesn't provide any way of defining execution context (page vs macro body), so we have to use this hack to notify ConfluenceBigPipeManager about execution context.

macroExecutionStarted() should be called at the beginning of macro execution, and macroExecutionFinished() should be called right after macro execution is finished. These methods are used in ViewMacroMarshaller.

consume

ConfluenceBigPipeManager.ConfluenceBigPipe consume()

This method is very similar to getRequestBigPipe(), but this method also deletes ConfluenceBigPipeManager.ConfluenceBigPipe from request cache.