org.exoplatform.application.gadget

Interface GadgetRegistryService

All Known Implementing Classes:

GadgetRegistryServiceImpl

public interface GadgetRegistryService

This service is used to register the gadget with portal. Developer uses this service to manage list of gadgets.

Created by The eXo Platform SAS
Jun 18, 2008

Method Summary

Modifier and Type	Method and Description
void	deploy(Iterable<GadgetImporter> gadgets) Deploy a set of gadgets.
List<Gadget>	getAllGadgets() Gets all of available gadgets from the database.
List<Gadget>	getAllGadgets(Comparator<Gadget> sortComparator) Gets all of available gadgets from the database. The list of gadgets are sorted.
String	getCountry() Return Country name, it's set in xml config of GadgetRegistryService
Gadget	getGadget(String name) Return Gadget object retrieved from database by its name.
String	getGadgetURL(String gadgetName) Get the URL of gadget from gadget definition.
String	getHostName()
String	getLanguage()
String	getModuleId()
boolean	isGadgetDeveloper(String username) Always return true
void	removeGadget(String name) Removes the gadget from the database.
void	saveGadget(Gadget gadget) Adds the gadget to the database.

Method Detail

deploy

void deploy(Iterable<GadgetImporter> gadgets)

Deploy a set of gadgets.

Parameters:

gadgets - the gadgets to deploy

getGadget

Gadget getGadget(String name)

Return Gadget object retrieved from database by its name.

Parameters:

name - the name of gadget

Returns:

Gadget object or null if not found

getAllGadgets

List<Gadget> getAllGadgets()
                    throws Exception

Gets all of available gadgets from the database.

Returns:

a list of gadgets

Throws:

Exception

getAllGadgets

List<Gadget> getAllGadgets(Comparator<Gadget> sortComparator)

Gets all of available gadgets from the database.
The list of gadgets are sorted.

Parameters:

sortComparator - The comparator is used to control the order of gadgets

Returns:

a list of gadgets

saveGadget

void saveGadget(Gadget gadget)
         throws Exception

Adds the gadget to the database. If the gadget is existing, it will be updated.

Parameters:

gadget - - Gadget that is saved to database, must not be null

Throws:

Exception

removeGadget

void removeGadget(String name)

Removes the gadget from the database. If can't find Gadget with that name in database, this will throw Exception

Parameters:

name - the name of gadget

isGadgetDeveloper

boolean isGadgetDeveloper(String username)

Always return true

Parameters:

username -

getCountry

String getCountry()

Return Country name, it's set in xml config of GadgetRegistryService

getLanguage

String getLanguage()

getModuleId

String getModuleId()

getHostName

String getHostName()

getGadgetURL

String getGadgetURL(String gadgetName)

Get the URL of gadget from gadget definition. There are 2 kind of gadget:

• Local gadget: Gadget definition and resource are stored in JCR workspace. This gadget content can be also accessed by WebDAV
• Remote gadget: An absolute link to gadget definition

Parameters:

gadgetName -

Returns:

link to local gadget definition stored in JCR or URL to remote gadget