Interface GenericIntegrationProvider

All Superinterfaces:
PluginProvider, UIExtensionProvider
All Known Implementing Classes:
AbstractGenericIntegrationProvider

public interface GenericIntegrationProvider extends PluginProvider, UIExtensionProvider
Allows for the registration of a "Generic" AccountIntegrationType. These could be used to store metadata related to other providers. For example, a Jenkins Task Type may not want the user to have to enter in credentials every time. Instead, they could choose an integration that has those credentials. Additionally, the integration could store data for DatasetProvider dropdowns in those task types. In the Jenkins example, a list of projects could be periodically synced.
Since:
0.15.4
  • Method Details

    • getCategory

      String getCategory()
      The category of the integration. This is used to group integrations in the UI. Available categories are defined in AccountIntegration.Category.
      Returns:
    • getOptionTypes

      List<OptionType> getOptionTypes()
      Provide custom configuration options when creating a new AccountIntegration
      Returns:
      a List of OptionType
    • refresh

      void refresh(AccountIntegration accountIntegration)
      Refresh the integration with the latest data from the provider
      Parameters:
      accountIntegration - the integration to refresh
    • getIcon

      Icon getIcon()
      Returns the Integration logo for display when a user needs to view or add this integration
      Returns:
      Icon representation of assets stored in the src/assets of the project.
      Since:
      0.12.3
    • renderTemplate

      HTMLResponse renderTemplate(AccountIntegration integration)
      Integration details provided to your rendering engine
      Parameters:
      integration - details of an Instance
      Returns:
      result of rendering a template