Package com.atlassian.bamboo.webwork

Class StarterAction

java.lang.Object

org.apache.struts2.ActionSupport

com.atlassian.bamboo.ww2.BambooActionSupport

com.atlassian.bamboo.webwork.StarterAction

All Implemented Interfaces:

JsonStreamingAction, ErrorCollection, BambooSessionAware, NavigationAware, DomainObjectSecurityAware, GlobalReadSecurityAware, ReturnUrlAware, TabSelectionAware, UserAware, com.atlassian.core.i18n.I18nTextProvider, Serializable, org.apache.struts2.action.Action, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.locale.LocaleProvider, org.apache.struts2.text.TextProvider, org.apache.struts2.Validateable

Direct Known Subclasses:

DashboardFilter, QuickFilterAction, ViewPlanUpdates, ViewResponsibilitiesForUser, ViewTelemetryAction

public class StarterAction
extends BambooActionSupport
implements TabSelectionAware

This class decides which starter page should be displayed on the web site.

If the application has not been configured, it displays the Configuration wizard.

Otherwise it displays the default home page.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	StarterAction.DashboardPage
static class	StarterAction.SpecsOnboardingDialog

Nested classes/interfaces inherited from class com.atlassian.bamboo.ww2.BambooActionSupport

BambooActionSupport.JSONStatus

Field Summary

Fields

Modifier and Type	Field	Description
protected final BambooCachingPermissionManagerFacade	cachingPermissionManagerFacade
protected ChainBranchManager	chainBranchManager
protected ExtendedAuthorManager	extendedAuthorManager
protected LabelManager	labelManager
protected QuickFilterManager	quickFilterManager

Fields inherited from class com.atlassian.bamboo.ww2.BambooActionSupport

ACCESS_DENIED, administrationConfigurationAccessor, administrationConfigurationManager, administrationConfigurationPersister, AGGREGATE_URL_PATTERN, authenticationContext, bambooPermissionManager, bambooUserManager, BUILD_KEY_CONTEXT, buildDefinitionManager, cachedPlanManager, CONFIRM, cookieCutter, deploymentProjectService, featureManager, PAGE_NOT_FOUND, PLAN_KEY_CONTEXT, planExecutionManager, planManager, pluginAccessor, projectManager, webInterfaceManager

Fields inherited from class org.apache.struts2.ActionSupport

container

Fields inherited from interface org.apache.struts2.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
StarterAction()

Method Summary

