com.atlassian.bamboo.ww2

Class FreemarkerContext

java.lang.Object

com.atlassian.bamboo.ww2.FreemarkerContext

All Implemented Interfaces:

BareFreeMarkerContext

public class FreemarkerContext
extends Object
implements BareFreeMarkerContext

This class is similar to BambooActionSupport but does not require an action or action context. This makes this functionality available to any servlets as well.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FreemarkerContext.WebItemDto
static class	FreemarkerContext.WebSectionDto

Constructor Summary

Constructors

Constructor and Description

FreemarkerContext(AdministrationConfigurationAccessor administrationConfigurationAccessor, BambooLicenseManager bambooLicenseManager, BambooPermissionManager bambooPermissionManager, BambooUserManager bambooUserManager, BootstrapManager bootstrapManager, CachedPlanManager cachedPlanManager, CachedRepositoryDefinitionManager cachedRepositoryDefinitionManager, CommentManager commentManager, DarkFeatureService darkFeatureService, DocumentationLinkProvider documentationLinkProvider, FeatureManager featureManager, GravatarService gravatarService, LinkedDeploymentProjectCacheService linkedDeploymentProjectCacheService, NotificationManager notificationManager, PlanFavouriteService planFavouriteService, PlanManager planManager, com.atlassian.plugin.PluginAccessor pluginAccessor, ServerStatusProvider serverStatusProvider, StorageCappingService storageCappingService, VcsRepositoryViewerManager vcsRepositoryViewerManager, com.atlassian.plugin.web.api.DynamicWebInterfaceManager webInterfaceManager, com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration, SystemInfo systemInfo, com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider, CustomVariableContext customVariableContext)

Method Summary

Modifier and Type	Method and Description
boolean	canCreatePlan()
boolean	canCreatePlanInProject(Project project)
boolean	canCreateProject()
boolean	canRunCustomBuild(PlanIdentifier plan) Checks if the current user has permissions sufficient to run custom/parameterised build of a given plan
BambooLicenseManager	getBambooLicenseManager()
BambooUser	getBambooUser(String username)
BootstrapManager	getBootstrapManager()
String	getCurrentUrl(javax.servlet.http.HttpServletRequest request)
DarkFeatureService	getDarkFeatureService()
List<com.atlassian.plugin.web.api.WebItem>	getDynamicWebItemsForSectionNoAction(String sectionName, javax.servlet.http.HttpServletRequest request) Obtain a list of web items within the provided location.
List<com.atlassian.plugin.web.api.WebSection>	getDynamicWebSectionsForLocationNoAction(String location, javax.servlet.http.HttpServletRequest request) Obtain a list of web sections within the provided location.
String	getFaviconPath()
FeatureManager	getFeatureManager()
String	getGravatarUrl(String userName, String size)
DocumentationLinkProvider	getHelpLink()
String	getInstanceName()
String	getLogoPath()
NotificationManager	getNotificationManager()
PluggableFooter	getPluggableFooter() Gets the pluggable footer plugin.
PluggableTopNavigation	getPluggableTopNavigation() Gets the pluggable top navigation plugin.
int	getRemainingJobsLimit()
String	getRssLink(DeploymentProject project)
String	getRssLink(ImmutablePlan plan)
String	getRssRepositoryId(DeploymentProject project)
String	getRssRepositoryId(ImmutablePlan plan)
ServerLifecycleState	getServerLifecycleState()
ServerStatusInfo	getServerStatusInfo()
StorageCappingService	getStorageCappingService()
String	getSystemEncoding()
com.atlassian.user.User	getUser(javax.servlet.http.HttpServletRequest request)
Map<String,Object>	getWebFragmentsContextMapNoAction(javax.servlet.http.HttpServletRequest request) A context map that gets appended to for web fragments.
List<Map<String,Object>>	getWebItems(String sectionName, javax.servlet.http.HttpServletRequest request) Returns a list of Map objects with prefilled text, id, accesskey, href fields for a template engine layer to consome
List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor>	getWebItemsForSectionNoAction(String sectionName, javax.servlet.http.HttpServletRequest request) Deprecated. since 6.8 use getDynamicWebItemsForSectionNoAction(String, HttpServletRequest)
Collection<String>	getWebPanels(String location) Gets all the rendered WebPanels for the location specified.
Collection<String>	getWebPanels(String location, Map<String,Object> context)
Collection<String>	getWebPanelsForPlan(String location, String planKey) Gets all the rendered WebPanels for the location specified for a specific plan key.
Collection<String>	getWebPanelsForResultsSummary(String location, ResultsSummary resultsSummary) Gets all the rendered WebPanels for the location specified for a specific ResultSummary.
List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor>	getWebSectionsForLocationNoAction(String location, javax.servlet.http.HttpServletRequest request) Deprecated. since 6.8 use getDynamicWebSectionsForLocationNoAction(String, HttpServletRequest)
List<FreemarkerContext.WebSectionDto>	getWebSectionsWithItems(String location, javax.servlet.http.HttpServletRequest request, String pageCrumb) Return a DTO storing all web sections for the given location together with a list of all web items under each web section.
String	getXsrfToken()
boolean	hasAdminPermission()
boolean	hasBuilds()
boolean	hasComments(BambooIdProvider entity)
boolean	hasGlobalAdminPermission()
boolean	hasGlobalPermission(String permission) Does this user have the global permission right?
boolean	hasLinkedDeployments(PlanKey planKey)
boolean	hasProjectAdminPermission(Project project)
boolean	hasRestrictedAdminPermission()
boolean	isAuthorBambooServer(String userName) Is the supplied author user the bamboo server?
boolean	isAwaitingSpecsExecution(ImmutablePlan plan)
boolean	isBambooSpecsFailure(ImmutableResultsSummary buildResult)
boolean	isBambooSpecsResult(ImmutableResultsSummary buildResult)
boolean	isBambooSpecsSuccess(ImmutableResultsSummary buildResult)
boolean	isEc2ConfigurationWarningRequired()
boolean	isEnableSignup()
boolean	isFavourite(ImmutablePlan plan, javax.servlet.http.HttpServletRequest request)
boolean	isFunctionalTest()
boolean	isOnDemandInstance()
boolean	isRepositoryDashboardOn()
boolean	isRssManagedPlan(ImmutablePlan plan)
boolean	isShowAdminContactDetailsToAnonymousUsers()
boolean	isUserAutocompleteAllowed()
boolean	isXsrfTokenNeeded(String formActionDestination)
String	renderFreemarkerTemplateNoAction(String templateString, javax.servlet.http.HttpServletRequest request) Will not bother putting any build information on the context
String	sanitizeUrl(String url)
Boolean	shouldShowActionTip(String actionKey, javax.servlet.http.HttpServletRequest request) Check if provided action-key is available inside user preferences.

