com.atlassian.confluence.plugins.createcontent.actions

Class AbstractCreateBlueprintPageAction

java.lang.Object

com.opensymphony.xwork.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.pages.actions.AbstractPageAwareAction

com.atlassian.confluence.pages.actions.AbstractPageAction

com.atlassian.confluence.pages.actions.AbstractPreviewPageAction

com.atlassian.confluence.pages.actions.AbstractTemplatePageAction

com.atlassian.confluence.pages.actions.AbstractCreateAndEditPageAction

com.atlassian.confluence.pages.actions.AbstractCreatePageAction

com.atlassian.confluence.pages.actions.CreatePageAction

com.atlassian.confluence.plugins.createcontent.actions.AbstractCreateBlueprintPageAction

All Implemented Interfaces:

com.atlassian.confluence.core.Beanable, com.atlassian.confluence.pages.actions.PageAware, com.atlassian.confluence.pages.actions.TinyUrlAware, com.atlassian.confluence.plugin.descriptor.web.WebInterface, com.atlassian.confluence.security.CaptchaAware, com.atlassian.confluence.spaces.Spaced, com.atlassian.confluence.util.breadcrumbs.BreadcrumbAware, com.atlassian.confluence.validation.MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

Direct Known Subclasses:

CreateAndEditAction, CreateAndViewAction

public abstract class AbstractCreateBlueprintPageAction
extends com.atlassian.confluence.pages.actions.CreatePageAction

Provides base services needed by the concrete create-related actions for blueprints.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.confluence.pages.actions.CreatePageAction

com.atlassian.confluence.pages.actions.CreatePageAction.SimplePageProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentBlueprint	contentBlueprint
protected ContentBlueprintManager	contentBlueprintManager
protected Map<String,Object>	context

Fields inherited from class com.atlassian.confluence.pages.actions.CreatePageAction

pageProvider

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractCreatePageAction

attachmentManager, breadcrumbGenerator, contextProvider, INPUT_VARIABLES, originalReferrer, space, themeManager

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractCreateAndEditPageAction

ACTIVITY_UNAVAILABLE, captchaManager, CLOSE_CANCEL_RESULT, collaborativeEditingHelper, DISCARD_CANCEL_RESULT, draftManager, draftService, draftsTransitionHelper, heartbeatManager, LOCKED, newSpaceKey, notificationManager, pageService, parentPage, parentPageId, parentPageSpaceKey, parentPageString, parentPageTitle, targetId, USER_LIMIT_REACHED

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractTemplatePageAction

pageTemplateManager, templateId

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractPreviewPageAction

back, bean, formatConverter, inPreview, preview, storageFormat, wikiStyleRenderer, wysiwygContent

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractPageAction

incomingLinks, linkManager, pageManager, PREVIEW, RICHTEXT, viewRenderer, wysiwygConverter

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractPageAwareAction

contentPermissionManager, spaceManager

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, pluginAccessor, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
AbstractCreateBlueprintPageAction()

Method Summary

Modifier and Type	Method and Description
String	getFormaction()
boolean	getGoToIndexPage()
protected com.atlassian.confluence.pages.Page	getOrCreateIndexPage()
protected com.atlassian.confluence.pages.PageManager	getPageManager()
protected com.atlassian.confluence.pages.Page	populateBlueprintPage() Loads the Blueprint content template and generates the Blueprint Page from the template and the context.
protected void	sendBlueprintPageCreateEvent(com.atlassian.confluence.pages.Page page)
void	setBlueprintManager(BlueprintManager blueprintManager)
void	setConfluenceWebResourceManager(com.atlassian.confluence.plugin.webresource.ConfluenceWebResourceManager confluenceWebResourceManager)
void	setContentBlueprintId(String id)
void	setContentBlueprintManager(ContentBlueprintManager contentBlueprintManager)
void	setContentGenerator(BlueprintContentGenerator contentGenerator)
void	setContentTemplateKey(String contentTemplateKey) Deprecated.
void	setContentTemplateRefId(String contentTemplateRefId) Allows create POSTs to override the plugin descriptor's defined template key.
protected void	setContext(Map<String,Object> context)
void	setContextJson(String contextJson)
void	setContextPathHolder(com.atlassian.confluence.core.ContextPathHolder contextPathHolder)
void	setEditorFormatService(com.atlassian.confluence.xhtml.api.EditorFormatService editorFormatService)
void	setGoToIndexPage(boolean goToIndexPage)
void	setSpaceKey(String spaceKey) Permissions checking is currently done against the space associated with "newSpaceKey" (as opposed to "spaceKey").
void	storeBlueprintKeyInEditorContext() We need to pass information from this action call to the one where the form is submitted, so that we know which 'simple' blueprint module is being used and which index page should be created, etc.
void	storeBlueprintPageIndicatorInEditorContext()
protected void	validatePageTitleAgainstIndexPageTitle()

