com.atlassian.confluence.pages.actions
Class AbstractPageAwareAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.atlassian.confluence.core.ConfluenceActionSupport
          extended by com.atlassian.confluence.pages.actions.AbstractPageAwareAction
All Implemented Interfaces:
PageAware, WebInterface, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, java.io.Serializable
Direct Known Subclasses:
AbstractDiffPagesAction, AbstractPageAction, AbstractRemoveAttachmentAction, AlterPageNotificationAction, AttachmentSearchAction, ChildrenAction, DownloadAllAttachmentsOnPageAction, GetPagePermissionsAction, HandleNameConflictsAction, MoveAttachmentAction, MovePageDialogAction, RemoveCommentAction, RemovePageAction, RemovePagePermissionAction, ReorderPageDialogAction, SetPagePermissionsAction, ViewDiffOfDraftAction, ViewPreviousVersionsAction, ViewSourceAction, ViewStorageFormatAction

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
protected  ContentPermissionManager contentPermissionManager
           
protected  SpaceManager 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, PREVIEW, 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
AbstractPageAwareAction()
           
 
Method Summary
 FriendlyDateFormatterHelper getFriendlyDateFormatterHelper()
           
 AbstractPage getPage()
           
 long getPageId()
           
 Space getSpace()
           
 java.lang.String getSpaceKey()
           
 java.lang.String getTitle()
           
protected  boolean hasViewPagePermission()
          Deprecated. since 4.0 because this method doesn't check permissions properly, use PermissionManager.hasPermission(com.atlassian.user.User, com.atlassian.confluence.security.Permission, java.lang.Object) instead.
 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()
           
 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, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setApiDateFormatService, 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, validate
 
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.validation.MessageHolderAware
validate
 

Field Detail

spaceManager

protected SpaceManager spaceManager

contentPermissionManager

protected ContentPermissionManager contentPermissionManager
Constructor Detail

AbstractPageAwareAction

public AbstractPageAwareAction()
Method Detail

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 java.lang.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()
Overrides:
isPermitted in class ConfluenceActionSupport

getSpace

public Space getSpace()

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

hasViewPagePermission

@Deprecated
protected boolean hasViewPagePermission()
Deprecated. since 4.0 because this method doesn't check permissions properly, use PermissionManager.hasPermission(com.atlassian.user.User, com.atlassian.confluence.security.Permission, java.lang.Object) instead.


setContentPermissionManager

public void setContentPermissionManager(ContentPermissionManager contentPermissionManager)

getSpaceKey

public java.lang.String getSpaceKey()

getFriendlyDateFormatterHelper

public FriendlyDateFormatterHelper getFriendlyDateFormatterHelper()


Copyright © 2003-2014 Atlassian. All Rights Reserved.