Methods inherited from class java.lang.Object

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

Constructor Detail

FreemarkerContext

@Inject
public FreemarkerContext(AdministrationConfigurationAccessor administrationConfigurationAccessor,
                                 BambooLicenseManager bambooLicenseManager,
                                 BambooPermissionManager bambooPermissionManager,
                                 BambooUserManager bambooUserManager,
                                 BootstrapManager bootstrapManager,
                                 CachedPlanManager cachedPlanManager,
                                 CachedRepositoryDefinitionManager cachedRepositoryDefinitionManager,
                                 CommentManager commentManager,
                                 DarkFeatureService darkFeatureService,
                                 DocumentationLinkProvider documentationLinkProvider,
                                 FeatureManager featureManager,
                                 GravatarService gravatarService,
                                 LinkedDeploymentProjectCacheService linkedDeploymentProjectCacheService,
                                 NotificationManager notificationManager,
                                 PlanFavouriteService planFavouriteService,
                                 PlanManager planManager,
                                 com.atlassian.plugin.PluginAccessor pluginAccessor,
                                 ServerStatusProvider serverStatusProvider,
                                 StorageCappingService storageCappingService,
                                 VcsRepositoryViewerManager vcsRepositoryViewerManager,
                                 com.atlassian.plugin.web.api.DynamicWebInterfaceManager webInterfaceManager,
                                 com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration,
                                 SystemInfo systemInfo,
                                 com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider,
                                 CustomVariableContext customVariableContext)

Method Detail

getInstanceName

@NotNull
public String getInstanceName()

getLogoPath

@Nullable
public String getLogoPath()

getFaviconPath

@Nullable
public String getFaviconPath()

getUser

@Nullable
public com.atlassian.user.User getUser(@Nullable
                                                 javax.servlet.http.HttpServletRequest request)

isEnableSignup

public boolean isEnableSignup()

isUserAutocompleteAllowed

public boolean isUserAutocompleteAllowed()

isOnDemandInstance

public boolean isOnDemandInstance()

isEc2ConfigurationWarningRequired

public boolean isEc2ConfigurationWarningRequired()

sanitizeUrl

public String sanitizeUrl(String url)

getCurrentUrl

@Nullable
public String getCurrentUrl(javax.servlet.http.HttpServletRequest request)

hasBuilds

public boolean hasBuilds()

getRemainingJobsLimit

public int getRemainingJobsLimit()

isFavourite

public boolean isFavourite(ImmutablePlan plan,
                           javax.servlet.http.HttpServletRequest request)

getGravatarUrl

@Nullable
public String getGravatarUrl(@Nullable
                                       String userName,
                                       String size)

