Package com.atlassian.bamboo.applinks

Interface StashApplinksService

All Known Implementing Classes:
StashApplinksServiceImpl
public interface StashApplinksService

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull com.atlassian.applinks.api.ApplicationLink
    createStashApplinkWithBasicAuthentication(@NotNull String name, @NotNull URI serverUrl, @NotNull String username, @NotNull String password)
    Create Stash applink in Bamboo configured with Basic Authentication as outgoing authentication.
    @NotNull Iterable<com.atlassian.applinks.api.ApplicationLink>
    getStashApplicationLinks()
    Retrieve Stash application links from all application links defined in Bamboo, returning primary link first and the rest in alphabetical order.
    com.atlassian.applinks.api.ApplicationType
    getStashApplicationType()
    Get ApplicationType class that implements StashApplicationType
    Iterable<com.atlassian.applinks.api.EntityLink>
    getStashEntityLinksForProject(@NotNull Project bambooProject)
    Retrieve all JIRA entity links associated with a bamboo project, returning primary link first and the rest in alphabetical order.
    com.atlassian.applinks.api.EntityType
    getStashProjectEntityType()
    Get EntityType that implements StashProjectEntityType
    boolean
    hasStashApplicationLink()
    Does Bamboo have any application link pointing to a JIRA instance

  • Method Details

    • createStashApplinkWithBasicAuthentication

      @NotNull @NotNull com.atlassian.applinks.api.ApplicationLink createStashApplinkWithBasicAuthentication(@NotNull @NotNull String name, @NotNull @NotNull URI serverUrl, @NotNull @NotNull String username, @NotNull @NotNull String password) throws com.atlassian.applinks.spi.manifest.ManifestNotFoundException, com.atlassian.applinks.spi.auth.AuthenticationConfigurationException
      Create Stash applink in Bamboo configured with Basic Authentication as outgoing authentication. This functionality is used in upgrade task and import.
      Parameters:
      name - name of the applink to be created
      serverUrl - Stash server url
      username - username to be used in Basic Authentication
      password - password to be used in Basic Authentication
      Returns:
      ApplicationLink identifying created connection
      Throws:
      com.atlassian.applinks.spi.manifest.ManifestNotFoundException - when remote Stash application cannot be localized using serverUrl
      com.atlassian.applinks.spi.auth.AuthenticationConfigurationException - when Basic Authentication cannot be configured

    • getStashApplicationType

      com.atlassian.applinks.api.ApplicationType getStashApplicationType()
      Get ApplicationType class that implements StashApplicationType
      Returns:
      ApplicationType object

    • getStashProjectEntityType

      com.atlassian.applinks.api.EntityType getStashProjectEntityType()
      Get EntityType that implements StashProjectEntityType
      Returns:
      EntityType object

    • getStashApplicationLinks

      @NotNull @NotNull Iterable<com.atlassian.applinks.api.ApplicationLink> getStashApplicationLinks()
      Retrieve Stash application links from all application links defined in Bamboo, returning primary link first and the rest in alphabetical order.
      Returns:
      Iterable of ApplicationLink

    • hasStashApplicationLink

      boolean hasStashApplicationLink()
      Does Bamboo have any application link pointing to a JIRA instance
      Returns:
      true if a jira app link is present

    • getStashEntityLinksForProject

      Iterable<com.atlassian.applinks.api.EntityLink> getStashEntityLinksForProject(@NotNull @NotNull Project bambooProject)
      Retrieve all JIRA entity links associated with a bamboo project, returning primary link first and the rest in alphabetical order.
      Parameters:
      bambooProject - Bamboo project
      Returns:
      Iterable of EntityLink