Package com.atlassian.jira.plugin.webfragment

Class ThreadLocalCachingSimpleLinkManager

java.lang.Object

com.atlassian.jira.plugin.webfragment.DefaultSimpleLinkManager

com.atlassian.jira.plugin.webfragment.ThreadLocalCachingSimpleLinkManager

All Implemented Interfaces:

SimpleLinkManager

public class ThreadLocalCachingSimpleLinkManager
extends DefaultSimpleLinkManager

SimpleLinkManager implementation that caches results in JiraAuthenticationContextImpl.getRequestCache().

Since:

v6.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ThreadLocalCachingSimpleLinkManager.CacheKey

Constructor Summary

Constructors

Constructor

Description

ThreadLocalCachingSimpleLinkManager(com.atlassian.plugin.web.api.DynamicWebInterfaceManager webInterfaceManager, SimpleLinkFactoryModuleDescriptors simpleLinkFactoryModuleDescriptors, JiraAuthenticationContext authenticationContext, JiraProperties jiraProperties, com.atlassian.webresource.api.WebResourceUrlProvider webResourceUrlProvider, VelocityRequestContextFactory velocityRequestContextFactory)

Method Summary

Modifier and Type	Method	Description
List<SimpleLink>	getLinksForSection(String section, ApplicationUser remoteUser, JiraHelper jiraHelper)	Gets a list of SimpleLink for the given section.
List<SimpleLink>	getLinksForSection(String section, ApplicationUser remoteUser, JiraHelper jiraHelper, boolean addIconCachingPrefix)	Gets a list of SimpleLink for the given section.
List<SimpleLink>	getLinksForSectionIgnoreConditions(String section, ApplicationUser remoteUser, JiraHelper jiraHelper)	Gets a list of SimpleLink for the given section, without filtering links using the conditions specified for the links.
List<SimpleLinkSection>	getNotEmptySectionsForLocation(String location, ApplicationUser remoteUser, JiraHelper jiraHelper)	Gets a list of SimpleLinkSection for the given location, that have either web-items or other web-sections within them.
SimpleLinkSection	getSectionForURL(String topLevelSection, String URL, ApplicationUser remoteUser, JiraHelper jiraHelper)	Recursively search through our sections within sections within sections within ...
List<SimpleLinkSection>	getSectionsForLocation(String location, ApplicationUser remoteUser, JiraHelper jiraHelper)	Gets a list of SimpleLinkSection for the given location.
boolean	shouldLocationBeLazy(String location, ApplicationUser remoteUser, JiraHelper jiraHelper)	This determines whether a location should be loaded lazily if possible.
boolean	shouldSectionBeLazy(String section)	This determines whether a section should be loaded lazily if possible.

Methods inherited from class java.lang.Object

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

Constructor Details

ThreadLocalCachingSimpleLinkManager

public ThreadLocalCachingSimpleLinkManager(com.atlassian.plugin.web.api.DynamicWebInterfaceManager webInterfaceManager,
 SimpleLinkFactoryModuleDescriptors simpleLinkFactoryModuleDescriptors,
 JiraAuthenticationContext authenticationContext,
 JiraProperties jiraProperties,
 com.atlassian.webresource.api.WebResourceUrlProvider webResourceUrlProvider,
 VelocityRequestContextFactory velocityRequestContextFactory)

Method Details

shouldLocationBeLazy

public boolean shouldLocationBeLazy(@Nonnull
 String location,
 ApplicationUser remoteUser,
 @Nonnull
 JiraHelper jiraHelper)

Description copied from class: DefaultSimpleLinkManager

This determines whether a location should be loaded lazily if possible. This loops through all sections for the location and then retrieves all SimpleLinkFactoryModuleDescriptor for those sections and sees whether any of the factories say they should be lazy. If any say true, return true.

Specified by:

shouldLocationBeLazy in interface SimpleLinkManager

Overrides:

shouldLocationBeLazy in class DefaultSimpleLinkManager

Parameters:

location - The location to check for

remoteUser - The user that we are generating the list for

jiraHelper - The context under which the list is being generated

Returns:

true if any of the underlying factories for this location say they should be lazy, false otherwise

shouldSectionBeLazy

public boolean shouldSectionBeLazy(String section)

Description copied from class: DefaultSimpleLinkManager

This determines whether a section should be loaded lazily if possible. DO NOT USE: This method only checks simple link factories and not the web-section. Nothing uses it now and it should not be used in future!

Specified by:

shouldSectionBeLazy in interface SimpleLinkManager

Overrides:

shouldSectionBeLazy in class DefaultSimpleLinkManager