Modifier and Type	Method	Description
protected <T extends ImmutableChain> @NotNull List<T>	filterPlansByLabel(List<T> plans, List<String> theLabelNames)
protected List<ImmutableTopLevelPlan>	filterPlansByProject(List<ImmutableTopLevelPlan> plans, List<String> rawProjectKeys)
ExtendedAuthor	getAuthor()	Deprecated. use getAuthors() instead.
List<ExtendedAuthor>	getAuthors()
Collection<BuildAgent>	getBuildAgents()
protected @NotNull List<ImmutableTopLevelPlan>	getBuildPlansForDashboard()
Collection<BuildAgent>	getBusyBuildAgents()
List<ImmutableChain>	getChains()
Map<String,Object>	getChart()
List<CommitView>	getCommitViews()
List<QuickFilter>	getConfiguredQuickFilters()
CurrentlyBuilding	getCurrentlyBuilding(Long agentId)
CurrentlyBuilding	getCurrentlyBuilding(String buildResultKey)
String	getDashboardTabUrl()
Collection<ImmutableChain>	getFavouriteBuilds()
@Nullable List<String>	getFilteredProjectKeys()
@Nullable List<String>	getLabelNames()
StarterAction.DashboardPage	getPage()
int	getPageSize()
protected @NotNull StarterAction.DashboardPage	getPageToNearestProject(@Nullable String lastProjectInPreviousPage, @NotNull List<ImmutableTopLevelPlan> plans, int pageSize)
@NotNull List<ImmutableTopLevelPlan>	getPlans()
@NotNull Collection<? extends ImmutableChain>	getPlansByLabel()
@NotNull StarterAction.DashboardPage	getPlansForDashboard()
protected <T extends ImmutableChain> List<T>	getPlansWithCheckProjectPermissionFirst(Class<T> clazz)	Optimized version of FilteringPlanManager.getPlans()
ProjectStatusHelper	getProjectStatusHelper()
Collection<BuildQueueManager.QueuedResultKey>	getQueue()
String	getReorderedBuildKey()
@NotNull String	getSelectedTab()
StarterAction.SpecsOnboardingDialog	getSpecsOnboarding()
@NotNull List<QuickFilter>	getVisibleQuickFilters()
boolean	hasBranches(PlanIdentifier plan)
boolean	hasPlanPermission(String permission, PlanIdentifier plan)
boolean	isAllowedRemoteAgents()
boolean	isAnyQuickFilterActive()
boolean	isDashboardFilterConfigured()	Is different to isDashboardFilterEnabled() in that it returns true if there's any saved projectKeys / labels
boolean	isDashboardFilterEnabled()
boolean	isFavourite(ImmutableChain plan)
boolean	isQuickFilterActive(long quickFilterId)
String	myBamboo()
void	setAgentManager(AgentManager agentManager)
void	setBuildExecutionManager(BuildExecutionManager buildExecutionManager)
void	setBuildProjectKey(String buildProjectKey)
void	setBuildQueueManager(BuildQueueManager buildQueueManager)
void	setChainBranchManager(ChainBranchManager chainBranchManager)
void	setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)
void	setExtendedAuthorManager(ExtendedAuthorManager extendedAuthorManager)
void	setFilteredProjectKeys(List<String> filteredProjectKeys)
void	setLabelManager(LabelManager labelManager)
void	setLabelNames(List<String> labelNames)
void	setLastProject(String lastProject)
void	setPageSize(int pageSize)
void	setQuickFilterManager(QuickFilterManager quickFilterManager)
void	setReorderedBuildKey(String reorderedBuildKey)
void	setRepositoryDefinitionManager(RepositoryDefinitionManager repositoryDefinitionManager)
void	setResultsSummaryManager(ResultsSummaryManager resultsSummaryManager)
void	setSelectedTab(@NotNull String selectedTab)
void	setSpecsRepositoryId(Long specsRepositoryId)
void	setUserActiveQuickFilterService(UserActiveQuickFilterService userActiveQuickFilterService)
void	setVcsRepositoryManager(VcsRepositoryManager vcsRepositoryManager)
protected boolean	showOnlyFavoritesBuilds()
String	start()

Methods inherited from class com.atlassian.bamboo.ww2.BambooActionSupport

addActionError, addActionError, addActionWarning, addError, addError, addErrorCollection, addErrorMessage, addErrorMessage, addErrorMessages, addFieldErrors, addHelpPanel, addIllegalArgumentException, areCheckBoxesEmpty, buildJsonObject, buildWebPanelContext, canRunBuild, checkFieldXssSafety, createFieldValidator, doDefault, doesHelpLinkHaveMatchingTitle, doesLabelKeyHaveMatchingDescription, doExecute, doInput, forceRelativeReturnUrl, getActionErrors, getActionWarnings, getAdministrationConfiguration, getAvailableCategoryJson, getBambooContainer, getBambooLicenseManager, getBambooPermissionManager, getBambooSession, getBambooUrl, getBambooUserManager, getBaseUrl, getBestBaseUrl, getBootstrapManager, getBreadCrumbs, getChainEquiv, getCheckBoxFields, getConcurrentBuildExecutionStrategyOptions, getConcurrentBuildsEnabled, getConglomerateCookieValue, getCookieCutter, getCookieValue, getCurrentFormTheme, getCurrentSystemTime, getCurrentUrl, getDecorator, getDefaultPersister, getDescriptionFromLabelKey, getElasticConfig, getErrorMessages, getErrors, getFeatureManager, getFieldErrorAccessTracker, getFieldErrors, getFormattedActionErrors, getFormattedActionMessages, getFormattedActionWarnings, getHelpPanels, getInstanceName, getJobEquiv, getJsonObject, getNavigationContext, getNavigationUrl, getNodeLifecycleState, getNumberOfCurrentlyBuildingPlans, getPlan, getPlanManager, getPluginAccessor, getRandomString, getReturnUrl, getSecuredDomainObject, getSessionUser, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTextProvider, getTexts, getTexts, getTextWithArgs, getTotalErrors, getUser, getValidatorContext, getWebFragmentsContextMap, getWebItemsForSection, getWebPanelContext, getWebSectionsForLocation, hasActionWarnings, hasAdminPermission, hasAnyErrors, hasBuilds, hasEntityPermission, hasGlobalAdminPermission, hasGlobalPermission, hasGlobalPermission, hasKey, hasPlanPermission, hasProjectPermission, hasProjectPermission, hasRestrictedAdminPermission, hasResultKeyReadPermission, isCheckboxSetInAction, isEnableJavascript, isEnableSignup, isInlineDialog, isRestrictedAdminEnabled, isSelectFieldAndNull, isViewContactDetailsEnabled, renderFreemarkerTemplate, setAdministrationConfigurationAccessor, setAdministrationConfigurationManager, setAdministrationConfigurationPersister, setAuthenticationContext, setBambooLicenseManager, setBambooPermissionManager, setBambooUserManager, setBuildDefinitionManager, setCachedEnvironmentService, setCachedPlanManager, setChainEquiv, setCheckBoxFields, setCookieCutter, setCurrentFormTheme, setDecorator, setDeploymentProjectService, setDocumentationLinkProvider, setEnableJavascript, setErrorMessages, setFeatureManager, setI18nBeanFactory, setJobEquiv, setJsonator, setLocalizedTextProvider, setNavigationContext, setNodeLifecycleProvider, setPlanExecutionManager, setPlanManager, setPluginAccessor, setProfile, setProjectManager, setReturnUrl, setWebInterfaceManager, streamJson, toJson, toJson

