com.atlassian.confluence.pages.actions
Class AbstractCreatePageAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.atlassian.confluence.core.ConfluenceActionSupport
          extended by com.atlassian.confluence.pages.actions.AbstractPageAwareAction
              extended by com.atlassian.confluence.pages.actions.AbstractPageAction
                  extended by com.atlassian.confluence.pages.actions.AbstractPreviewPageAction
                      extended by com.atlassian.confluence.pages.actions.AbstractTemplatePageAction
                          extended by com.atlassian.confluence.pages.actions.AbstractCreateAndEditPageAction
                              extended by com.atlassian.confluence.pages.actions.AbstractCreatePageAction
All Implemented Interfaces:
PageAware, TinyUrlAware, WebInterface, CaptchaAware, Spaced, BreadcrumbAware, 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:
CreateBlogPostAction, CreatePageAction

public abstract class AbstractCreatePageAction
extends AbstractCreateAndEditPageAction
implements Spaced, BreadcrumbAware

Functions shared between creating pages and blog posts.

See Also:
Serialized Form

Field Summary
protected  AttachmentManager attachmentManager
           
protected  BreadcrumbGenerator breadcrumbGenerator
           
static String INPUT_VARIABLES
           
protected  Space space
           
protected  ThemeManager themeManager
           
 
Fields inherited from class com.atlassian.confluence.pages.actions.AbstractCreateAndEditPageAction
captchaManager, CLOSE_CANCEL_RESULT, DISCARD_CANCEL_RESULT, draftManager, draftService, editPermissionsGroups, editPermissionsUsers, newSpaceKey, notificationManager, pageService, 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, 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
AbstractCreatePageAction()
           
 
Method Summary
protected  String afterAdd()
          Common processing to be performed by all subclasses after the add operation.
protected  String beforeAdd()
          Common processing to be performed by all subclasses prior to performing the add.
 void createPage()
          Create the CEO to be saved from the data supplied to the action.
 String doAdd()
           
 String doDefault()
          Default webwork action execution method.
 ContentEntityObject getAttachmentSourceContent()
          Returns the ConfluenceEntityObject that contains attachments relevant to the current action.
 Breadcrumb getBreadcrumb()
          Returns the breadcrumb to be shown when the action is accessed.
 String getCancelRedirectUrl()
           
 String getCancelResult()
           
protected  Breadcrumb getContentBreadcrumb()
           
 String getContentType()
          Returns the content type being created or edited.
 Page getFromPage()
           
 long getFromPageId()
           
 Space getNewSpace()
           
protected abstract  AbstractPage getPageToCreate()
           
 Space getSpace()
           
 String getSpaceKey()
           
 boolean hasSetPagePermissionsPermission()
           
 boolean isInvalidPageTitle()
          Deprecated. since 4.1 Page title character restrictions have been removed.
 boolean isPageRequired()
          If the action requires that the page be set before being run, then it should return true to this method.
 void setAttachmentManager(AttachmentManager attachmentManager)
           
 void setBreadcrumbGenerator(BreadcrumbGenerator breadcrumbGenerator)
           
 void setFromPageId(long fromPageId)
           
 void setSpaceKey(String spaceKey)
           
 void setThemeManager(ThemeManager themeManager)
           
 void setTitle(String title)
           
 void setTitleWritten(String titleWritten)
           
protected  void transferDraftAttachments()
           
 
Methods inherited from class com.atlassian.confluence.pages.actions.AbstractCreateAndEditPageAction
createDraft, createEditPermissions, createViewPermissions, getCaptchaManager, getCurrentEditPermission, getCurrentViewPermission, getDraft, getDraftId, getEditPermissionsGroups, getEditPermissionsSummary, getEditPermissionsUsers, getEntityId, getExistingDraft, getExistingDraftId, getLabelsString, getMovePageCommand, getNewSpaceKey, getNotificationManager, getParentPage, getParentPageId, getParentPageSpaceKey, getParentPageString, getParentPageTitle, getPermissionTypes, getPosition, getTargetId, getTitle, getViewInheritedContentPermissionSets, getViewPermissionsGroups, getViewPermissionsSummary, getViewPermissionsUsers, getWebInterfaceContext, isNewAbstractPage, isRestricted, isShowDraftMessage, isUseDraft, setAutomaticWatchIfRequired, setCaptchaManager, setDraftId, setDraftManager, setDraftService, setEditPermissionsGroups, setEditPermissionsUsers, setLabelsString, setLabelsString, setNewSpaceKey, setNotificationManager, setPageService, setParentPageId, setParentPageSpaceKey, setParentPageString, setParentPageTitle, setPermissions, setPosition, setShowDraftMessage, setSpaceService, setTargetId, setUseDraft, setViewPermissionsGroups, setViewPermissionsUsers, validate, 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
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, getLabels, 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
getPage, getPageId, hasViewPagePermission, isLatestVersionRequired, isPermitted, isViewPermissionRequired, setContentPermissionManager, setPage, setSpaceManager
 
Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, formatFriendlyDate, getActionName, getActionName, getBootstrapManager, getCancel, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, 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, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, 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

space

protected Space space

attachmentManager

protected AttachmentManager attachmentManager

themeManager

protected ThemeManager themeManager

breadcrumbGenerator

protected BreadcrumbGenerator breadcrumbGenerator
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

setTitle

public void setTitle(String title)
Overrides:
setTitle in class AbstractCreateAndEditPageAction

beforeAdd

protected String beforeAdd()
                    throws Exception
Common processing to be performed by all subclasses prior to performing the add.

Returns:
Action.SUCCESS if successful. Any other return value means the add operation should not proceed.
Throws:
Exception

doAdd

public String doAdd()
             throws Exception
Throws:
Exception

afterAdd

protected String afterAdd()
Common processing to be performed by all subclasses after the add operation.

Returns:
Action.SUCCESS if successful. Any other return value means a failure.

transferDraftAttachments

protected void transferDraftAttachments()

createPage

public void createPage()
                throws XhtmlException,
                       IOException
Create the CEO to be saved from the data supplied to the action.

Throws:
IOException
XhtmlException

getPageToCreate

protected abstract AbstractPage getPageToCreate()

isInvalidPageTitle

@Deprecated
public boolean isInvalidPageTitle()
Deprecated. since 4.1 Page title character restrictions have been removed.


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.:

Overrides:
getAttachmentSourceContent in class AbstractPageAction

getCancelRedirectUrl

public String getCancelRedirectUrl()

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

hasSetPagePermissionsPermission

public boolean hasSetPagePermissionsPermission()
Overrides:
hasSetPagePermissionsPermission in class AbstractCreateAndEditPageAction

setTitleWritten

public void setTitleWritten(String titleWritten)

setAttachmentManager

public void setAttachmentManager(AttachmentManager attachmentManager)

setThemeManager

public void setThemeManager(ThemeManager themeManager)

getCancelResult

public String getCancelResult()
Overrides:
getCancelResult in class AbstractCreateAndEditPageAction

setBreadcrumbGenerator

public void setBreadcrumbGenerator(BreadcrumbGenerator breadcrumbGenerator)

getBreadcrumb

public Breadcrumb getBreadcrumb()
Description copied from interface: BreadcrumbAware
Returns the breadcrumb to be shown when the action is accessed.

Specified by:
getBreadcrumb in interface BreadcrumbAware
Returns:
Breadcrumb

getContentBreadcrumb

protected Breadcrumb getContentBreadcrumb()


Copyright © 2003-2013 Atlassian. All Rights Reserved.