Package com.atlassian.confluence.pages.actions

Class HeartbeatAction

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.HeartbeatAction

All Implemented Interfaces:

Beanable, 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 HeartbeatAction
extends ConfluenceActionSupport
implements Beanable

The HeartbeatAction provides methods used by the client side editor to detect concurrent changes to a single CEO.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.opensymphony.xwork2.interceptor.ValidationAware

com.opensymphony.xwork2.interceptor.ValidationAware.LegacyAdapter

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DISABLE_UNACTIVE_DRAFTS_AUTOSAVE

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

Constructor	Description
HeartbeatAction()

Method Summary

Modifier and Type	Method	Description
Object	getBean()
void	setApiRelationService(RelationService relationService)
void	setCollaborativeEditingHelper(CollaborativeEditingHelper collaborativeEditingHelper)
void	setContentEntityManager(ContentEntityManager contentEntityManager)
void	setContentId(Long contentId)
void	setContributorsHash(String contributorsHash)
void	setDarkFeaturesManager(DarkFeaturesManager darkFeaturesManager)
void	setDraftManager(DraftManager draftManager)
void	setDraftType(String draftType)
void	setHeartbeatManager(HeartbeatManager heartbeatManager)
void	setSpaceKey(String spaceKey)
void	setXsrfTokenGenerator(com.atlassian.struts.xsrf.XsrfTokenGenerator tokenGenerator)
void	setXsrfTokenGenerator(com.atlassian.xwork.XsrfTokenGenerator xsrfTokenGenerator)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3, use setXsrfTokenGenerator(XsrfTokenGenerator) instead.
String	startActivity()
String	stopActivity()

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, isPermitted, 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, execute, 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 org.apache.struts2.action.Action

execute

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

Field Details

DISABLE_UNACTIVE_DRAFTS_AUTOSAVE

protected static final String DISABLE_UNACTIVE_DRAFTS_AUTOSAVE

See Also:

• Constant Field Values

Constructor Details

HeartbeatAction

public HeartbeatAction()

Method Details

setSpaceKey

public void setSpaceKey(String spaceKey)

setContentId

public void setContentId(Long contentId)

setDraftType

public void setDraftType(String draftType)

setContributorsHash

public void setContributorsHash(String contributorsHash)

setXsrfTokenGenerator

public void setXsrfTokenGenerator(com.atlassian.struts.xsrf.XsrfTokenGenerator tokenGenerator)

setXsrfTokenGenerator

@Deprecated(forRemoval=true,
            since="9.3")
public void setXsrfTokenGenerator(com.atlassian.xwork.XsrfTokenGenerator xsrfTokenGenerator)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3, use setXsrfTokenGenerator(XsrfTokenGenerator) instead.

setHeartbeatManager

public void setHeartbeatManager(HeartbeatManager heartbeatManager)

setDraftManager

public void setDraftManager(DraftManager draftManager)

setContentEntityManager

public void setContentEntityManager(ContentEntityManager contentEntityManager)

setCollaborativeEditingHelper

public void setCollaborativeEditingHelper(CollaborativeEditingHelper collaborativeEditingHelper)

setApiRelationService

public void setApiRelationService(RelationService relationService)

setDarkFeaturesManager

public void setDarkFeaturesManager(DarkFeaturesManager darkFeaturesManager)

stopActivity

@XsrfProtectionExcluded
public String stopActivity()

startActivity

@XsrfProtectionExcluded
public String startActivity()

getBean

public Object getBean()

Specified by:

getBean in interface Beanable