Methods inherited from class org.apache.struts2.ActionSupport

addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, execute, getActionMessages, getContainer, getFormatted, getLocale, getLocaleProvider, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocale, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.utils.error.ErrorCollection

getAllErrorMessages

Methods inherited from interface org.apache.struts2.interceptor.ValidationAware

addActionMessage, addFieldError, getActionMessages, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors

Field Details

extendedAuthorManager

protected ExtendedAuthorManager extendedAuthorManager

cachingPermissionManagerFacade

protected final BambooCachingPermissionManagerFacade cachingPermissionManagerFacade

labelManager

protected LabelManager labelManager

chainBranchManager

protected ChainBranchManager chainBranchManager

quickFilterManager

protected QuickFilterManager quickFilterManager

Constructor Details

StarterAction

public StarterAction()

Method Details

start

public String start()

myBamboo

public String myBamboo()

hasPlanPermission

public boolean hasPlanPermission(String permission,
 PlanIdentifier plan)

Overrides:

hasPlanPermission in class BambooActionSupport

getDashboardTabUrl

public String getDashboardTabUrl()

getCurrentlyBuilding

public CurrentlyBuilding getCurrentlyBuilding(Long agentId)

getCurrentlyBuilding

public CurrentlyBuilding getCurrentlyBuilding(String buildResultKey)

getBuildAgents

public Collection<BuildAgent> getBuildAgents()

getBusyBuildAgents

public Collection<BuildAgent> getBusyBuildAgents()

getQueue

public Collection<BuildQueueManager.QueuedResultKey> getQueue()

isFavourite

public boolean isFavourite(ImmutableChain plan)

getPlans

@NotNull
public @NotNull List<ImmutableTopLevelPlan> getPlans()

getChains

public List<ImmutableChain> getChains()

getPlansByLabel

@NotNull
public @NotNull Collection<? extends ImmutableChain> getPlansByLabel()

getPlansForDashboard

@NotNull
public @NotNull StarterAction.DashboardPage getPlansForDashboard()

isDashboardFilterConfigured

public boolean isDashboardFilterConfigured()

Is different to isDashboardFilterEnabled() in that it returns true if there's any saved projectKeys / labels

getBuildPlansForDashboard

@NotNull
protected @NotNull List<ImmutableTopLevelPlan> getBuildPlansForDashboard()

filterPlansByProject

protected List<ImmutableTopLevelPlan> filterPlansByProject(List<ImmutableTopLevelPlan> plans,
 List<String> rawProjectKeys)

filterPlansByLabel

@NotNull
protected <T extends ImmutableChain>
@NotNull List<T> filterPlansByLabel(List<T> plans,
 List<String> theLabelNames)

