com.atlassian.gadgets.directory.internal.impl
Class PluginExternalGadgetSpecDirectoryEntryProvider

java.lang.Object
  com.atlassian.gadgets.directory.internal.impl.AbstractDirectoryEntryProvider<URI>
      com.atlassian.gadgets.directory.internal.impl.PluginExternalGadgetSpecDirectoryEntryProvider

All Implemented Interfaces:

DirectoryEntryProvider, com.atlassian.gadgets.plugins.PluginGadgetSpecEventListener, org.springframework.beans.factory.DisposableBean

public class PluginExternalGadgetSpecDirectoryEntryProvider
extends AbstractDirectoryEntryProvider<URI>
implements com.atlassian.gadgets.plugins.PluginGadgetSpecEventListener

A DirectoryEntryProvider for external gadget specs provided by plugins.

Constructor Summary

PluginExternalGadgetSpecDirectoryEntryProvider(com.atlassian.gadgets.spec.GadgetSpecFactory gadgetSpecFactory, com.atlassian.sal.api.executor.ThreadLocalDelegateExecutorFactory threadLocalDelegateExecutorFactory)
Creates a new instance that uses the specified GadgetSpecFactory to retrieve and parse gadget specs.

Method Summary

boolean	contains(URI gadgetSpecUri)
protected com.google.common.base.Function<URI,com.atlassian.gadgets.directory.Directory.Entry>	convertToLocalizedDirectoryEntry(com.atlassian.gadgets.GadgetRequestContext gadgetRequestContext)
protected Iterable<URI>	internalEntries()
void	pluginGadgetSpecDisabled(com.atlassian.gadgets.plugins.PluginGadgetSpec pluginGadgetSpec)
void	pluginGadgetSpecEnabled(com.atlassian.gadgets.plugins.PluginGadgetSpec pluginGadgetSpec)
String	toString()

Methods inherited from class com.atlassian.gadgets.directory.internal.impl.AbstractDirectoryEntryProvider

destroy, entries, getGadgetSpec

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PluginExternalGadgetSpecDirectoryEntryProvider

public PluginExternalGadgetSpecDirectoryEntryProvider(com.atlassian.gadgets.spec.GadgetSpecFactory gadgetSpecFactory,
                                                      com.atlassian.sal.api.executor.ThreadLocalDelegateExecutorFactory threadLocalDelegateExecutorFactory)

Creates a new instance that uses the specified GadgetSpecFactory to retrieve and parse gadget specs.

Parameters:

gadgetSpecFactory - the GadgetSpecFactory to use to retrieve and parse gadget specs. Must not be null or a NullPointerException will be thrown.

Method Detail

contains

public boolean contains(URI gadgetSpecUri)

Specified by:

contains in interface DirectoryEntryProvider

Parameters:

gadgetSpecUri - uri of the gadget spec to check if it's in the directory

Returns:

true if the gadget spec at the location specificied by the uri is in the directory, false otherwise

pluginGadgetSpecEnabled

public void pluginGadgetSpecEnabled(com.atlassian.gadgets.plugins.PluginGadgetSpec pluginGadgetSpec)
                             throws com.atlassian.gadgets.GadgetParsingException

Specified by:

pluginGadgetSpecEnabled in interface com.atlassian.gadgets.plugins.PluginGadgetSpecEventListener

Throws:

com.atlassian.gadgets.GadgetParsingException

pluginGadgetSpecDisabled

public void pluginGadgetSpecDisabled(com.atlassian.gadgets.plugins.PluginGadgetSpec pluginGadgetSpec)

Specified by:

pluginGadgetSpecDisabled in interface com.atlassian.gadgets.plugins.PluginGadgetSpecEventListener

internalEntries

protected Iterable<URI> internalEntries()

Specified by:

internalEntries in class AbstractDirectoryEntryProvider<URI>

convertToLocalizedDirectoryEntry

protected com.google.common.base.Function<URI,com.atlassian.gadgets.directory.Directory.Entry> convertToLocalizedDirectoryEntry(com.atlassian.gadgets.GadgetRequestContext gadgetRequestContext)

Specified by:

convertToLocalizedDirectoryEntry in class AbstractDirectoryEntryProvider<URI>

toString

public String toString()

Overrides:

toString in class Object