com.atlassian.confluence.admin.actions

Class RaiseSupportRequestAction

java.lang.Object

com.opensymphony.xwork.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.admin.actions.ViewSystemInfoAction

com.atlassian.confluence.admin.actions.RaiseSupportRequestAction

All Implemented Interfaces:

FormAware, WebInterface, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

public class RaiseSupportRequestAction
extends ViewSystemInfoAction
implements FormAware

An action to gather and e-mail information about the system to Atlassian. The ViewSystemInfoAction is extended since it provides much of the necessary information. Additional information is retrieved such as which plugins are installed.

It should be noted that the absence of a configured mail server will not prevent e-mails being created. They will still be added to the mail queue. However, the user of the action should be made aware of the situation.

Author:

Paul Curren

See Also:

Serialized Form

Field Summary

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

CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, pluginAccessor, PREVIEW, spacePermissionManager, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
RaiseSupportRequestAction()

Method Summary

Modifier and Type	Method and Description
String	doDefault() Override the default behaviour to also set any default values for the form.
String	execute()
String	getBaseUrl()
String	getContactEmail()
String	getContactName()
String	getContactNumber()
String	getDescription()
String	getExistingRequest()
String	getServerLogsDirectory()
String	getSubject()
SupportUtility	getSupportUtility()
String	getToAddresses()
boolean	isEditMode()
boolean	isIncludeServerLogs()
boolean	isMailServerAvailable()
boolean	isPermitted()
void	setContactEmail(String contactEmail)
void	setContactName(String contactName)
void	setContactNumber(String contactNumber)
void	setDescription(String description)
void	setExistingRequest(String existingRequest)
void	setGc(boolean gc) Irrelevant to this class.
void	setIncludeServerLogs(boolean includeServerLogs)
void	setMailServerManager(com.atlassian.mail.server.MailServerManager mailServerManager)
void	setServerLogsDirectory(String serverLogsDirectory)
void	setSubject(String subject)
void	setTaskManager(com.atlassian.core.task.MultiQueueTaskManager tm)
void	validate()

Methods inherited from class com.atlassian.confluence.admin.actions.ViewSystemInfoAction

getBuildStats, getDatabaseInfo, getEnabledPlugins, getEnvironmentVariables, getMemoryStatistics, getModifications, getPluginEnabledAsEnglish, getPluginEnabledAsI18nLabel, getPlugins, getRuntimeEnvironment, getServerId, getServerIdOrEnglishNone, getServerIdOrI18nNone, getServletContext, getSummaryInfo, getSupportEntitlementNumberOrEnglishNone, getSupportEntitlementNumberOrI18nNone, getSystemProperties, getSystemPropertiesHtml, getUsageInfo, isClustered, isDailyBackupEnabled, isPluginEnabled, setClusterManager, setLicenseService, setScheduledJobManager, setSettingsManager, setSidManager, setSystemInformationService

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getConfluenceAccessManager, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSharedMode, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setApiDateFormatService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSkipAccessCheck, setSpacePermissionManager, setTimeZoneManager, setUserAccessor, setWebInterfaceManager

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors

Methods inherited from class java.lang.Object

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

Constructor Detail

RaiseSupportRequestAction

public RaiseSupportRequestAction()

Method Detail

isPermitted

public boolean isPermitted()

Overrides:

isPermitted in class ViewSystemInfoAction

doDefault

public String doDefault()
                 throws Exception

Override the default behaviour to also set any default values for the form.

Overrides:

doDefault in class ConfluenceActionSupport

Returns:

the action result

Throws:

Exception - if something goes wrong

validate

public void validate()

Specified by:

validate in interface MessageHolderAware

Specified by:

validate in interface com.opensymphony.xwork.Validateable

Overrides:

validate in class com.opensymphony.xwork.ActionSupport

execute

public String execute()
               throws Exception

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class ViewSystemInfoAction

Throws:

Exception

getBaseUrl

public String getBaseUrl()

getToAddresses

public String getToAddresses()

Returns:

The system wide support address that has been configured under general configuration

getSubject

public String getSubject()

setSubject

public void setSubject(String subject)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getExistingRequest

public String getExistingRequest()

setExistingRequest

public void setExistingRequest(String existingRequest)

getContactName

public String getContactName()

setContactName

public void setContactName(String contactName)

getContactEmail

public String getContactEmail()

setContactEmail

public void setContactEmail(String contactEmail)

getContactNumber

public String getContactNumber()

setContactNumber

public void setContactNumber(String contactNumber)

isMailServerAvailable

public boolean isMailServerAvailable()

Returns:

true if a default mail server has been configured.

setGc

public void setGc(boolean gc)

Irrelevant to this class.

Overrides:

setGc in class ViewSystemInfoAction

Parameters:

gc - is always ignored and set to false

setTaskManager

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

getSupportUtility

public SupportUtility getSupportUtility()

isIncludeServerLogs

public boolean isIncludeServerLogs()

setIncludeServerLogs

public void setIncludeServerLogs(boolean includeServerLogs)

getServerLogsDirectory

public String getServerLogsDirectory()

setServerLogsDirectory

public void setServerLogsDirectory(String serverLogsDirectory)

setMailServerManager

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

isEditMode

public boolean isEditMode()

Specified by:

isEditMode in interface FormAware