Package com.atlassian.confluence.pages.actions

Class AddCommentAction

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

com.atlassian.confluence.pages.actions.AbstractPageAction

com.atlassian.confluence.pages.actions.AbstractPreviewPageAction

com.atlassian.confluence.pages.actions.AddCommentAction

All Implemented Interfaces:

Beanable, PageAware, TinyUrlAware, WebInterface, CaptchaAware, 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 AddCommentAction
extends AbstractPreviewPageAction
implements CaptchaAware

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 inherited from class com.atlassian.confluence.pages.actions.AbstractPreviewPageAction

back, bean, formatConverter, inPreview, preview, storageFormat, wikiStyleRenderer, wysiwygContent

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractPageAction

incomingLinks, linkManager, pageManager, PREVIEW, RICHTEXT, viewRenderer, wysiwygConverter

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractPageAwareAction

contentPermissionManager, spaceManager

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, 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
AddCommentAction()

Method Summary

Modifier and Type	Method	Description
static WebInterfaceContext	createWebInterfaceContextWithComment(WebInterfaceContext context, Comment comment)
String	execute()
long	getAddCommentId()
String	getCancelResult()
CaptchaManager	getCaptchaManager()
Comment	getComment()	Deprecated, for removal: This API element is subject to removal in a future version. since 8.8.0.
long	getParentId()
List	getPermittedChildren()
String	getTextContent()
WebInterfaceContext	getWebInterfaceContext(Comment comment)
String	getWysiwygContent()	Override since the base implementation will return the content of a page, instead of the comment.
boolean	isPermitted()	Consulted by PermissionCheckInterceptor.
void	setCaptchaManager(CaptchaManager captchaManager)
void	setCommentService(CommentService commentService)
void	setNotificationManager(NotificationManager notificationManager)
void	setParentId(long parentId)
void	setTextContent(String textContent)
void	setWatchPageAfterComment(boolean watchPageAfterComment)
void	validate()	Convert the editor content to storageFormat, catching and reporting any problems in the process.

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPreviewPageAction

getBean, getContentForSaving, getConversionContext, getEditorFormattedContent, getInPreview, getRenderContext, getStorageFormat, getxHtmlContent, setBack, setFormatConverter, setInPreview, setPreview, setWikiStyleRenderer, setWysiwygContent, updateXHtmlContent

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPageAction

displayDatePath, getAttachmentSourceContent, getAvailableSpaces, getBeanKey, getBlogPost, getEditorVersion, getHelper, getIncomingLinks, getLabels, getMode, getNextPost, getNumberOfAttachmentsAsString, getNumberOfLabelsAsString, getPermissionTypes, getPostingDateAsDate, getPostingDay, getPostingTimeAsTime, getPreviousPost, getPreviousVersion, getSpaceManager, getSuggestedLabels, getTinyUrl, getWebInterfaceContext, hasAttachFilePermissions, hasPermittedChildren, isSpaceAdmin, isSuperUser, isUserWatchingOwnContent, setConfluenceWysiwygConverter, setEditorManager, setLinkManager, setMode, setPageManager, setPostingDate, setPostingTime, setViewRenderer

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPageAwareAction

getCustomPageUrl, getPage, getPageId, getPageUrl, getSpace, getSpaceKey, getTitle, isCollaborativeContent, isLatestVersionRequired, isPageRequired, isViewPermissionRequired, setContentPermissionManager, setPage, setSpaceManager

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, getActionErrors, getActionMessages, getActionName, getAuthenticatedUser, getBootstrapStatusProvider, getCurrentRequest, getCurrentResponse, getDateFormatter, getDefaultTimeZone, getFieldErrors, getGlobalSettings, getI18n, getLocale, getMessageHolder, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getTimeZone, getUserByName, getUserInterfaceState, 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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.security.CaptchaAware

mustValidateCaptcha

Methods inherited from interface com.atlassian.confluence.pages.actions.PageAware

isEditPermissionRequired

Methods inherited from interface org.apache.struts2.interceptor.ValidationAware

addActionError, addActionMessage, addFieldError, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors

Constructor Details

AddCommentAction

public AddCommentAction()

Method Details

validate

public void validate()

Description copied from class: AbstractPreviewPageAction

Convert the editor content to storageFormat, catching and reporting any problems in the process. On successful validation, the storageFormat field will be populated with a storage format representation of the editor content, ready for saving.

Specified by:

validate in interface MessageHolderAware

Specified by:

validate in interface org.apache.struts2.Validateable

Overrides:

validate in class AbstractPreviewPageAction

execute

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

getWysiwygContent

public String getWysiwygContent()

Override since the base implementation will return the content of a page, instead of the comment.

Overrides:

getWysiwygContent in class AbstractPreviewPageAction

Returns:

the editor formatted content for the CEO being edited.

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.

getAddCommentId

public long getAddCommentId()

isPermitted

public boolean isPermitted()

Description copied from class: ConfluenceActionSupport

Consulted by PermissionCheckInterceptor.

Overrides:

isPermitted in class AbstractPageAwareAction

getPermittedChildren

public List getPermittedChildren()

Overrides:

getPermittedChildren in class AbstractPageAction

setParentId

public void setParentId(long parentId)

getParentId

public long getParentId()

getTextContent

public String getTextContent()

setTextContent

public void setTextContent(String textContent)

getCancelResult

public String getCancelResult()

Overrides:

getCancelResult in class ConfluenceActionSupport

setCommentService

public void setCommentService(CommentService commentService)

setNotificationManager

public void setNotificationManager(NotificationManager notificationManager)

setWatchPageAfterComment

public void setWatchPageAfterComment(boolean watchPageAfterComment)

getCaptchaManager

public CaptchaManager getCaptchaManager()

setCaptchaManager

public void setCaptchaManager(CaptchaManager captchaManager)

getWebInterfaceContext

public WebInterfaceContext getWebInterfaceContext(Comment comment)

createWebInterfaceContextWithComment

public static WebInterfaceContext createWebInterfaceContextWithComment(WebInterfaceContext context,
 Comment comment)