Package com.atlassian.jira.plugin.webfragment

Interface SimpleLinkManager

All Known Implementing Classes:
DefaultSimpleLinkManager, ThreadLocalCachingSimpleLinkManager
@Deprecated public interface SimpleLinkManager
Deprecated.
since v6.3 - use DynamicWebInterfaceManager directly if possible.
A manager that looks after generating lists of SimpleLink and SimpleLinkSection.
Since:
v4.0

  • Method Details

    • shouldLocationBeLazy

      boolean shouldLocationBeLazy(String location, ApplicationUser remoteUser, JiraHelper jiraHelper)
      Deprecated.
      This determines whether a location should be loaded lazily if possible.
      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 the loaction should be loaded lazily if possible, false otherwise

    • shouldSectionBeLazy

      boolean shouldSectionBeLazy(String section)
      Deprecated.
      This determines whether an individual 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!
      Parameters:
      section - The section to check for
      Returns:
      true if the section should be loaded lazily if possible, false otherwise

    • getLinksForSection

      @Nonnull List<SimpleLink> getLinksForSection(@Nonnull String section, ApplicationUser remoteUser, @Nonnull JiraHelper jiraHelper)
      Deprecated.
      Gets a list of SimpleLink for the given section.
      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 List<SimpleLink> getLinksForSection(@Nonnull String section, ApplicationUser remoteUser, @Nonnull JiraHelper jiraHelper, boolean addIconCachingPrefix)
      Deprecated.
      Gets a list of SimpleLink for the given section. Additionally it adds caching prefix to icon url, if addIconCachinPrefix is true
      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 List<SimpleLink> getLinksForSectionIgnoreConditions(@Nonnull String section, ApplicationUser remoteUser, @Nonnull JiraHelper jiraHelper)
      Deprecated.
      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.
      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 List<SimpleLinkSection> getSectionsForLocation(@Nonnull String location, ApplicationUser remoteUser, @Nonnull JiraHelper jiraHelper)
      Deprecated.
      Gets a list of SimpleLinkSection for the given location.
      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

      SimpleLinkSection getSectionForURL(@Nonnull String topLevelSection, @Nonnull String URL, ApplicationUser remoteUser, JiraHelper jiraHelper)
      Deprecated.
      Recursively search through our sections within sections within sections within ... To find a section that contains a link that matches this URL
      Parameters:
      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
      topLevelSection - The top level section from where to start searching!
      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 List<SimpleLinkSection> getNotEmptySectionsForLocation(@Nonnull String location, ApplicationUser remoteUser, @Nonnull JiraHelper jiraHelper)
      Deprecated.
      Gets a list of SimpleLinkSection for the given location, that have either web-items or other web-sections within them.
      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