Package com.atlassian.confluence.pages.actions

Class PageNotPermittedAction

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.PageNotPermittedAction
All Implemented Interfaces:
PageAware, WebInterface, 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
public class PageNotPermittedAction extends ConfluenceActionSupport implements PageAware
See Also:

  • Constructor Details

    • PageNotPermittedAction

      public PageNotPermittedAction()

  • Method Details

    • execute

      @XsrfProtectionExcluded public String execute()
      Specified by:
      execute in interface org.apache.struts2.action.Action
      Overrides:
      execute in class org.apache.struts2.ActionSupport

    • getNoPageEditPermissionRedirectUrl

      public String getNoPageEditPermissionRedirectUrl()

    • getNoSpaceEditPermissionRedirectUrl

      public String getNoSpaceEditPermissionRedirectUrl()

    • getPageId

      public long getPageId()

    • getDraftId

      public long getDraftId()

    • setPageId

      public void setPageId(long pageId)

    • setDraftId

      public void setDraftId(long draftId)

    • getPage

      public AbstractPage getPage()
      Specified by:
      getPage in interface PageAware
      Returns:
      page the page that the action worked on

    • 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

    • isPermittedToViewCurrentPage

      @Deprecated public boolean isPermittedToViewCurrentPage()
      Deprecated.
      since 6.2.0
      Returns:
      true if the content permissions that are set on the current page allow the logged in user to view the page. This also returns true if there are no view content permissions set on the page.

    • canUserRequestAccessOnCurrentPage

      public boolean canUserRequestAccessOnCurrentPage()

    • getRequestAccessType

      @Deprecated(forRemoval=true) public String getRequestAccessType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.4, no replacement.
      See Also:
      • RestrictedPageContextProvider

    • getLoginUrl

      public String getLoginUrl()

    • isRequestAccessPluginEnabled

      public boolean isRequestAccessPluginEnabled()
      Returns:
      true if the confluence-request-access-plugin is enabled

    • getPageManager

      public PageManager getPageManager()

    • setPageManager

      public void setPageManager(PageManager pageManager)

    • getSpaceKey

      public String getSpaceKey()

    • setSpaceKey

      public void setSpaceKey(String spaceKey)

    • getTitle

      public String getTitle()

    • setTitle

      public void setTitle(String pageTitle)

    • getTargetUrlPath

      public String getTargetUrlPath()

    • setContentPermissionManager

      public void setContentPermissionManager(ContentPermissionManager contentPermissionManager)
      Since:
      9.3