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:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.opensymphony.xwork2.interceptor.ValidationAware
com.opensymphony.xwork2.interceptor.ValidationAware.LegacyAdapter
-
Field Summary
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 -
Method Summary
Modifier and TypeMethodDescriptionexecute()
getBean()
protected AddLabelsCommand
Used so that the links are correctly built when JS is disabledgetSpace()
boolean
Consulted byPermissionCheckInterceptor
.boolean
If the action requires that the space be set before being run, then it should return true to this method.boolean
void
setEntityId
(long entityId) void
setLabelsService
(LabelsService labelsService) void
IOC method for setting the space on the action.Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, getActionErrors, getActionMessages, getActionName, getAuthenticatedUser, getBootstrapStatusProvider, getCancelResult, getCurrentRequest, getCurrentResponse, 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, setSkipIsPermitted, setSpacePermissionManager, setStrutsHelper, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, shouldSkipIsPermitted
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, 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 org.apache.struts2.interceptor.ValidationAware
addActionError, addActionMessage, addFieldError, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors
-
Constructor Details
-
AddSpaceToFavouriteAjaxAction
public AddSpaceToFavouriteAjaxAction()
-
-
Method Details
-
getBean
-
execute
- Specified by:
execute
in interfaceorg.apache.struts2.action.Action
- Overrides:
execute
in classorg.apache.struts2.ActionSupport
-
isPermitted
public boolean isPermitted()Description copied from class:ConfluenceActionSupport
Consulted byPermissionCheckInterceptor
.- Overrides:
isPermitted
in classConfluenceActionSupport
-
getEntity
Used so that the links are correctly built when JS is disabled- Returns:
- The entity the label is added to
-
getCommand
-
setEntityId
public void setEntityId(long entityId) -
setSpace
Description copied from interface:SpaceAware
IOC method for setting the space on the action. This is called from the interceptor- Specified by:
setSpace
in interfaceSpaceAware
- 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 interfaceSpaceAware
- Returns:
- true if the action requires a space in order to execute
-
isViewPermissionRequired
public boolean isViewPermissionRequired()- Specified by:
isViewPermissionRequired
in interfaceSpaceAware
- Returns:
- true if the action requires view space permission
-
getSpace
-
setLabelsService
-