Package com.atlassian.confluence.labels.actions

Class AddSpaceToFavouriteAjaxAction

java.lang.Object
org.apache.struts2.ActionSupport
com.opensymphony.xwork2.ActionSupport
com.atlassian.confluence.core.AbstractI18nActionSupport
com.atlassian.confluence.core.ConfluenceActionSupport
com.atlassian.confluence.labels.actions.AddSpaceToFavouriteAjaxAction
All Implemented Interfaces:
Beanable, WebInterface, SpaceAware, Spaced, 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 final class AddSpaceToFavouriteAjaxAction extends ConfluenceActionSupport implements Beanable, SpaceAware
Makes a page or blogpost the favourite of the specified user. Used for JSON requests, a list of the labels added are available under the 'labels' key of the bean.
See Also:

  • Constructor Details

    • AddSpaceToFavouriteAjaxAction

      public AddSpaceToFavouriteAjaxAction()

  • Method Details

    • getBean

      public Map<String,Collection<Label>> getBean()
      Specified by:
      getBean in interface Beanable

    • execute

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

    • isPermitted

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

    • getEntity

      public Labelable getEntity()
      Used so that the links are correctly built when JS is disabled
      Returns:
      The entity the label is added to

    • getCommand

      protected AddLabelsCommand getCommand()

    • setEntityId

      public void setEntityId(long entityId)

    • setSpace

      public void setSpace(Space space)
      Description copied from interface: SpaceAware
      IOC method for setting the space on the action. This is called from the interceptor
      Specified by:
      setSpace in interface SpaceAware
      Parameters:
      space - the space that the action will be working on.

    • isSpaceRequired

      public boolean isSpaceRequired()
      Description copied from interface: SpaceAware
      If the action requires that the space be set before being run, then it should return true to this method. If the action requires a space, but no space is available, then the interceptor will automatically redirect to the 'pagenotfound' result
      Specified by:
      isSpaceRequired in interface SpaceAware
      Returns:
      true if the action requires a space in order to execute

    • isViewPermissionRequired

      public boolean isViewPermissionRequired()
      Specified by:
      isViewPermissionRequired in interface SpaceAware
      Returns:
      true if the action requires view space permission

    • getSpace

      public Space getSpace()
      Specified by:
      getSpace in interface Spaced

    • setLabelsService

      public void setLabelsService(LabelsService labelsService)