com.atlassian.jira.web.action

Class Dashboard

java.lang.Object

webwork.action.ActionSupport

com.atlassian.jira.action.JiraActionSupport

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, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters

Fields inherited from class com.atlassian.jira.action.JiraActionSupport

log

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 and 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)

Method Summary

Modifier and Type	Method and Description
protected String	doExecute()
protected void	doValidation()
Map<String,Object>	getContextParams()
Long	getCurrentDashboardId()
com.atlassian.gadgets.dashboard.DashboardState	getCurrentDashboardState() Return to the caller the PortalPage being rendered.
String	getInstallationMessage()
String	getLoginLink()
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, addMessageToResponse, addReason, addReasons, forceRedirect, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDescTranslation, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getJiraContactHelper, getJiraServiceContext, getLanguage, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getRequestSourceType, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getTimeFormat, getUriValidator, getUserFullName, getUserManager, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, hasGlobalPermission, hasGlobalPermission, hasIssuePermission, hasIssuePermission, hasIssuePermission, hasPermission, hasProjectPermission, hasProjectPermission, htmlEncode, insertContextPath, isInlineDialogMode, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, tagMauEventWithApplication, tagMauEventWithProject, urlEncode

Methods inherited from class com.atlassian.jira.action.JiraActionSupport

addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getComponentInstanceOfType, getDefaultResourceBundle, getI18nHelper, getKeysForPrefix, getLocale, getOfBizDelegator, getResourceBundle, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getUnescapedText, getUntransformedRawText, getUserPreferences, hasAnyErrors, isIndexing, isKeyDefined, removeKeyOrAddError

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 com.atlassian.jira.util.ErrorCollection

addError, addErrorMessage, addErrorMessages, addErrors, hasAnyErrors, setErrorMessages

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Constructor Detail

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)

Method Detail

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)

getLoginLink

public String getLoginLink()

getContextParams

public Map<String,Object> getContextParams()