@ParametersAreNonnullByDefault

Package com.atlassian.gadgets.spi

Contains the service provider interfaces (SPIs) that host applications must implement in order to use the dashboard plugin(s).

See:
Description

Interface Summary

DashboardStateStore	Provides a means for looking up, updating and removing DashboardState objects to/from the persistent store.
ExternalGadgetSpecStore	Provides a means for storing, retrieving, and modifying a collection of external gadget spec URIs.
GadgetSpecUrlRenderPermission	Used to check if a gadget spec URI is allowed to render on a dashboard.
GadgetStateFactory	Constructs GadgetState instances for gadget spec URIs.
PermissionService	Provide a way to determine if a user has permission to perform the given operations.
PluginGadgetSpecProviderPermission	Used to check if a gadget spec that has been loaded from a plugin should appear in the gadget browser.

Class Summary

ExternalGadgetSpec	Models an external gadget spec, which is simply a gadget spec hosted on a web server (as opposed to an internal gadget spec which is stored inside the plugin bundle).
ExternalGadgetSpecId	Represents the unique identifier of an ExternalGadgetSpec.
GadgetLayout

Enum Summary

Vote	Votes are used in the gadget system to determine whether a user is allowed to perform certain actions, such as seeing a gadget in the gadget browser or being allowed to render a gadget on their dashboard.

Exception Summary

DashboardStateStoreException	Thrown when there is a problem while performing an operation on the persistent data store.
ExternalGadgetStoreException	Thrown when there is a problem while performing an operation on the external gadget spec URI persistent data store.

Package com.atlassian.gadgets.spi Description

Contains the service provider interfaces (SPIs) that host applications must implement in order to use the dashboard plugin(s).

The host applications are expected to provide a means of storing DashboardState by providing a component which implements the DashboardStateStore interface.

When new gadgets are being added to a dashboard, the dashboard plugin needs a way to generate GadgetState instances. It is up to the application to provide this capability by making a GadgetStateFactory component available to the dashboard-plugin.

Finally, when the dashboard is being rendered or an operation is being performed on a dashboard the plugin needs a way to determine if the user trying to view or operate on the dashboard has permission to perform the action. The host application can determine what users have permissions to which dashboards and what operations they can perform and communicates these access controls to the dashboard-plugin by implementing the PermissionService

Parameters are non-null by default, as declared by the package annotation. Return values should also be considered to be non-null unless they are annotated with Nullable. Unfortunately, there is no way to declare this with annotations at present.