getBambooUser

@Nullable
public BambooUser getBambooUser(@Nullable
                                          String username)

isAuthorBambooServer

public boolean isAuthorBambooServer(@Nullable
                                    String userName)

Is the supplied author user the bamboo server?

Parameters:

userName -

Returns:

true if the author is the bamboo server, otherwise false.

getWebItemsForSectionNoAction

@Deprecated
public List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor> getWebItemsForSectionNoAction(String sectionName,
                                                                                                                    javax.servlet.http.HttpServletRequest request)

Deprecated. since 6.8 use getDynamicWebItemsForSectionNoAction(String, HttpServletRequest)

Will not bother putting any build information on the context

Parameters:

sectionName - - the section to retrieve the web items for

request - - the http request

Returns:

all web items contained within the provided section

getDynamicWebItemsForSectionNoAction

public List<com.atlassian.plugin.web.api.WebItem> getDynamicWebItemsForSectionNoAction(String sectionName,
                                                                                       javax.servlet.http.HttpServletRequest request)

Obtain a list of web items within the provided location. Will include web items generated dynamically by web item providers. Does not put any build/plan information to the context.

See Also:

WebItem, WebItemProvider, DynamicWebInterfaceManager

getWebItems

@NotNull
public List<Map<String,Object>> getWebItems(String sectionName,
                                                     javax.servlet.http.HttpServletRequest request)

Returns a list of Map objects with prefilled text, id, accesskey, href fields for a template engine layer to consome

Parameters:

sectionName -

request -

Returns:

getWebSectionsForLocationNoAction

@Deprecated
public List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor> getWebSectionsForLocationNoAction(String location,
                                                                                                                           javax.servlet.http.HttpServletRequest request)

Deprecated. since 6.8 use getDynamicWebSectionsForLocationNoAction(String, HttpServletRequest)

Will not bother putting any build information on the context

Parameters:

location - - the location to retrieve the web sections for

request - - the http request

Returns:

all web sections contained within the provided location

getDynamicWebSectionsForLocationNoAction

public List<com.atlassian.plugin.web.api.WebSection> getDynamicWebSectionsForLocationNoAction(String location,
                                                                                              javax.servlet.http.HttpServletRequest request)

Obtain a list of web sections within the provided location. Will include web sections generated dynamically by web section providers. Does not put any build/plan information to the context.

See Also:

WebSection, WebSectionProvider, DynamicWebInterfaceManager

getWebSectionsWithItems

public List<FreemarkerContext.WebSectionDto> getWebSectionsWithItems(@NotNull
                                                                     String location,
                                                                     @NotNull
                                                                     javax.servlet.http.HttpServletRequest request,
                                                                     @NotNull
                                                                     String pageCrumb)

Return a DTO storing all web sections for the given location together with a list of all web items under each web section.

Based on the pageCrumb the result will also contain information whether a web section or a web item is currently active or not.

This method supports dynamically generated web sections and web items (produced by web section providers and web item providers, respectively).

See Also:

getDynamicWebSectionsForLocationNoAction(String, HttpServletRequest), getDynamicWebItemsForSectionNoAction(String, HttpServletRequest)

renderFreemarkerTemplateNoAction

public String renderFreemarkerTemplateNoAction(String templateString,
                                               javax.servlet.http.HttpServletRequest request)

Will not bother putting any build information on the context

Parameters:

templateString - - to render

request - - the http request

Returns:

The rendered string

hasGlobalPermission

public boolean hasGlobalPermission(String permission)

Does this user have the global permission right?

Parameters:

permission - The global permission being checked.

Returns:

true if the current user has this permission; false otherwise.

hasGlobalAdminPermission

public boolean hasGlobalAdminPermission()

hasRestrictedAdminPermission

public boolean hasRestrictedAdminPermission()

hasProjectAdminPermission

public boolean hasProjectAdminPermission(@NotNull
                                         Project project)

canCreateProject

public boolean canCreateProject()

canCreatePlanInProject

public boolean canCreatePlanInProject(@NotNull
                                      Project project)

canCreatePlan

public boolean canCreatePlan()

canRunCustomBuild

public boolean canRunCustomBuild(PlanIdentifier plan)

Checks if the current user has permissions sufficient to run custom/parameterised build of a given plan

hasAdminPermission

public boolean hasAdminPermission()

getBambooLicenseManager

public BambooLicenseManager getBambooLicenseManager()

getServerLifecycleState

@NotNull
public ServerLifecycleState getServerLifecycleState()

getServerStatusInfo

@NotNull
public ServerStatusInfo getServerStatusInfo()

getPluggableTopNavigation

@Nullable
public PluggableTopNavigation getPluggableTopNavigation()

Gets the pluggable top navigation plugin.

Returns:

