com.atlassian.confluence.internal.bigpipe

Class DefaultConfluenceBigPipeManager

java.lang.Object

com.atlassian.confluence.internal.bigpipe.DefaultConfluenceBigPipeManager

All Implemented Interfaces:

ConfluenceBigPipeManager

public class DefaultConfluenceBigPipeManager
extends Object
implements ConfluenceBigPipeManager

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.internal.bigpipe.ConfluenceBigPipeManager

ConfluenceBigPipeManager.ConfluenceBigPipe

Field Summary

Fields inherited from interface com.atlassian.confluence.internal.bigpipe.ConfluenceBigPipeManager

BIGPIPE_MACRO_CONTEXT_FLAG

Constructor Summary

Constructors

Constructor and Description
DefaultConfluenceBigPipeManager(DarkFeaturesManager darkFeaturesManager)

Method Summary

Modifier and Type	Method and Description
ConfluenceBigPipeManager.ConfluenceBigPipe	consume() This method is very similar to ConfluenceBigPipeManager.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultConfluenceBigPipeManager

public DefaultConfluenceBigPipeManager(DarkFeaturesManager darkFeaturesManager)

Method Detail

isBigPipeEnabled

public boolean isBigPipeEnabled()

Description copied from interface: ConfluenceBigPipeManager

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)

Specified by:

isBigPipeEnabled in interface ConfluenceBigPipeManager

getRequestBigPipe

public ConfluenceBigPipeManager.ConfluenceBigPipe getRequestBigPipe()

Description copied from interface: ConfluenceBigPipeManager

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

Specified by:

getRequestBigPipe in interface ConfluenceBigPipeManager

macroExecutionStarted

public void macroExecutionStarted()

Description copied from interface: ConfluenceBigPipeManager

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.

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

Specified by:

macroExecutionStarted in interface ConfluenceBigPipeManager

isNestedExecution

public boolean isNestedExecution()

Description copied from interface: ConfluenceBigPipeManager

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

Specified by:

isNestedExecution in interface ConfluenceBigPipeManager

macroExecutionFinished

public void macroExecutionFinished()

Description copied from interface: ConfluenceBigPipeManager

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.

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

Specified by:

macroExecutionFinished in interface ConfluenceBigPipeManager

consume

public ConfluenceBigPipeManager.ConfluenceBigPipe consume()

Description copied from interface: ConfluenceBigPipeManager

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

Specified by:

consume in interface ConfluenceBigPipeManager