com.atlassian.jira.web.action
Class Dashboard

java.lang.Object
  extended by webwork.action.ActionSupport
      extended by com.atlassian.jira.action.JiraActionSupport
          extended by com.atlassian.jira.web.action.JiraWebActionSupport
              extended by com.atlassian.jira.web.action.Dashboard
All Implemented Interfaces:
ErrorCollection, I18nHelper, 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 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
Dashboard(PortalPageService portalPageService, ApplicationProperties applicationProperties, GadgetPermissionManager gadgetPermissionManager, LoginService loginService, UserHistoryManager userHistoryManager, GadgetApplinkUpgradeUtil gadgetApplinkUpgradeUtil, com.atlassian.event.api.EventPublisher eventPublisher)
           
 
Method Summary
protected  String doExecute()
           
protected  void doValidation()
           
 Long getCurrentDashboardId()
           
 com.atlassian.gadgets.dashboard.DashboardState getCurrentDashboardState()
          Return to the caller the PortalPage being rendered.
 Renderable getDashboardRenderable()
           
 String getDashboardTitle()
           
 String getLoginLink()
           
 Long getSelectPageId()
           
 String getWarningMessage()
          Return a warning HTML string that will be displayed on the GUI.
 boolean isShowWhitelistUpgradeWarning()
           
 void setSelectPageId(Long selectPageId)
           
 
Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport
addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addReason, addReasons, forceRedirect, getAdministratorContactLink, getApplicationProperties, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDescTranslation, getDmyDateFormatter, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getJiraContactHelper, getJiraServiceContext, getLanguage, getLoggedInUser, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirectChecker, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getTimeFormat, getUriValidator, getUserFullName, getUserManager, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, htmlEncode, insertContextPath, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isInlineDialogMode, isSystemAdministrator, isUserExists, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId
 
Methods inherited from class com.atlassian.jira.action.JiraActionSupport
addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getComponentInstanceOfType, getDefaultResourceBundle, getDelegator, getI18nHelper, getKeysForPrefix, getLocale, getOfBizDelegator, getRemoteUser, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getUnescapedText, getUserPreferences, getWatcherManager, hasAnyErrors, isIndexing, removeKeyOrAddError
 
Methods inherited from class webwork.action.ActionSupport
addError, addErrorMessage, doDefault, getCommandName, getErrorMessages, getErrors, 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, getErrorMessages, getErrors, 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,
                 GadgetApplinkUpgradeUtil gadgetApplinkUpgradeUtil,
                 com.atlassian.event.api.EventPublisher eventPublisher)
Method Detail

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

getDashboardTitle

public String getDashboardTitle()

getDashboardRenderable

public Renderable getDashboardRenderable()

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

isShowWhitelistUpgradeWarning

public boolean isShowWhitelistUpgradeWarning()

getSelectPageId

public Long getSelectPageId()

setSelectPageId

public void setSelectPageId(Long selectPageId)

getLoginLink

public String getLoginLink()

getWarningMessage

public String getWarningMessage()
Return a warning HTML string that will be displayed on the GUI.

Returns:
the HTML to display on the GUI.


Copyright © 2002-2012 Atlassian. All Rights Reserved.