The pluggable top navigation plugin, if it exists, or null.

getPluggableFooter

@Nullable
public PluggableFooter getPluggableFooter()

Gets the pluggable footer plugin.

Returns:

The pluggable footer plugin, if it exists, or null.

shouldShowActionTip

@Nullable
public Boolean shouldShowActionTip(@NotNull
                                             String actionKey,
                                             @NotNull
                                             javax.servlet.http.HttpServletRequest request)

Check if provided action-key is available inside user preferences.

Parameters:

request -

actionKey -

Returns:

Boolean

getWebFragmentsContextMapNoAction

public Map<String,Object> getWebFragmentsContextMapNoAction(javax.servlet.http.HttpServletRequest request)

A context map that gets appended to for web fragments. Will not look for any build information to put on the context path.

Parameters:

request - - servlet request

Returns:

A context map that gets appended to for web fragments.

getWebPanelsForPlan

public Collection<String> getWebPanelsForPlan(@NotNull
                                              String location,
                                              @NotNull
                                              String planKey)

Gets all the rendered WebPanels for the location specified for a specific plan key. Allows the same web panel location to be used in multiple places on page with different plan contexts. If called in the context of rendering a BambooActionSupport action the context used is taken from BambooActionSupport.getWebPanelContext(String)

Parameters:

location - the web panel will be displayed

planKey - key of the plan for the context

Returns:

webPanels

getWebPanelsForResultsSummary

public Collection<String> getWebPanelsForResultsSummary(@NotNull
                                                        String location,
                                                        @NotNull
                                                        ResultsSummary resultsSummary)

Gets all the rendered WebPanels for the location specified for a specific ResultSummary. Allows the same web panel location to be used in multiple places on page with different plan contexts. If called in the context of rendering a BambooActionSupport action the context used is taken from BambooActionSupport.getWebPanelContext(String)

Parameters:

location - the web panel will be displayed

resultsSummary - passed to the web panels in the context

Returns:

webPanels

getWebPanels

public Collection<String> getWebPanels(@NotNull
                                       String location)

Gets all the rendered WebPanels for the location specified. If called in the context of rendering a BambooActionSupport action the context used is taken from BambooActionSupport.getWebPanelContext(String)

Parameters:

location -

Returns:

webPanels

getWebPanels

public Collection<String> getWebPanels(@NotNull
                                       String location,
                                       @NotNull
                                       Map<String,Object> context)

getFeatureManager

public FeatureManager getFeatureManager()

getDarkFeatureService

public DarkFeatureService getDarkFeatureService()

getHelpLink

public DocumentationLinkProvider getHelpLink()

getStorageCappingService

public StorageCappingService getStorageCappingService()

getRssLink

@Nullable
public String getRssLink(@NotNull
                                   ImmutablePlan plan)

getRssRepositoryId

@Nullable
public String getRssRepositoryId(@NotNull
                                           ImmutablePlan plan)

getRssLink

@Nullable
public String getRssLink(@NotNull
                                   DeploymentProject project)

getRssRepositoryId

@Nullable
public String getRssRepositoryId(@NotNull
                                           DeploymentProject project)

isRssManagedPlan

public boolean isRssManagedPlan(@Nullable
                                ImmutablePlan plan)

getSystemEncoding

@NotNull
public String getSystemEncoding()

isRepositoryDashboardOn

public boolean isRepositoryDashboardOn()

getBootstrapManager

public BootstrapManager getBootstrapManager()

getXsrfToken

@Nullable
public String getXsrfToken()

Specified by:

getXsrfToken in interface BareFreeMarkerContext

isXsrfTokenNeeded

public boolean isXsrfTokenNeeded(@Nullable
                                 String formActionDestination)

Specified by:

isXsrfTokenNeeded in interface BareFreeMarkerContext

hasLinkedDeployments

public boolean hasLinkedDeployments(@Nullable
                                    PlanKey planKey)

isFunctionalTest

public boolean isFunctionalTest()

hasComments

public boolean hasComments(@NotNull
                           BambooIdProvider entity)

isShowAdminContactDetailsToAnonymousUsers

public boolean isShowAdminContactDetailsToAnonymousUsers()

getNotificationManager

public NotificationManager getNotificationManager()

isBambooSpecsFailure

public boolean isBambooSpecsFailure(@Nullable
                                    ImmutableResultsSummary buildResult)

isBambooSpecsSuccess

public boolean isBambooSpecsSuccess(@Nullable
                                    ImmutableResultsSummary buildResult)

isBambooSpecsResult

public boolean isBambooSpecsResult(@Nullable
                                   ImmutableResultsSummary buildResult)

isAwaitingSpecsExecution

public boolean isAwaitingSpecsExecution(@Nullable
                                        ImmutablePlan plan)