Summary: Methods | [Expand All]
public interface

ExternalGadgetStore

com.atlassian.jira.portal.gadgets.ExternalGadgetStore
Known Indirect Subclasses

Class Overview

Provides storage mechanism for gadgets whitelisted by an admin in JIRA.

Summary

Public Methods
ExternalGadgetSpec addGadgetSpecUri(URI uri)
Adds the URI specified to the whitelist.
boolean containsSpecUri(URI uri)
Checks if the specified URI is already contained in the store
Set<ExternalGadgetSpec> getAllGadgetSpecUris()
Retrieves a set of all external gadgets whitelisted in the directory.
void removeGadgetSpecUri(ExternalGadgetSpecId id)
Removes the URI specified from the whitelist.

Public Methods

public ExternalGadgetSpec addGadgetSpecUri (URI uri)

Adds the URI specified to the whitelist.

Parameters
uri The gadget URI to add
Returns
  • The newly created ExternalGAdgetSpec
Throws
IllegalStateException if the store already contains the uri specified

public boolean containsSpecUri (URI uri)

Checks if the specified URI is already contained in the store

Parameters
uri the URI to check for
Returns
  • true if the URI already exists in the store

public Set<ExternalGadgetSpec> getAllGadgetSpecUris ()

Retrieves a set of all external gadgets whitelisted in the directory.

Returns
  • a set of all external gadgets whitelisted in the directory.

public void removeGadgetSpecUri (ExternalGadgetSpecId id)

Removes the URI specified from the whitelist.

Parameters
id The id to remove