getPageToNearestProject

@NotNull
protected @NotNull StarterAction.DashboardPage getPageToNearestProject(@Nullable
 @Nullable String lastProjectInPreviousPage,
 @NotNull
 @NotNull List<ImmutableTopLevelPlan> plans,
 int pageSize)

getCommitViews

public List<CommitView> getCommitViews()

getProjectStatusHelper

public ProjectStatusHelper getProjectStatusHelper()

hasBranches

public boolean hasBranches(PlanIdentifier plan)

getFavouriteBuilds

public Collection<ImmutableChain> getFavouriteBuilds()

getChart

public Map<String,Object> getChart()

getSelectedTab

@NotNull
public @NotNull String getSelectedTab()

Specified by:

getSelectedTab in interface TabSelectionAware

setSelectedTab

public void setSelectedTab(@NotNull
 @NotNull String selectedTab)

Specified by:

setSelectedTab in interface TabSelectionAware

getAuthor

@Deprecated
public ExtendedAuthor getAuthor()

Deprecated.

use getAuthors() instead. You can now have multiple authores for a user.

getAuthors

public List<ExtendedAuthor> getAuthors()

isAllowedRemoteAgents

public boolean isAllowedRemoteAgents()

getSpecsOnboarding

public StarterAction.SpecsOnboardingDialog getSpecsOnboarding()

setSpecsRepositoryId

public void setSpecsRepositoryId(Long specsRepositoryId)

setBuildProjectKey

public void setBuildProjectKey(String buildProjectKey)

getLabelNames

@Nullable
public @Nullable List<String> getLabelNames()

setLabelNames

public void setLabelNames(List<String> labelNames)

getFilteredProjectKeys

@Nullable
public @Nullable List<String> getFilteredProjectKeys()

showOnlyFavoritesBuilds

protected boolean showOnlyFavoritesBuilds()

isDashboardFilterEnabled

public boolean isDashboardFilterEnabled()

setFilteredProjectKeys

public void setFilteredProjectKeys(List<String> filteredProjectKeys)

getConfiguredQuickFilters

public List<QuickFilter> getConfiguredQuickFilters()

getVisibleQuickFilters

@NotNull
public @NotNull List<QuickFilter> getVisibleQuickFilters()

getPlansWithCheckProjectPermissionFirst

protected <T extends ImmutableChain> List<T> getPlansWithCheckProjectPermissionFirst(Class<T> clazz)

Optimized version of FilteringPlanManager.getPlans()

Type Parameters:

T -

Parameters:

clazz -

Returns:

isAnyQuickFilterActive

public boolean isAnyQuickFilterActive()

isQuickFilterActive

public boolean isQuickFilterActive(long quickFilterId)

setLastProject

public void setLastProject(String lastProject)

setPageSize

public void setPageSize(int pageSize)

getPageSize

public int getPageSize()

getPage

public StarterAction.DashboardPage getPage()

getReorderedBuildKey

public String getReorderedBuildKey()

setReorderedBuildKey

public void setReorderedBuildKey(String reorderedBuildKey)

setAgentManager

public void setAgentManager(AgentManager agentManager)

setExtendedAuthorManager

public void setExtendedAuthorManager(ExtendedAuthorManager extendedAuthorManager)

setRepositoryDefinitionManager

public void setRepositoryDefinitionManager(RepositoryDefinitionManager repositoryDefinitionManager)

setResultsSummaryManager

public void setResultsSummaryManager(ResultsSummaryManager resultsSummaryManager)

setVcsRepositoryManager

public void setVcsRepositoryManager(VcsRepositoryManager vcsRepositoryManager)

setBuildQueueManager

public void setBuildQueueManager(BuildQueueManager buildQueueManager)

setBuildExecutionManager

public void setBuildExecutionManager(BuildExecutionManager buildExecutionManager)

setLabelManager

public void setLabelManager(LabelManager labelManager)

setChainBranchManager

public void setChainBranchManager(ChainBranchManager chainBranchManager)

setEventPublisher

public void setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)

setQuickFilterManager

public void setQuickFilterManager(QuickFilterManager quickFilterManager)

setUserActiveQuickFilterService

public void setUserActiveQuickFilterService(UserActiveQuickFilterService userActiveQuickFilterService)