Package com.atlassian.bamboo.applinks

Interface JiraApplinksService

All Known Implementing Classes:
JiraApplinksServiceImpl
public interface JiraApplinksService

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull com.atlassian.applinks.api.ApplicationLink
    createJiraApplinkWithBasicAuthentication(@NotNull String name, @NotNull URI serverUrl, @NotNull String username, @NotNull String password)
    Create JIRA applink in Bamboo configured with Basic Authentication as outgoing authentication.
    @NotNull Iterable<com.atlassian.applinks.api.ApplicationLink>
    getJiraApplicationLinks()
    Retrieve JIRA application links from all application links defined in Bamboo, returning primary link first and the rest in alphabetical order.
    com.atlassian.applinks.api.ApplicationType
    getJiraApplicationType()
    Get ApplicationType class that implements JiraApplicationType
    Iterable<com.atlassian.applinks.api.EntityLink>
    getJiraEntityLinksForProject(@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
    getJiraProjectEntityType()
    Get EntityType that implements JiraProjectEntityType
    boolean
    hasJiraApplicationLink()
    Does Bamboo have any application link pointing to a JIRA instance

  • Method Details

    • createJiraApplinkWithBasicAuthentication

      @NotNull @NotNull com.atlassian.applinks.api.ApplicationLink createJiraApplinkWithBasicAuthentication(@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 JIRA 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 - JIRA 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 JIRA application cannot be localized using serverUrl
      com.atlassian.applinks.spi.auth.AuthenticationConfigurationException - when Basic Authentication cannot be configured

    • getJiraApplicationType

      com.atlassian.applinks.api.ApplicationType getJiraApplicationType()
      Get ApplicationType class that implements JiraApplicationType
      Returns:
      ApplicationType object

    • getJiraProjectEntityType

      com.atlassian.applinks.api.EntityType getJiraProjectEntityType()
      Get EntityType that implements JiraProjectEntityType
      Returns:
      EntityType object

    • getJiraApplicationLinks

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

    • hasJiraApplicationLink

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

    • getJiraEntityLinksForProject

      Iterable<com.atlassian.applinks.api.EntityLink> getJiraEntityLinksForProject(@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