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:

WebInterface, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, java.io.Serializable

public class RaiseSupportRequestAction
extends ViewSystemInfoAction

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, permissionManager, permitted, PREVIEW, settingsManager, 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

RaiseSupportRequestAction()

Method Summary

java.lang.String	doDefault() Override the default behaviour to also set any default values for the form.
java.lang.String	execute()
java.lang.String	getCcAddresses()
java.lang.String	getContactEmail()
java.lang.String	getContactName()
java.lang.String	getContactNumber()
java.lang.String	getDescription()
java.lang.String	getExistingRequest()
java.lang.String	getPluginEnabledAsEnglish(java.lang.String pluginKey) Get English label of whether a plugin is enabled or disabled.
java.lang.String	getPluginEnabledAsI18nLabel(java.lang.String pluginKey) Get internationalised label of whether a plugin is enabled or disabled.
java.util.Collection	getPlugins()
java.lang.String	getServerId()
java.lang.String	getServerIdOrEnglishNone()
java.lang.String	getServerIdOrI18nNone()
java.lang.String	getSubject()
java.lang.String	getSupportEntitlementNumberOrEnglishNone() Returns the license's SupportEntitlementNumber (SEN) if specified in a V2 license or "none" if using a V1 license or if the V2 license has no SEN.
java.lang.String	getSupportEntitlementNumberOrI18nNone() Returns the license's SupportEntitlementNumber (SEN) if specified in a V2 license or the localisation of "none.word" if using a V1 license or if the V2 license has no SEN.
java.util.Map<java.lang.Object,java.lang.Object>	getSystemProperties()
java.util.Map	getSystemPropertiesHtml()
java.lang.String	getToAddresses()
boolean	isClustered()
boolean	isMailServerAvailable()
boolean	isPluginEnabled(java.lang.String pluginKey)
void	setCcAddresses(java.lang.String ccAddresses)
void	setClusterManager(ClusterManager clusterManager)
void	setContactEmail(java.lang.String contactEmail)
void	setContactName(java.lang.String contactName)
void	setContactNumber(java.lang.String contactNumber)
void	setDescription(java.lang.String description)
void	setExistingRequest(java.lang.String existingRequest)
void	setGc(boolean gc) Irrelevant to this class.
void	setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)
void	setSidManager(ConfluenceSidManager sidManager)
void	setSubject(java.lang.String subject)
void	setTaskManager(com.atlassian.core.task.MultiQueueTaskManager tm)

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

getBuildStats, getDatabaseInfo, getDatabaseLatency, getEnabledPlugins, getMemoryStatistics, getProps, getServletContext, isPermitted, setSystemInformationService

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

addActionError, addFieldError, addPermissionTypeTo, addToHistory, formatFriendlyDate, getActionName, getBootstrapManager, getCancelResult, getDateFormatter, getDefaultResourceBundle, getEventManager, getFriendlyDateFormatter, getGlobalHelper, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSpaceHelper, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setBootstrapManager, setCancel, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setPermissionCheck, setPermissionManager, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, 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, validate

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

doDefault

public java.lang.String doDefault()
                           throws java.lang.Exception

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

Overrides:

doDefault in class ConfluenceActionSupport

Returns:

the action result

Throws:

java.lang.Exception - if something goes wrong

execute

public java.lang.String execute()
                         throws java.lang.Exception

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class ViewSystemInfoAction

Throws:

java.lang.Exception

setPluginAccessor

public void setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)

Overrides:

setPluginAccessor in class ConfluenceActionSupport

getToAddresses

public java.lang.String getToAddresses()

Returns:

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

getCcAddresses

public java.lang.String getCcAddresses()

setCcAddresses

public void setCcAddresses(java.lang.String ccAddresses)

getSubject

public java.lang.String getSubject()

setSubject

public void setSubject(java.lang.String subject)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getExistingRequest

public java.lang.String getExistingRequest()

setExistingRequest

public void setExistingRequest(java.lang.String existingRequest)

getContactName

public java.lang.String getContactName()

setContactName

public void setContactName(java.lang.String contactName)

getContactEmail

public java.lang.String getContactEmail()

setContactEmail

public void setContactEmail(java.lang.String contactEmail)

getContactNumber

public java.lang.String getContactNumber()

setContactNumber

public void setContactNumber(java.lang.String contactNumber)

getPlugins

public java.util.Collection getPlugins()

isPluginEnabled

public boolean isPluginEnabled(java.lang.String pluginKey)

getPluginEnabledAsEnglish

public java.lang.String getPluginEnabledAsEnglish(java.lang.String pluginKey)

Get English label of whether a plugin is enabled or disabled.

Returns:

"enabled" for enabled plugins or "disabled" for disabled ones

getPluginEnabledAsI18nLabel

public java.lang.String getPluginEnabledAsI18nLabel(java.lang.String pluginKey)

Get internationalised label of whether a plugin is enabled or disabled.

Returns:

i18n version of "enabled" for enabled plugins or "disabled" for disabled ones

isClustered

public boolean isClustered()

Returns:

true if the server is part of a cluster; otherwise false

getServerId

public java.lang.String getServerId()

Returns:

the server Id for this server or null if there is none set.

getServerIdOrEnglishNone

public java.lang.String getServerIdOrEnglishNone()

Returns:

the server Id for this server or "none" if there is none set.

getServerIdOrI18nNone

public java.lang.String getServerIdOrI18nNone()

Returns:

the server Id for this server or localised version of "none.word" if there is none set.

getSupportEntitlementNumberOrEnglishNone

public java.lang.String getSupportEntitlementNumberOrEnglishNone()

Returns the license's SupportEntitlementNumber (SEN) if specified in a V2 license or "none" if using a V1 license or if the V2 license has no SEN.

Returns:

This instance's SupportEntitlementNumber (SEN) or "none"

getSupportEntitlementNumberOrI18nNone

public java.lang.String getSupportEntitlementNumberOrI18nNone()

Returns the license's SupportEntitlementNumber (SEN) if specified in a V2 license or the localisation of "none.word" if using a V1 license or if the V2 license has no SEN.

Returns:

This instance's SupportEntitlementNumber (SEN) or localised version of "none.word".

setSidManager

public void setSidManager(ConfluenceSidManager sidManager)

getSystemProperties

public java.util.Map<java.lang.Object,java.lang.Object> getSystemProperties()

Returns:

the System properties.

getSystemPropertiesHtml

public java.util.Map getSystemPropertiesHtml()

Returns:

break up some typically long-lined properties using spaces

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

setClusterManager

public void setClusterManager(ClusterManager clusterManager)

Parameters:

clusterManager - the ClusterManager used to discover whether the server is part of a cluster.

setTaskManager

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