Package com.atlassian.confluence.user.actions

Class SiteSupportAction

java.lang.Object

org.apache.struts2.ActionSupport

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.user.actions.SiteSupportAction

All Implemented Interfaces:

FormAware, 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 SiteSupportAction
extends ConfluenceActionSupport
implements CaptchaAware, FormAware

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 CaptchaManager	captchaManager
protected com.atlassian.core.task.MultiQueueTaskManager	taskManager
protected com.atlassian.renderer.WikiStyleRenderer	wikiStyleRenderer

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
SiteSupportAction()

Method Summary

Modifier and Type	Method	Description
String	doContactAdministrators()	Send an e-mail to the administrators configured on the wiki
String	doDefault()	Convenient Action execution method which defaults to returning INPUT
CaptchaManager	getCaptchaManager()
String	getContactAddress()
String	getDescription()
String	getMessage()
String	getSubject()
String	getToDisplayValue()
boolean	isAdminstratorEmailAddresses()
boolean	isDisplaySupportRequest()
boolean	isEditMode()
boolean	isMailServerAvailable()
boolean	isPermitted()	Consulted by PermissionCheckInterceptor.
void	setActionRateLimiterSiteSupport(ActionRateLimiter actionRateLimiterSiteSupport)	Setting ActionRateLimiter
void	setCaptchaManager(CaptchaManager captchaManager)
void	setContactAddress(String contactAddress)
void	setDescription(String description)
void	setMailServerManager(com.atlassian.mail.server.MailServerManager mailServerManager)
void	setSubject(String subject)
void	setTaskManager(com.atlassian.core.task.MultiQueueTaskManager tm)
void	setWikiStyleRenderer(com.atlassian.renderer.WikiStyleRenderer wikiStyleRenderer)
void	validate()

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, 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, execute, 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 org.apache.struts2.action.Action

execute

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

mustValidateCaptcha

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

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

Field Details

wikiStyleRenderer

protected com.atlassian.renderer.WikiStyleRenderer wikiStyleRenderer

captchaManager

protected CaptchaManager captchaManager

taskManager

protected com.atlassian.core.task.MultiQueueTaskManager taskManager

Constructor Details

SiteSupportAction

public SiteSupportAction()

Method Details

setActionRateLimiterSiteSupport

public void setActionRateLimiterSiteSupport(ActionRateLimiter actionRateLimiterSiteSupport)

Setting ActionRateLimiter

Parameters:

actionRateLimiterSiteSupport -

Since:

8.7

getMessage

public String getMessage()

Returns:

a message suitable for display as the site error message

isDisplaySupportRequest

public boolean isDisplaySupportRequest()

Returns:

true if the support request component of the Site Support screen should be displayed to the user.

isAdminstratorEmailAddresses

public boolean isAdminstratorEmailAddresses()

Returns:

true if there is at least one administrator configured in the system with an e-mail address

isMailServerAvailable

public boolean isMailServerAvailable()

Returns:

true if a default mail server has been configured.

getToDisplayValue

public String getToDisplayValue()

getSubject

public String getSubject()

setSubject

public void setSubject(String subject)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

isEditMode

public boolean isEditMode()

Specified by:

isEditMode in interface FormAware

doContactAdministrators

public String doContactAdministrators()

Send an e-mail to the administrators configured on the wiki

doDefault

public String doDefault()
                 throws Exception

Description copied from class: ConfluenceActionSupport

Convenient Action execution method which defaults to returning INPUT

Overrides:

doDefault in class ConfluenceActionSupport

Throws:

Exception

getContactAddress

public String getContactAddress()

setContactAddress

public void setContactAddress(String contactAddress)

setWikiStyleRenderer

public void setWikiStyleRenderer(com.atlassian.renderer.WikiStyleRenderer wikiStyleRenderer)

setCaptchaManager

public void setCaptchaManager(CaptchaManager captchaManager)

getCaptchaManager

public CaptchaManager getCaptchaManager()

setTaskManager

public void setTaskManager(com.atlassian.core.task.MultiQueueTaskManager tm)

setMailServerManager

public void setMailServerManager(com.atlassian.mail.server.MailServerManager mailServerManager)

isPermitted

public boolean isPermitted()

Description copied from class: ConfluenceActionSupport

Consulted by PermissionCheckInterceptor.

Overrides:

isPermitted in class ConfluenceActionSupport

Returns:

true for all users including the anonymous user.

validate

public void validate()

Specified by:

validate in interface MessageHolderAware

Specified by:

validate in interface org.apache.struts2.Validateable

Overrides:

validate in class org.apache.struts2.ActionSupport

Since:

8.7