Package com.atlassian.gadgets

Interface GadgetSpecProvider

All Known Subinterfaces:
LocalGadgetSpecProvider
public interface GadgetSpecProvider

A simple representation of a container of gadget spec URIs.

External gadgets are those with specs hosted on a web server, whether provided by a plugin or added by an administrator after startup; gadgets with spec files stored inside the plugin bundle are called internal.

Host applications can implement this interface in order to provide gadget specs that are specific to the host application; for example, the JIRA legacy portlet bridge gadget.

Host applications that implement this interface should expose it as a public component in atlassian-plugins.xml:

<component key="myApplicationGadgetSpecProvider" public="true" class="com.atlassian.app.gadgets.ApplicationGadgetSpecProviderImpl"> <interface>com.atlassian.gadgets.store.GadgetSpecProvider</interface> </component>

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contains(URI gadgetSpecUri)
    Returns true if the URI is in the store, false otherwise.
    Iterable<URI>
    entries()
    Returns all the gadget URIs contained by this store.

  • Method Details

    • entries

      Iterable<URI> entries()
      Returns all the gadget URIs contained by this store.
      Returns:
      all the gadget URIs contained by this store.

    • contains

      boolean contains(URI gadgetSpecUri)
      Returns true if the URI is in the store, false otherwise.
      Parameters:
      gadgetSpecUri - URI to check is in the store
      Returns:
      true if the URI is in the store, false otherwise