com.atlassian.confluence.plugins.createcontent

Class BandanaBlueprintStateController

java.lang.Object

com.atlassian.confluence.plugins.createcontent.AbstractBandanaBlueprintStateController

com.atlassian.confluence.plugins.createcontent.BandanaBlueprintStateController

All Implemented Interfaces:

BlueprintStateController

public class BandanaBlueprintStateController
extends AbstractBandanaBlueprintStateController
implements BlueprintStateController

Constructor Summary

Constructors

Constructor and Description
BandanaBlueprintStateController(com.atlassian.bandana.BandanaManager bandanaManager, ContentBlueprintManager contentBlueprintManager, com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager, PageTemplateGrouper pageTemplateGrouper, com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Summary

Modifier and Type	Method and Description
void	disableBlueprint(UUID blueprintId, com.atlassian.confluence.spaces.Space space) Disable a content blueprint plugin by its id for a particular space, or globally if space is null.
void	disableBlueprints(Set<UUID> blueprintIds, com.atlassian.confluence.spaces.Space space) Disable a set of content blueprint plugin ids for a particular space, or globally if space is null.
void	enableBlueprint(UUID blueprintId, com.atlassian.confluence.spaces.Space space) Enable a content blueprint plugin id for a particular space, or globally if space is null.
Map<UUID,BlueprintState>	getAllContentBlueprintState(String section, com.atlassian.confluence.user.ConfluenceUser user, com.atlassian.confluence.spaces.Space space) Returns a set of blueprint keys that are available to a user in a given space.
Set<UUID>	getDisabledBlueprintIds(com.atlassian.confluence.spaces.Space space) Returns a set of disabled blueprints UUIDs.
Set<String>	getDisabledBlueprintModuleCompleteKeys(com.atlassian.confluence.spaces.Space space) Returns a set of disabled blueprints module complete keys.

Methods inherited from class com.atlassian.confluence.plugins.createcontent.AbstractBandanaBlueprintStateController

buildBlueprintStateMap, disableBlueprint, disableBlueprints, enableBlueprint, getDisabledBlueprintIds, getDisabledPluginIds, getDisabledSpaceBlueprintModuleCompleteKeys

Methods inherited from class java.lang.Object

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

Constructor Detail

BandanaBlueprintStateController

public BandanaBlueprintStateController(com.atlassian.bandana.BandanaManager bandanaManager,
                                       ContentBlueprintManager contentBlueprintManager,
                                       com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager,
                                       PageTemplateGrouper pageTemplateGrouper,
                                       com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Detail

enableBlueprint

public void enableBlueprint(UUID blueprintId,
                            com.atlassian.confluence.spaces.Space space)

Description copied from interface: BlueprintStateController

Enable a content blueprint plugin id for a particular space, or globally if space is null.

Specified by:

enableBlueprint in interface BlueprintStateController

Parameters:

blueprintId - id of the blueprint to be enabled

space - the space to enable this module in

disableBlueprint

public void disableBlueprint(UUID blueprintId,
                             com.atlassian.confluence.spaces.Space space)

Description copied from interface: BlueprintStateController

Disable a content blueprint plugin by its id for a particular space, or globally if space is null.

Specified by:

disableBlueprint in interface BlueprintStateController

Parameters:

blueprintId - id of the blueprint to be disabled

space - the space to disable this module in

disableBlueprints

public void disableBlueprints(Set<UUID> blueprintIds,
                              com.atlassian.confluence.spaces.Space space)

Description copied from interface: BlueprintStateController

Disable a set of content blueprint plugin ids for a particular space, or globally if space is null.

Specified by:

disableBlueprints in interface BlueprintStateController

Parameters:

blueprintIds - set of blueprint ids to be disabled

space - the space to disable this module in

getDisabledBlueprintIds

public Set<UUID> getDisabledBlueprintIds(com.atlassian.confluence.spaces.Space space)

Description copied from interface: BlueprintStateController

Returns a set of disabled blueprints UUIDs.

Specified by:

getDisabledBlueprintIds in interface BlueprintStateController

Parameters:

space - (required) the space

Returns:

all keys of disabled content blueprint plugin modules in the specified space, an empty set if none is found

getDisabledBlueprintModuleCompleteKeys

public Set<String> getDisabledBlueprintModuleCompleteKeys(com.atlassian.confluence.spaces.Space space)

Description copied from interface: BlueprintStateController

Returns a set of disabled blueprints module complete keys.

Specified by:

getDisabledBlueprintModuleCompleteKeys in interface BlueprintStateController

Parameters:

space - (required) the space

Returns:

all keys of disabled content blueprint plugin modules in the specified space, an empty set if none is found

getAllContentBlueprintState

public Map<UUID,BlueprintState> getAllContentBlueprintState(@Nonnull
                                                            String section,
                                                            @Nullable
                                                            com.atlassian.confluence.user.ConfluenceUser user,
                                                            @Nullable
                                                            com.atlassian.confluence.spaces.Space space)

Description copied from interface: BlueprintStateController

Returns a set of blueprint keys that are available to a user in a given space. If a blueprint is content blueprint plugin backed, it is only returned if its Condition evaluates to true and if the content blueprint plugin module is enabled.

Specified by:

getAllContentBlueprintState in interface BlueprintStateController

user - (optional) the user. null for anonymous

space - (optional) the space. If null is specified, disabled in space state will be false for all results

Returns:

all the keys of blueprints that are available to a user in the space, an empty set if none is found