com.atlassian.confluence.pages.actions
Class AbstractCreatePageAction

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

All Implemented Interfaces:

PageAware, TinyUrlAware, WebInterface, CaptchaAware, Spaced, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

Direct Known Subclasses:

CreateBlogPostAction, CreatePageAction

public abstract class AbstractCreatePageAction
extends AbstractCreateAndEditPageAction
implements Spaced

Functions shared between creating pages and blog posts.

See Also:

Serialized Form

Field Summary

protected AttachmentManager	attachmentManager
static String	INPUT_VARIABLES

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

captchaManager, draftManager, editPermissionsGroups, editPermissionsUsers, newSpaceKey, parentPageId, parentPageSpaceKey, parentPageString, parentPageTitle, targetId, viewPermissionsGroups, viewPermissionsUsers

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

pageTemplateManager, templateId

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

back, content, inPreview, preview, wikiStyleRenderer, wysiwygContent

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

incomingLinks, isXHtml, linkManager, MARKUP, pageManager, PREVIEW, RICHTEXT, 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, log, 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

AbstractCreatePageAction()

Method Summary

protected void	createDraftIfItDoesNotExist() creates a draft if it doesn't already exist.
void	createPage()
String	doAdd()
String	doDefault() Default webwork action execution method.
ContentEntityObject	getAttachmentSourceContent() Returns the ConfluenceEntityObject that contains attachments relevant to the current action.
String	getContentType() Returns the content type being created or edited.
Page	getFromPage()
long	getFromPageId()
Space	getNewSpace()
protected abstract AbstractPage	getPageToCreate()
AbstractPage	getPageToReturnToOnCancel()
Space	getSpace()
String	getSpaceKey()
boolean	hasSetPagePermissionsPermission()
boolean	isInvalidPageTitle()
boolean	isPageRequired() If the action requires that the page be set before being run, then it should return true to this method.
protected void	onAddComplete()
void	setAttachmentManager(AttachmentManager attachmentManager)
void	setFromPageId(long fromPageId)
void	setSpaceKey(String spaceKey)
void	setTitle(String title)
void	setTitleWritten(String titleWritten)
protected boolean	titleIsSetToDefault(String defaultTitleKey)
protected void	transferDraftAttachments()

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

createEditPermissions, createViewPermissions, getCancelResult, getCaptchaManager, getCurrentEditPermission, getCurrentViewPermission, getDraft, getDraftId, getEditPermissionsGroups, getEditPermissionsSummary, getEditPermissionsUsers, getLabelsShowing, getLabelsString, getLocationShowing, getMovePageCommand, getNewSpaceKey, getParentPage, getParentPageId, getParentPageSpaceKey, getParentPageString, getParentPageTitle, getPermissionTypes, getPosition, getRestrictionsShowing, getTargetId, getTitle, getViewInheritedContentPermissionSets, getViewPermissionsGroups, getViewPermissionsSummary, getViewPermissionsUsers, isShowDraftMessage, isUseDraft, setCaptchaManager, setContentChanged, setDiscardDraft, setDraftId, setDraftManager, setEditPermissionsGroups, setEditPermissionsUsers, setLabelsShowing, setLabelsString, setLocationShowing, setNewSpaceKey, setPageService, setParentPageId, setParentPageSpaceKey, setParentPageString, setParentPageTitle, setPermissions, setPosition, setRestrictionsShowing, setShowDraftMessage, setSpaceService, setTargetId, setUseDraft, setViewPermissionsGroups, setViewPermissionsUsers, validate, validateDuplicatePageTitle

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

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

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

getContent, getInPreview, getPageOrDummyPage, getWysiwygContent, getxHtmlContent, setBack, setContent, setInPreview, setPreview, setWikiStyleRenderer, setWysiwygcontent, updateXHtmlContent

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

