Class PageVariablesAction
java.lang.Object
org.apache.struts2.ActionSupport
com.opensymphony.xwork2.ActionSupport
com.atlassian.confluence.core.AbstractI18nActionSupport
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.pages.actions.PageVariablesAction
- All Implemented Interfaces:
Beanable,PageAware,TinyUrlAware,WebInterface,CaptchaAware,Spaced,BreadcrumbAware,MessageHolderAware,com.opensymphony.xwork2.Action,com.opensymphony.xwork2.interceptor.ValidationAware,com.opensymphony.xwork2.LocaleProvider,com.opensymphony.xwork2.TextProvider,com.opensymphony.xwork2.Validateable,Serializable,org.apache.struts2.action.Action,org.apache.struts2.interceptor.ValidationAware,org.apache.struts2.Validateable
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.atlassian.confluence.pages.actions.CreatePageAction
CreatePageAction.SimplePageProviderNested classes/interfaces inherited from interface com.opensymphony.xwork2.interceptor.ValidationAware
com.opensymphony.xwork2.interceptor.ValidationAware.LegacyAdapter -
Field Summary
FieldsFields inherited from class com.atlassian.confluence.pages.actions.CreatePageAction
pageProviderFields inherited from class com.atlassian.confluence.pages.actions.AbstractCreatePageAction
attachmentManager, breadcrumbGenerator, contextProvider, INPUT_VARIABLES, originalReferrer, space, themeManagerFields inherited from class com.atlassian.confluence.pages.actions.AbstractCreateAndEditPageAction
ACTIVITY_UNAVAILABLE, captchaManager, collaborativeEditingHelper, draftManager, draftService, draftsTransitionHelper, heartbeatManager, LOCKED, movePageCommandHelper, newSpaceKey, notificationManager, pageService, parentPage, parentPageId, parentPageSpaceKey, parentPageString, parentPageTitle, targetId, USER_LIMIT_REACHEDFields inherited from class com.atlassian.confluence.pages.actions.AbstractTemplatePageAction
pageTemplateManager, templateIdFields inherited from class com.atlassian.confluence.pages.actions.AbstractPreviewPageAction
back, bean, formatConverter, inPreview, preview, storageFormat, wikiStyleRenderer, wysiwygContentFields inherited from class com.atlassian.confluence.pages.actions.AbstractPageAction
incomingLinks, linkManager, pageManager, PREVIEW, RICHTEXT, viewRenderer, wysiwygConverterFields inherited from class com.atlassian.confluence.pages.actions.AbstractPageAwareAction
contentPermissionManager, spaceManagerFields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
accessModeService, CANCEL, confluenceAccessManager, contentUiSupport, eventPublisher, formatSettingsManager, globalSettingsManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, localeManager, loginManager, messageHolder, permissionManager, pluginAccessor, request, response, spacePermissionManager, strutsHelper, systemInformationService, userAccessor, webInterfaceManagerFields inherited from class org.apache.struts2.ActionSupport
containerFields inherited from interface org.apache.struts2.action.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondoEnter()execute()Metadata is now retrieved from the existing page, if it exists, otherwise it is stored on the draft (i.e.get rendered template content 1) manually injected script in renderedTemplateContent will be removed to avoid XSS 2) script from html macro will be parsed according to the specified template ID and will be added to renderedTemplateContentReturns a context which can be passed to web items when rendering them.booleanThis action is being used to set up the content for the CreatePageAction, so the permissions test is not needed (and doesn't work, as the final space the page will be created in hasn't been chosen yet)booleanvoidsetEditorFormatService(EditorFormatService editorFormatService) Deprecated.since 5.10.voidsetFormatConverter(FormatConverter formatConverter) voidsetRenderedContentCleaner(RenderedContentCleaner renderedContentCleaner) voidsetRenderedTemplateContent(String renderedTemplateContent) voidsetTemplateApplied(boolean templateApplied) voidsetXhtmlContent(XhtmlContent xhtmlContent) voidvalidate()Convert the editor content to storageFormat, catching and reporting any problems in the process.Methods inherited from class com.atlassian.confluence.pages.actions.CreatePageAction
assignParentPage, assignSpace, createCommand, createDraft, createPage, doDefault, doTemplateDefault, getCommandActionHelper, getCreatedAbstractPage, getInheritedViewPermissions, getLinkCreation, getPageToCreate, initialiseProvider, populateParentPageTitleField, setEncodedTitle, setLinkCreationMethods 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, isPageRequired, populateContextProvider, setAttachmentManager, setBreadcrumbGenerator, setFromPage, setFromPageId, setOriginalReferrer, setQueryString, setSpaceKey, setThemeManager, setTitleWritten, transferDraftAttachmentsMethods inherited from class com.atlassian.confluence.pages.actions.AbstractCreateAndEditPageAction
getCaptchaManager, getCollaborativeEditingHelper, getConfluenceRevision, getContentDraft, getContentObject, getCurrentEditPermission, getCurrentViewPermission, getDraft, getDraftAsCEO, getDraftId, getDraftShareId, getEntityId, getExistingDraft, getExistingDraftId, getLabelsString, getMovePageCommand, getNewSpaceKey, getNotificationManager, getParentPage, getParentPageId, getParentPageSpaceKey, getParentPageString, getParentPageTitle, getPermissionTypes, getPosition, getSynchronyRevisionSource, getSyncRev, getTargetId, getTitle, getViewInheritedContentPermissionSets, getXsrfToken, hasDraftPermission, isCollaborativeContent, isNewAbstractPage, isRestricted, isShowDraftMessage, isUseDraft, setCaptchaManager, setCollaborativeEditingHelper, setDraftId, setDraftManager, setDraftService, setDraftShareId, setDraftsTransitionHelper, setHeartbeatManager, setLabelsString, setLabelsString, setMovePageCommandHelper, setNewSpaceKey, setNotificationManager, setPageService, setParentPageId, setParentPageSpaceKey, setParentPageString, setParentPageTitle, setPermissions, setPosition, setShowDraftMessage, setSpaceService, setSyncRev, setTargetId, setTitle, setUseDraft, setXsrfTokenGenerator, setXsrfTokenGenerator, startHeartbeatOnDoDefault, validateDuplicatePageTitleMethods inherited from class com.atlassian.confluence.pages.actions.AbstractTemplatePageAction
getGlobalPageTemplates, getPageTemplate, getSpacePageTemplates, getTemplateId, isPageTemplatesAvailable, loadTemplates, setPageTemplateManager, setTemplateIdMethods inherited from class com.atlassian.confluence.pages.actions.AbstractPreviewPageAction
getBean, getContentForSaving, getConversionContext, getEditorFormattedContent, getInPreview, getRenderContext, getStorageFormat, getWysiwygContent, getxHtmlContent, setBack, setInPreview, setPreview, setWikiStyleRenderer, setWysiwygContent, updateXHtmlContentMethods inherited from class com.atlassian.confluence.pages.actions.AbstractPageAction
displayDatePath, getAvailableSpaces, getBeanKey, getBlogPost, getEditorVersion, getHelper, getIncomingLinks, getMode, getNextPost, getNumberOfAttachmentsAsString, getNumberOfLabelsAsString, getPermittedChildren, getPostingDateAsDate, getPostingDay, getPostingTimeAsTime, getPreviousPost, getPreviousVersion, getSpaceManager, getSuggestedLabels, getTinyUrl, hasAttachFilePermissions, hasPermittedChildren, isSpaceAdmin, isSuperUser, isUserWatchingOwnContent, setConfluenceWysiwygConverter, setEditorManager, setLinkManager, setMode, setPageManager, setPostingDate, setPostingTime, setViewRendererMethods inherited from class com.atlassian.confluence.pages.actions.AbstractPageAwareAction
getCustomPageUrl, getPage, getPageId, getPageUrl, isLatestVersionRequired, isViewPermissionRequired, setContentPermissionManager, setPage, setSpaceManagerMethods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, getActionErrors, getActionMessages, getActionName, getAuthenticatedUser, getBootstrapStatusProvider, getCurrentRequest, getCurrentResponse, getDateFormatter, getDefaultTimeZone, getFieldErrors, getGlobalSettings, getI18n, getLocale, getMessageHolder, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getTimeZone, getUserByName, getUserInterfaceState, isAnonymousUser, isEmailVisible, setAccessModeService, setBootstrapStatusProvider, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventPublisher, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSkipIsPermitted, setSpacePermissionManager, setStrutsHelper, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, shouldSkipIsPermittedMethods inherited from class com.atlassian.confluence.core.AbstractI18nActionSupport
getText, getText, getText, getText, getText, getText, getText, getText, getTextStrictMethods inherited from class org.apache.struts2.ActionSupport
addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getContainer, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocaleMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.atlassian.confluence.security.CaptchaAware
mustValidateCaptchaMethods inherited from interface com.atlassian.confluence.pages.actions.PageAware
isEditPermissionRequiredMethods inherited from interface org.apache.struts2.interceptor.ValidationAware
addActionError, addActionMessage, addFieldError, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors
-
Field Details
-
HTML_MACRO_XHTML_MODULE_KEY
- See Also:
-
-
Constructor Details
-
PageVariablesAction
public PageVariablesAction()
-
-
Method Details
-
getTemplateVariables
- Throws:
XhtmlException
-
execute
- Specified by:
executein interfaceorg.apache.struts2.action.Action- Overrides:
executein classorg.apache.struts2.ActionSupport- Throws:
Exception
-
getLabels
Description copied from class:AbstractCreateAndEditPageActionMetadata is now retrieved from the existing page, if it exists, otherwise it is stored on the draft (i.e. if the draft has never been published)- Overrides:
getLabelsin classAbstractCreateAndEditPageAction- Returns:
- List of labels visible to the current user
-
getWebInterfaceContext
Description copied from interface:WebInterfaceReturns a context which can be passed to web items when rendering them.Typically, Struts actions will implement this to provide extra details in the context such as content objects, and so on.
- Specified by:
getWebInterfaceContextin interfaceWebInterface- Overrides:
getWebInterfaceContextin classAbstractCreateAndEditPageAction
-
getRenderedTemplateContent
get rendered template content 1) manually injected script in renderedTemplateContent will be removed to avoid XSS 2) script from html macro will be parsed according to the specified template ID and will be added to renderedTemplateContent -
setRenderedTemplateContent
-
doEnter
- Throws:
Exception
-
validate
public void validate()Description copied from class:AbstractPreviewPageActionConvert the editor content to storageFormat, catching and reporting any problems in the process. On successful validation, the storageFormat field will be populated with a storage format representation of the editor content, ready for saving.- Specified by:
validatein interfaceMessageHolderAware- Specified by:
validatein interfaceorg.apache.struts2.Validateable- Overrides:
validatein classCreatePageAction
-
isPermitted
public boolean isPermitted()This action is being used to set up the content for the CreatePageAction, so the permissions test is not needed (and doesn't work, as the final space the page will be created in hasn't been chosen yet)- Overrides:
isPermittedin classCreatePageAction
-
isTemplateApplied
public boolean isTemplateApplied() -
setTemplateApplied
public void setTemplateApplied(boolean templateApplied) -
setEditorFormatService
Deprecated.since 5.10. Unused. -
setXhtmlContent
-
setFormatConverter
- Overrides:
setFormatConverterin classAbstractPreviewPageAction
-
setRenderedContentCleaner
-