Parameters:

section - The section to check for

Returns:

true if any of the underlying factories for this section say they should be lazy, false otherwise

getLinksForSection

@Nonnull
public List<SimpleLink> getLinksForSection(@Nonnull
 String section,
 ApplicationUser remoteUser,
 @Nonnull
 JiraHelper jiraHelper)

Description copied from interface: SimpleLinkManager

Gets a list of SimpleLink for the given section.

Specified by:

getLinksForSection in interface SimpleLinkManager

Overrides:

getLinksForSection in class DefaultSimpleLinkManager

Parameters:

section - The section to generate the list for

remoteUser - The user that we are generating the list for

jiraHelper - The context under which the list is being generated

Returns:

The list of links for the given section

getLinksForSection

@Nonnull
public List<SimpleLink> getLinksForSection(@Nonnull
 String section,
 ApplicationUser remoteUser,
 @Nonnull
 JiraHelper jiraHelper,
 boolean addIconCachingPrefix)

Description copied from interface: SimpleLinkManager

Gets a list of SimpleLink for the given section. Additionally it adds caching prefix to icon url, if addIconCachinPrefix is true

Specified by:

getLinksForSection in interface SimpleLinkManager

Overrides:

getLinksForSection in class DefaultSimpleLinkManager

Parameters:

section - The section to generate the list for

remoteUser - The user that we are generating the list for

jiraHelper - The context under which the list is being generated

addIconCachingPrefix - Diecides if relative icon URL will be automatically prefixed

Returns:

The list of links for the given section

getLinksForSectionIgnoreConditions

@Nonnull
public List<SimpleLink> getLinksForSectionIgnoreConditions(@Nonnull
 String section,
 ApplicationUser remoteUser,
 @Nonnull
 JiraHelper jiraHelper)

Description copied from interface: SimpleLinkManager

Gets a list of SimpleLink for the given section, without filtering links using the conditions specified for the links. This will effectively return a list of links without running any security checks.

Specified by:

getLinksForSectionIgnoreConditions in interface SimpleLinkManager

Overrides:

getLinksForSectionIgnoreConditions in class DefaultSimpleLinkManager

Parameters:

section - The section to generate the list for

remoteUser - The user that we are generating the list for

jiraHelper - The context under which the list is being generated

Returns:

The list of links for the given section

getSectionsForLocation

@Nonnull
public List<SimpleLinkSection> getSectionsForLocation(@Nonnull
 String location,
 ApplicationUser remoteUser,
 @Nonnull
 JiraHelper jiraHelper)

Description copied from interface: SimpleLinkManager

Gets a list of SimpleLinkSection for the given location.

Specified by:

getSectionsForLocation in interface SimpleLinkManager

Overrides:

getSectionsForLocation in class DefaultSimpleLinkManager

Parameters:

location - The location to generate the list for

remoteUser - The user that we are generating the list for

jiraHelper - The context under which the list is being generated

Returns:

The list of sections for the give location

getSectionForURL

public SimpleLinkSection getSectionForURL(@Nonnull
 String topLevelSection,
 @Nonnull
 String URL,
 ApplicationUser remoteUser,
 JiraHelper jiraHelper)

Description copied from interface: SimpleLinkManager

Recursively search through our sections within sections within sections within ... To find a section that contains a link that matches this URL

Specified by:

getSectionForURL in interface SimpleLinkManager

Overrides:

getSectionForURL in class DefaultSimpleLinkManager

Parameters:

topLevelSection - The top level section from where to start searching!

URL - The URL for the action e.g. https://jdog.atlassian.com/secure/project/ViewProjects.jspa. We check if this URL contains a web-item's path which is usually something shorter like /secure/project/ViewProjects.jspa

remoteUser - The user that we are generating the list for

jiraHelper - The context under which the list is being generated

Returns:

Returns null if no section found

getNotEmptySectionsForLocation

@Nonnull
public List<SimpleLinkSection> getNotEmptySectionsForLocation(@Nonnull
 String location,
 ApplicationUser remoteUser,
 @Nonnull
 JiraHelper jiraHelper)

Description copied from interface: SimpleLinkManager

Gets a list of SimpleLinkSection for the given location, that have either web-items or other web-sections within them.

Specified by:

getNotEmptySectionsForLocation in interface SimpleLinkManager

Overrides:

getNotEmptySectionsForLocation in class DefaultSimpleLinkManager

Parameters:

location - The location to generate the list for

remoteUser - The user that we are generating the list for

jiraHelper - The context under which the list is being generated

Returns:

The list of sections for the give location