Package com.atlassian.confluence.pages.actions

Class AbstractPageAwareAction

java.lang.Object

org.apache.struts2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.pages.actions.AbstractPageAwareAction

All Implemented Interfaces:

PageAware, WebInterface, MessageHolderAware, Serializable, org.apache.struts2.action.Action, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.locale.LocaleProvider, org.apache.struts2.text.TextProvider, org.apache.struts2.Validateable

Direct Known Subclasses:

AbstractDiffPagesAction, AbstractPageAction, AbstractRemoveAttachmentAction, AttachmentSearchAction, ChildrenAction, DownloadAllAttachmentsOnPageAction, GetPagePermissionsAction, ManageWatchersAction, MoveAttachmentAction, MovePageDialogAction, RemoveCommentAction, RemovePageAction, RemovePagePermissionAction, ReorderPageDialogAction, SetPagePermissionsAction, ViewDiffOfDraftAction, ViewPreviousVersionsAction

public abstract class AbstractPageAwareAction
extends ConfluenceActionSupport
implements PageAware

Parent class for actions which operate on AbstractPages (pages or blog posts).

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentPermissionManager	contentPermissionManager
protected SpaceManager	spaceManager

Fields 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, PREVIEW, request, response, spacePermissionManager, strutsHelper, systemInformationService, userAccessor, webInterfaceManager

Fields inherited from class org.apache.struts2.ActionSupport

container

Fields inherited from interface org.apache.struts2.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
AbstractPageAwareAction()

Method Summary

Modifier and Type	Method	Description
String	getCustomPageUrl()
AbstractPage	getPage()
long	getPageId()
String	getPageUrl()
Space	getSpace()
String	getSpaceKey()
String	getTitle()
boolean	isCollaborativeContent()
boolean	isLatestVersionRequired()	If the action can only work on the most recent version of a page, this will cause the interceptor to silently replace the version that it looks up with the most recent version, if necessary.
boolean	isPageRequired()	If the action requires that the page be set before being run, then it should return true to this method.
boolean	isPermitted()	Consulted by PermissionCheckInterceptor.
boolean	isViewPermissionRequired()
void	setContentPermissionManager(ContentPermissionManager contentPermissionManager)
void	setPage(AbstractPage page)	IOC method for setting the page on the action.
void	setSpaceManager(SpaceManager spaceManager)

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, getActionErrors, getActionMessages, getActionName, getActiveRequest, getActiveResponse, getAuthenticatedUser, getBootstrapStatusProvider, getCancelResult, getDateFormatter, getDefaultTimeZone, getFieldErrors, getGlobalSettings, getHelper, getI18n, getLocale, getMessageHolder, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getTimeZone, getUserByName, getUserInterfaceState, getWebInterfaceContext, isAnonymousUser, isEmailVisible, setAccessModeService, setBootstrapStatusProvider, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventPublisher, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setStrutsHelper, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager

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

getText, getText, getText, getText, getText, getText, getText, getText, getTextStrict

Methods inherited from class org.apache.struts2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, execute, getContainer, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocale, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware

validate

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

isEditPermissionRequired

Field Details

spaceManager

protected SpaceManager spaceManager

contentPermissionManager

protected ContentPermissionManager contentPermissionManager

Constructor Details

AbstractPageAwareAction

public AbstractPageAwareAction()

Method Details

getPage

public AbstractPage getPage()

Specified by:

getPage in interface PageAware

Returns:

page the page that the action worked on

getPageId

public long getPageId()

getTitle

public String getTitle()

setPage

public void setPage(AbstractPage page)

Description copied from interface: PageAware

IOC method for setting the page on the action. This is called from the interceptor

Specified by:

setPage in interface PageAware

Parameters:

page - the page that the action will be working on.

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

Returns:

true if the action requires a page in order to execute

isLatestVersionRequired

public boolean isLatestVersionRequired()

Description copied from interface: PageAware

If the action can only work on the most recent version of a page, this will cause the interceptor to silently replace the version that it looks up with the most recent version, if necessary.

Specified by:

isLatestVersionRequired in interface PageAware

Returns:

true if the action requires the most recent version of a page

isViewPermissionRequired

public boolean isViewPermissionRequired()

Specified by:

isViewPermissionRequired in interface PageAware

Returns:

true if the action requires a check on the view page level permissions on this page

isPermitted

public boolean isPermitted()

Description copied from class: ConfluenceActionSupport

Consulted by PermissionCheckInterceptor.

Overrides:

isPermitted in class ConfluenceActionSupport

getSpace

public Space getSpace()

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

setContentPermissionManager

public void setContentPermissionManager(ContentPermissionManager contentPermissionManager)

isCollaborativeContent

public boolean isCollaborativeContent()

getSpaceKey

public String getSpaceKey()

getPageUrl

public String getPageUrl()

getCustomPageUrl

public String getCustomPageUrl()