Package com.atlassian.jira.web.action

Class Dashboard

java.lang.Object

webwork.action.ActionSupport

com.atlassian.jira.web.action.JiraWebActionSupport

com.atlassian.jira.web.action.Dashboard

All Implemented Interfaces:

ErrorCollection, I18nHelper, HttpServletVariables, AuthorizationSupport, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

public class Dashboard
extends JiraWebActionSupport

Figures out what the id of the portal page the user is currently viewing is. Will fall back to system default if none can be found and the user has not favourites.

Since:

v4.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

JiraWebActionSupport.MessageType

Nested classes/interfaces inherited from interface com.atlassian.jira.util.ErrorCollection

ErrorCollection.Reason

Nested classes/interfaces inherited from interface com.atlassian.jira.util.I18nHelper

I18nHelper.BeanFactory

Field Summary

Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

ISSUE_NOT_FOUND_RESULT, log, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters, SECURITY_BREACH_RESULT

Fields inherited from class webwork.action.ActionSupport

command, errorMap, errorMessages

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor

Description

Dashboard(PortalPageService portalPageService, ApplicationProperties applicationProperties, GadgetPermissionManager gadgetPermissionManager, LoginService loginService, UserHistoryManager userHistoryManager, com.atlassian.event.api.EventPublisher eventPublisher, JiraPageBuilderService jiraPageBuilderService, FeatureManager featureManager, XsrfTokenGenerator xsrfTokenGenerator, LandingPageRedirector landingPageRedirector, RequestAssetPhaseStore assetPhaseStore, PageBuildingStrategyFactory pageBuildingStrategyFactory)

Method Summary

Modifier and Type	Method	Description
protected String	doExecute()
protected void	doValidation()
String	getAdministratorContactLink()	Get the link, with Internationalised text for contacting the administrators of JIRA.
Map<String,Object>	getContextParams()
Long	getCurrentDashboardId()
com.atlassian.gadgets.dashboard.DashboardState	getCurrentDashboardState()	Return to the caller the PortalPage being rendered.
Collection<String>	getErrorMessages()	Get all non field-specific error messages.
String	getInstallationMessage()
ApplicationUser	getLoggedInUser()
String	getLoginUrl()
Long	getSelectPageId()
void	setSelectPageId(Long selectPageId)
void	setSrc(String src)

Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, addMessageToResponse, addReason, addReasons, checkIfUrlIsAllowed, execute, forceRedirect, getActionName, getActionNameJspa, getApplicationProperties, getAuthorizationSupport, getComponentInstanceOfType, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDefaultResourceBundle, getDescTranslation, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getI18nHelper, getJiraContactHelper, getJiraServiceContext, getKeysForPrefix, getLanguage, getLocale, getLoggedInApplicationUser, getNameTranslation, getNameTranslation, getOfBizDelegator, getOutboundWhitelistProvider, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getRequestSourceType, getResourceBundle, getResult, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTimeFormat, getUnescapedText, getUntransformedRawText, getUriValidator, getUserFullName, getUserManager, getUserPreferences, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasAnyErrors, hasErrorMessage, hasErrorMessageByKey, hasGlobalPermission, hasGlobalPermission, hasIssuePermission, hasIssuePermission, hasIssuePermission, hasPermission, hasProjectPermission, hasProjectPermission, htmlEncode, insertContextPath, isAdministrator, isIndexing, isInlineDialogMode, isKeyDefined, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, removeKeyOrAddError, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, tagMauEventWithApplication, tagMauEventWithProject, urlEncode

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doDefault, getCommandName, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Methods inherited from interface com.atlassian.jira.util.ErrorCollection

addError, addErrorMessage, setErrorMessages

Constructor Details

Dashboard

public Dashboard(PortalPageService portalPageService,
 ApplicationProperties applicationProperties,
 GadgetPermissionManager gadgetPermissionManager,
 LoginService loginService,
 UserHistoryManager userHistoryManager,
 com.atlassian.event.api.EventPublisher eventPublisher,
 JiraPageBuilderService jiraPageBuilderService,
 FeatureManager featureManager,
 XsrfTokenGenerator xsrfTokenGenerator,
 LandingPageRedirector landingPageRedirector,
 RequestAssetPhaseStore assetPhaseStore,
 PageBuildingStrategyFactory pageBuildingStrategyFactory)

Method Details

setSrc

public void setSrc(String src)

doValidation

protected void doValidation()

Overrides:

doValidation in class webwork.action.ActionSupport

doExecute

protected String doExecute()
                    throws Exception

Overrides:

doExecute in class webwork.action.ActionSupport

Throws:

Exception

getInstallationMessage

public String getInstallationMessage()

getCurrentDashboardId

public Long getCurrentDashboardId()

getCurrentDashboardState

public com.atlassian.gadgets.dashboard.DashboardState getCurrentDashboardState()
                                                                        throws com.atlassian.gadgets.dashboard.PermissionException

Return to the caller the PortalPage being rendered. This method may load the PortalPage into memory if it has not already been read.

Returns:

the PortalPage being rendered.

Throws:

com.atlassian.gadgets.dashboard.PermissionException

getSelectPageId

public Long getSelectPageId()

setSelectPageId

public void setSelectPageId(Long selectPageId)

getContextParams

public Map<String,Object> getContextParams()

getErrorMessages

public Collection<String> getErrorMessages()

Description copied from interface: ErrorCollection

Get all non field-specific error messages.

Specified by:

getErrorMessages in interface ErrorCollection

Overrides:

getErrorMessages in class JiraWebActionSupport

Returns:

Collection of error Strings.

getLoggedInUser

public ApplicationUser getLoggedInUser()

Overrides:

getLoggedInUser in class JiraWebActionSupport

Returns:

The logged-in user.

getAdministratorContactLink

public String getAdministratorContactLink()

Description copied from class: JiraWebActionSupport

Get the link, with Internationalised text for contacting the administrators of JIRA. This link is present on many pages across the bredth of JIRA and so centralised here.

Overrides:

getAdministratorContactLink in class JiraWebActionSupport

Returns:

html String of the contact administrators link.

getLoginUrl

public String getLoginUrl()