displayDatePath, getAvailableSpaces, getBeanKey, getBlogPost, getEditor, getEditorVersion, getHelper, getIncomingLinks, getMARKUP, getMode, getNextPost, getPermittedChildren, getPostingDate, getPostingDay, getPostingDayOfMonth, getPostingMonth, getPostingMonthNumeric, getPostingYear, getPREVIEW, getPreviousPost, getPreviousVersion, getRICHTEXT, getShowMarkup, getSpaceManager, getSuggestedLabels, getSupportWysiwyg, getTinyUrl, getUseWysiwyg, getWebInterfaceContext, getXhtml, hasAttachFilePermissions, hasPermittedChildren, isSpaceAdmin, isSuperUser, setConfluenceWysiwygConverter, setEditorManager, setLinkManager, setMode, setPageManager, setPostingDate, setXhtml

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

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

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

addActionError, addFieldError, addPermissionTypeTo, addToHistory, formatFriendlyDate, getActionName, getActionName, getBootstrapManager, getContext, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getNiceContentType, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setBootstrapManager, setCancel, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setSystemInformationService, 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

Field Detail

INPUT_VARIABLES

public static final String INPUT_VARIABLES

See Also:

Constant Field Values

attachmentManager

protected AttachmentManager attachmentManager

Constructor Detail

AbstractCreatePageAction

public AbstractCreatePageAction()

Method Detail

setSpaceKey

public void setSpaceKey(String spaceKey)

getSpaceKey

public String getSpaceKey()

Overrides:

getSpaceKey in class AbstractPageAwareAction

getSpace

public Space getSpace()

Specified by:

getSpace in interface Spaced

Overrides:

getSpace in class AbstractPageAwareAction

getNewSpace

public Space getNewSpace()

Returns:

the space referenced by the newSpaceKey property, or null if there is none or it cannot be found.

doDefault

public String doDefault()
                 throws Exception

Description copied from class: ConfluenceActionSupport

Default webwork action execution method.

Overrides:

doDefault in class AbstractCreateAndEditPageAction

Returns:

the action result

Throws:

Exception - if something goes wrong

createDraftIfItDoesNotExist

protected void createDraftIfItDoesNotExist()

creates a draft if it doesn't already exist. The purpose is to ensure we have a draft available when we create any new content

setTitle

public void setTitle(String title)

Overrides:

setTitle in class AbstractCreateAndEditPageAction

doAdd

public String doAdd()
             throws Exception

Throws:

Exception

onAddComplete

protected void onAddComplete()

transferDraftAttachments

protected void transferDraftAttachments()

createPage

public void createPage()
                throws IOException

Throws:

IOException

getPageToCreate

protected abstract AbstractPage getPageToCreate()

isInvalidPageTitle

public boolean isInvalidPageTitle()

isPageRequired

public boolean isPageRequired()

Description copied from interface: PageAware

If the action requires that the page be set before being run, then it should return true to this method. If the action requires a page, but no page is available, then the interceptor will automatically redirect to the 'pagenotfound' result

Specified by:

isPageRequired in interface PageAware

Overrides:

isPageRequired in class AbstractPageAwareAction

Returns:

true if the action requires a page in order to execute

setFromPageId

public void setFromPageId(long fromPageId)

getFromPageId

public long getFromPageId()

getFromPage

public Page getFromPage()

getAttachmentSourceContent

public ContentEntityObject getAttachmentSourceContent()

Description copied from class: AbstractPageAction

Returns the ConfluenceEntityObject that contains attachments relevant to the current action. E.g.:

• The AbstractPage being viewed or edited.
• The Draft of the AbstractPage being created
• The AbstractPage to which the Comment being created/edited belongs

Overrides:

getAttachmentSourceContent in class AbstractPageAction

getPageToReturnToOnCancel

public AbstractPage getPageToReturnToOnCancel()

getContentType

public String getContentType()

Description copied from class: AbstractCreateAndEditPageAction

Returns the content type being created or edited. e.g. "page", "blogpost"

Specified by:

getContentType in class AbstractCreateAndEditPageAction

titleIsSetToDefault

protected boolean titleIsSetToDefault(String defaultTitleKey)

hasSetPagePermissionsPermission

public boolean hasSetPagePermissionsPermission()

Overrides:

hasSetPagePermissionsPermission in class AbstractCreateAndEditPageAction

setTitleWritten

public void setTitleWritten(String titleWritten)

setAttachmentManager

public void setAttachmentManager(AttachmentManager attachmentManager)