Package com.atlassian.confluence.pages.actions

Class ViewPageAction

java.lang.Object
org.apache.struts2.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.ViewPageAction
All Implemented Interfaces:
Evented<ConfluenceEvent>, CommentAware, PageAware, TinyUrlAware, 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:
PageInfoAction
public class ViewPageAction extends AbstractPageAction implements CommentAware, Evented<ConfluenceEvent>
See Also:

  • Field Details

  • Constructor Details

    • ViewPageAction

      public ViewPageAction()

  • Method Details

    • getComment

      @Deprecated(since="8.8.0", forRemoval=true) public Comment getComment()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 8.8.0. Hibernate objects are not supported in Struts anymore. Use action's direct method calls.
      Gets the currently focused comment. Might be the comment from a permalink, a comment being replied to, or a comment being edited. Returns null if no comment is active.
      Specified by:
      getComment in interface CommentAware
      Returns:
      the comment which is focused

    • getCommentId

      public long getCommentId()

    • setComment

      public void setComment(Comment comment)
      Sets the currently focused comment. Might be the comment from a permalink, a comment being replied to, or a comment being edited. Set to null if no comment is active.

      Used by the CommentAwareInterceptor.

      Specified by:
      setComment in interface CommentAware
      Parameters:
      comment - the comment which is to be focused

    • getParentPage

      @Deprecated(since="8.8.0", forRemoval=true) public Page getParentPage()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 8.8.0. Hibernate objects are not supported in Struts anymore. Use action's direct method calls.
      Returns the parent Page of the current Page or null if the current AbstractPage is a root page or a blogpost.

    • getExternalReferences

      public List getExternalReferences()

    • 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

    • 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
      Overrides:
      isLatestVersionRequired in class AbstractPageAwareAction
      Returns:
      true if the action requires the most recent version of a page

    • isViewPermissionRequired

      public boolean isViewPermissionRequired()
      Specified by:
      isViewPermissionRequired in interface PageAware
      Overrides:
      isViewPermissionRequired in class AbstractPageAwareAction
      Returns:
      true if the action requires a check on the view page level permissions on this page

    • getEditingUser

      @Internal public String getEditingUser()

    • execute

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

    • pageIsLatestVersionAndDoesNotHaveSpace

      protected boolean pageIsLatestVersionAndDoesNotHaveSpace()

    • getEventToPublish

      public ConfluenceEvent getEventToPublish(String result)
      Description copied from interface: Evented
      Gets the event to publish.
      Specified by:
      getEventToPublish in interface Evented<ConfluenceEvent>
      Parameters:
      result - the result of the action executing.
      Returns:
      the event. Can be null, in which case no event will be published.

    • getPageXHtmlContent

      public String getPageXHtmlContent()

    • getXHtmlComments

      public Map<Comment,String> getXHtmlComments()

    • getChildrenShowing

      public Boolean getChildrenShowing()

    • setShowChildren

      public void setShowChildren(Boolean showChildren)

    • getNotificationManager

      public NotificationManager getNotificationManager()

    • setNotificationManager

      public void setNotificationManager(NotificationManager notificationManager)

    • isThreadComments

      public boolean isThreadComments()

    • isUserWatchingPage

      public boolean isUserWatchingPage()
      Returns true if the user is watching the current page. Returns false otherwise, or if the user is anonymous.

    • isUserWatchingSpace

      public boolean isUserWatchingSpace()
      Returns true if the user is watching the page/blog's space for the respective ContentType. For example, if getPage returns a BlogPost and the user is only watching Pages in the Space, this method returns false.

    • getDateString

      public String getDateString(Date date)

    • renderExternalLink

      public String renderExternalLink(com.atlassian.renderer.links.Link link)

    • getReplyToComment

      public long getReplyToComment()

    • setReplyToComment

      public void setReplyToComment(long replyToComment)

    • getInheritedContentPermissions

      public List<ContentPermission> getInheritedContentPermissions()

    • getThisPagePermissions

      public List<ContentPermission> getThisPagePermissions()

    • getPageIdOfVersionBefore

      public long getPageIdOfVersionBefore(AbstractPage page)

    • getPageIdOfVersionAfter

      public long getPageIdOfVersionAfter(AbstractPage page)

    • hasPreviousVersion

      public boolean hasPreviousVersion(AbstractPage page)

    • hasNextVersion

      public boolean hasNextVersion(AbstractPage page)

    • isShowCommentArea

      public boolean isShowCommentArea()

    • setShowCommentArea

      public void setShowCommentArea(boolean showCommentArea)

    • isEditComment

      public boolean isEditComment()

    • setEditComment

      public void setEditComment(boolean editComment)

    • isNavigatingVersions

      public boolean isNavigatingVersions()

    • setNavigatingVersions

      public void setNavigatingVersions(boolean navigatingVersions)

    • setCommentManager

      public void setCommentManager(CommentManager commentManager)

    • getCommentAsXHtmlForWysiwyg

      public String getCommentAsXHtmlForWysiwyg()

    • getWebInterfaceContext

      public WebInterfaceContext getWebInterfaceContext()
      Description copied from interface: WebInterface
      Returns 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:
      getWebInterfaceContext in interface WebInterface
      Overrides:
      getWebInterfaceContext in class AbstractPageAction

    • getWebInterfaceContext

      public WebInterfaceContext getWebInterfaceContext(Comment comment)

    • isPermitted

      public boolean isPermitted()
      Description copied from class: ConfluenceActionSupport
      Consulted by PermissionCheckInterceptor.
      Overrides:
      isPermitted in class AbstractPageAwareAction

    • getViewInheritedContentPermissionSets

      public List getViewInheritedContentPermissionSets()

    • hasAnyPermissions

      public boolean hasAnyPermissions()
      checks if the page has any direct contentpermissions or inherited ones

    • setEditRenderer

      public void setEditRenderer(Renderer editRenderer)

    • setXhtmlContent

      public void setXhtmlContent(XhtmlContent xhtmlContent)

    • setThemeManager

      public void setThemeManager(ThemeManager themeManager)

    • isChildrenNotShown

      public boolean isChildrenNotShown()
      Used to hide the page children if we are using the left sidebar. It's necessary to do it like this because a theme may not override page.vmd.
      Returns:
      true if children are not shown, and false if it's the opposite.

    • setCollaborativeEditingHelper

      @ExperimentalApi public void setCollaborativeEditingHelper(CollaborativeEditingHelper collaborativeEditingHelper)

    • getCollaborativeEditingHelper

      @ExperimentalApi public CollaborativeEditingHelper getCollaborativeEditingHelper()

    • setDarkFeaturesManager

      public void setDarkFeaturesManager(DarkFeaturesManager darkFeaturesManager)

    • setEstimatedReadTimeService

      public void setEstimatedReadTimeService(EstimatedReadTimeService estimatedReadTimeService)

    • getReadTime

      public int getReadTime()

    • getForwardLocation

      public String getForwardLocation()

    • getRedirectLocation

      public String getRedirectLocation()

    • setViewPageActionPathConverter

      public void setViewPageActionPathConverter(ViewPageActionPathConverter viewPageActionPathConverter)