org.nuxeo.opensocial.gadgets.service

Class GadgetServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.opensocial.gadgets.service.GadgetServiceImpl

All Implemented Interfaces:

GadgetService, Adaptable, Component, Extensible, TimestampedService

public class GadgetServiceImpl
extends DefaultComponent
implements GadgetService

Field Summary

Fields

Modifier and Type	Field and Description
static String	GADGET_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
GadgetServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
GadgetDeclaration	getGadget(String name) Return a gadget declaration
List<String>	getGadgetCategory() Returns the list of gadget categories
URL	getGadgetDefinition(String gadgetName) Returns a URL to the gadget definition
List<GadgetDeclaration>	getGadgetList() Returns the list of all registered gadgets declarations
List<GadgetDeclaration>	getGadgetList(String category) Returns the list of the registered gadgets for a given category
HashMap<String,ArrayList<String>>	getGadgetNameByCategory() Return a hashed map of all registered gadgets by category TODO: check if this is necessary in the API (perhaps a GWT tweak)
InputStream	getGadgetResource(String gadgetName, String resourcePath) Returns a stream on a resource of a gadget
org.apache.shindig.gadgets.spec.GadgetSpec	getGadgetSpec(GadgetDeclaration declaration) Return the parsed Gadget Spec (may require an http fetch)
org.apache.shindig.gadgets.spec.GadgetSpec	getGadgetSpec(String name) Return the parsed Gadget Spec (may require an http fetch)
String	getIconUrl(String gadgetName) Returns a relative URL to the gadget icon
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	registerNewGadget(GadgetDeclaration gadget)
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterExtension

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GADGET_DIRECTORY

public static final String GADGET_DIRECTORY

See Also:

Constant Field Values

Constructor Detail

GadgetServiceImpl

public GadgetServiceImpl()

Method Detail

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
                          String extensionPoint,
                          ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

registerNewGadget

public void registerNewGadget(GadgetDeclaration gadget)

getGadget

public GadgetDeclaration getGadget(String name)

Description copied from interface: GadgetService

Return a gadget declaration

Specified by:

getGadget in interface GadgetService

Parameters:

name - the symbolic name of the gadget

getGadgetResource

public InputStream getGadgetResource(String gadgetName,
                            String resourcePath)
                              throws IOException

Description copied from interface: GadgetService

Returns a stream on a resource of a gadget

Specified by:

getGadgetResource in interface GadgetService

Parameters:

gadgetName - the symbolic name of the gadget

resourcePath - the relative path to the resources

Throws:

IOException

getGadgetSpec

public org.apache.shindig.gadgets.spec.GadgetSpec getGadgetSpec(String name)
                                                         throws IOException,
                                                                org.apache.shindig.gadgets.GadgetException

Description copied from interface: GadgetService

Return the parsed Gadget Spec (may require an http fetch)

Specified by:

getGadgetSpec in interface GadgetService

Parameters:

name - the gadget symbolic name

Returns:

Throws:

IOException

org.apache.shindig.gadgets.GadgetException

getGadgetSpec

public org.apache.shindig.gadgets.spec.GadgetSpec getGadgetSpec(GadgetDeclaration declaration)
                                                         throws IOException,
                                                                org.apache.shindig.gadgets.GadgetException

Description copied from interface: GadgetService

Return the parsed Gadget Spec (may require an http fetch)

Specified by:

getGadgetSpec in interface GadgetService

Returns:

Throws:

IOException

org.apache.shindig.gadgets.GadgetException

getGadgetList

public List<GadgetDeclaration> getGadgetList()

Description copied from interface: GadgetService

Returns the list of all registered gadgets declarations

Specified by:

getGadgetList in interface GadgetService

getGadgetList

public List<GadgetDeclaration> getGadgetList(String category)

Description copied from interface: GadgetService

Returns the list of the registered gadgets for a given category

Specified by:

getGadgetList in interface GadgetService

Parameters:

category - the category

getGadgetNameByCategory

public HashMap<String,ArrayList<String>> getGadgetNameByCategory()

Description copied from interface: GadgetService

Return a hashed map of all registered gadgets by category TODO: check if this is necessary in the API (perhaps a GWT tweak)

Specified by:

getGadgetNameByCategory in interface GadgetService

getGadgetDefinition

public URL getGadgetDefinition(String gadgetName)

Description copied from interface: GadgetService

Returns a URL to the gadget definition

Specified by:

getGadgetDefinition in interface GadgetService

Parameters:

gadgetName - the gadget symbolic name

getGadgetCategory

public List<String> getGadgetCategory()

Description copied from interface: GadgetService

Returns the list of gadget categories

Specified by:

getGadgetCategory in interface GadgetService

getIconUrl

public String getIconUrl(String gadgetName)

Description copied from interface: GadgetService

Returns a relative URL to the gadget icon

Specified by:

getIconUrl in interface GadgetService

Parameters:

gadgetName - the gadget symbolic name