com.atlassian.jira.portal.gadgets
Interface ExternalGadgetStore

All Known Implementing Classes:
CachingExternalGadgetStore, OfbizExternalGadgetStore

public interface ExternalGadgetStore

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

Since:
v4.0

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

Method Detail

getAllGadgetSpecUris

java.util.Set<com.atlassian.gadgets.spi.ExternalGadgetSpec> getAllGadgetSpecUris()
Retrieves a set of all external gadgets whitelisted in the directory.

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

addGadgetSpecUri

com.atlassian.gadgets.spi.ExternalGadgetSpec addGadgetSpecUri(java.net.URI uri)
Adds the URI specified to the whitelist.

Parameters:
uri - The gadget URI to add
Returns:
The newly created ExternalGAdgetSpec
Throws:
java.lang.IllegalStateException - if the store already contains the uri specified

removeGadgetSpecUri

void removeGadgetSpecUri(com.atlassian.gadgets.spi.ExternalGadgetSpecId id)
Removes the URI specified from the whitelist.

Parameters:
id - The id to remove

containsSpecUri

boolean containsSpecUri(java.net.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


Copyright © 2002-2010 Atlassian. All Rights Reserved.