com.atlassian.confluence.plugins.createcontent.impl

Class DefaultBlueprintResolver

java.lang.Object

com.atlassian.confluence.plugins.createcontent.impl.DefaultBlueprintResolver

All Implemented Interfaces:

BlueprintResolver

public class DefaultBlueprintResolver
extends Object
implements BlueprintResolver

Constructor Summary

Constructors

Constructor and Description
DefaultBlueprintResolver(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager, ContentBlueprintManager contentBlueprintManager)

Method Summary

Modifier and Type	Method and Description
ContentBlueprint	getContentBlueprint(String contentBlueprintId, String blueprintModuleCompleteKey, String spaceKey) Finds the correct Blueprint for a given context.
com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor	getWebItemMatchingBlueprint(String blueprintModuleKey)
com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor	getWebItemMatchingBlueprint(UUID blueprintId)
ContentBlueprint	resolveContentBlueprint(String blueprintId, String spaceKey) Given a Blueprint Id, finds the "nearest" Blueprint - space, global or plugin (in that order) that should be used by calling code.
ContentTemplateRef	resolveTemplateRef(ContentTemplateRef templateRef) Given a template ref, finds the "nearest" template ref - space, global or plugin that should be used when editing the template or creating a page from it.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBlueprintResolver

public DefaultBlueprintResolver(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager,
                                ContentBlueprintManager contentBlueprintManager)

Method Detail

getWebItemMatchingBlueprint

public com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor getWebItemMatchingBlueprint(UUID blueprintId)

Specified by:

getWebItemMatchingBlueprint in interface BlueprintResolver

getWebItemMatchingBlueprint

public com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor getWebItemMatchingBlueprint(String blueprintModuleKey)

Specified by:

getWebItemMatchingBlueprint in interface BlueprintResolver

resolveTemplateRef

public ContentTemplateRef resolveTemplateRef(ContentTemplateRef templateRef)

Description copied from interface: BlueprintResolver

Given a template ref, finds the "nearest" template ref - space, global or plugin that should be used when editing the template or creating a page from it.

This resolution is required because we might get a template ref from a space-override of a Blueprint, but that template has been reverted. In that case, a globally-customised template ref for that Blueprint should be used, if it exists. If not, the template ref from the original plugin clone Blueprint.

Specified by:

resolveTemplateRef in interface BlueprintResolver

resolveContentBlueprint

@Nonnull
public ContentBlueprint resolveContentBlueprint(@Nonnull
                                                         String blueprintId,
                                                         @Nullable
                                                         String spaceKey)
                                                  throws IllegalArgumentException

Description copied from interface: BlueprintResolver

Given a Blueprint Id, finds the "nearest" Blueprint - space, global or plugin (in that order) that should be used by calling code.

This resolution is required because we might get a Blueprint Id from storage, but that Blueprint has been edited at the space or global level.

Note that this method does not allow for Ids that don't resolve to a Blueprint, it throws an exception rather than returning null.

Specified by:

resolveContentBlueprint in interface BlueprintResolver

Throws:

IllegalArgumentException

getContentBlueprint

@Nonnull
public ContentBlueprint getContentBlueprint(String contentBlueprintId,
                                                     String blueprintModuleCompleteKey,
                                                     String spaceKey)
                                              throws IllegalArgumentException

Description copied from interface: BlueprintResolver

Finds the correct Blueprint for a given context.

Specified by:

getContentBlueprint in interface BlueprintResolver

Throws:

IllegalArgumentException