Methods inherited from class com.atlassian.confluence.pages.actions.CreatePageAction

assignParentPage, assignSpace, createCommand, createDraft, createPage, doDefault, doTemplateDefault, getCommandActionHelper, getCreatedAbstractPage, getInheritedViewPermissions, getLinkCreation, getPageToCreate, initialiseProvider, isPermitted, populateParentPageTitleField, setEncodedTitle, setLinkCreation, validate

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractCreatePageAction

afterAdd, beforeAdd, doAdd, getAttachmentSourceContent, getBreadcrumb, getCancelRedirectUrl, getCancelResult, getContentBreadcrumb, getContentType, getFromPage, getFromPageId, getNewSpace, getOriginalReferrer, getQueryString, getSpace, getSpaceKey, hasSetPagePermissionsPermission, isInvalidPageTitle, isPageRequired, populateContextProvider, setAttachmentManager, setBreadcrumbGenerator, setFromPageId, setOriginalReferrer, setQueryString, setThemeManager, setTitleWritten, transferDraftAttachments

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractCreateAndEditPageAction

getCaptchaManager, getCollaborativeEditingHelper, getConfluenceRevision, getContentDraft, getContentObject, getCurrentEditPermission, getCurrentViewPermission, getDraft, getDraftAsCEO, getDraftId, getDraftShareId, getEntityId, getExistingDraft, getExistingDraftId, getLabels, getLabelsString, getMovePageCommand, getNewSpaceKey, getNotificationManager, getParentPage, getParentPageId, getParentPageSpaceKey, getParentPageString, getParentPageTitle, getPermissionTypes, getPosition, getSynchronyRevisionSource, getSyncRev, getTargetId, getTitle, getViewInheritedContentPermissionSets, getWebInterfaceContext, hasDraftPermission, isCollaborativeContent, isNewAbstractPage, isRestricted, isShowDraftMessage, isUseDraft, setAutomaticWatchIfRequired, setCaptchaManager, setCollaborativeEditingHelper, setDraftId, setDraftManager, setDraftService, setDraftShareId, setDraftsTransitionHelper, setHeartbeatManager, setLabelsString, setLabelsString, setNewSpaceKey, setNotificationManager, setPageService, setParentPageId, setParentPageSpaceKey, setParentPageString, setParentPageTitle, setPermissions, setPosition, setSharedDraftsDarkFeatureHelper, setShowDraftMessage, setSpaceService, setSyncRev, setTargetId, setTitle, setUseDraft, startHeartbeatOnDoDefault, validateDuplicatePageTitle

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractTemplatePageAction

getGlobalPageTemplates, getPageTemplate, getSpacePageTemplates, getTemplateId, isPageTemplatesAvailable, loadTemplates, setPageTemplateManager, setTemplateId

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPreviewPageAction

getBean, getContentForSaving, getConversionContext, getEditorFormattedContent, getInPreview, getRenderContext, getStorageFormat, getWysiwygContent, getxHtmlContent, setBack, setFormatConverter, setInPreview, setPreview, setWikiStyleRenderer, setWysiwygContent, updateXHtmlContent

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPageAction

displayDatePath, getAvailableSpaces, getBeanKey, getBlogPost, getEditorVersion, getHelper, getIncomingLinks, getMode, getNextPost, getNumberOfAttachmentsAsString, getNumberOfLabelsAsString, getPermittedChildren, getPostingDate, getPostingDay, getPreviousPost, getPreviousVersion, getSpaceManager, getSuggestedLabels, getTinyUrl, hasAttachFilePermissions, hasPermittedChildren, isSpaceAdmin, isSuperUser, isUserWatchingOwnContent, setConfluenceWysiwygConverter, setEditorManager, setLinkManager, setMode, setPageManager, setPostingDate, setViewRenderer

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPageAwareAction

getFriendlyDateFormatterHelper, getPage, getPageId, hasViewPagePermission, isLatestVersionRequired, isViewPermissionRequired, setContentPermissionManager, setPage, setSpaceManager

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getConfluenceAccessManager, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSharedMode, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setApiDateFormatService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, execute, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.pages.actions.PageAware

isEditPermissionRequired

Field Detail

contentBlueprint

protected ContentBlueprint contentBlueprint

context

protected Map<String,Object> context

contentBlueprintManager

protected ContentBlueprintManager contentBlueprintManager

Constructor Detail

AbstractCreateBlueprintPageAction

public AbstractCreateBlueprintPageAction()

Method Detail

validatePageTitleAgainstIndexPageTitle

protected void validatePageTitleAgainstIndexPageTitle()

getOrCreateIndexPage

protected com.atlassian.confluence.pages.Page getOrCreateIndexPage()

populateBlueprintPage

protected com.atlassian.confluence.pages.Page populateBlueprintPage()
                                                             throws com.atlassian.confluence.content.render.xhtml.XhtmlException

Loads the Blueprint content template and generates the Blueprint Page from the template and the context.

Throws:

com.atlassian.confluence.content.render.xhtml.XhtmlException

storeBlueprintKeyInEditorContext

public void storeBlueprintKeyInEditorContext()

We need to pass information from this action call to the one where the form is submitted, so that we know which 'simple' blueprint module is being used and which index page should be created, etc. Ideally we'd have some sort of flash-storage to pass this info without a metadata-JS-hidden-field browser round trip.

storeBlueprintPageIndicatorInEditorContext

public void storeBlueprintPageIndicatorInEditorContext()

sendBlueprintPageCreateEvent

protected void sendBlueprintPageCreateEvent(com.atlassian.confluence.pages.Page page)

setContextJson

public void setContextJson(String contextJson)

setContext

protected void setContext(Map<String,Object> context)

setContentBlueprintId

public void setContentBlueprintId(String id)

setSpaceKey

public void setSpaceKey(String spaceKey)

Permissions checking is currently done against the space associated with "newSpaceKey" (as opposed to "spaceKey"). To avoid passing the newSpaceKey as a request parameter, we override setSpaceKey to also set the newSpaceKey.

Failing to do this will lead to strange permission issues.

Overrides:

setSpaceKey in class com.atlassian.confluence.pages.actions.AbstractCreatePageAction

setContentTemplateRefId

public void setContentTemplateRefId(String contentTemplateRefId)

Allows create POSTs to override the plugin descriptor's defined template key.

setContentTemplateKey

@Deprecated
public void setContentTemplateKey(String contentTemplateKey)

Deprecated.

getFormaction

public String getFormaction()

setContextPathHolder

public void setContextPathHolder(com.atlassian.confluence.core.ContextPathHolder contextPathHolder)

setBlueprintManager

public void setBlueprintManager(BlueprintManager blueprintManager)

setContentGenerator

public void setContentGenerator(BlueprintContentGenerator contentGenerator)

setEditorFormatService

public void setEditorFormatService(com.atlassian.confluence.xhtml.api.EditorFormatService editorFormatService)

setConfluenceWebResourceManager

public void setConfluenceWebResourceManager(com.atlassian.confluence.plugin.webresource.ConfluenceWebResourceManager confluenceWebResourceManager)

setContentBlueprintManager

public void setContentBlueprintManager(ContentBlueprintManager contentBlueprintManager)

getPageManager

protected com.atlassian.confluence.pages.PageManager getPageManager()

getGoToIndexPage

public boolean getGoToIndexPage()

setGoToIndexPage

public void setGoToIndexPage(boolean goToIndexPage)