org.exoplatform.application.registry
Interface ApplicationRegistryService

All Known Implementing Classes:

ApplicationRegistryServiceImpl

public interface ApplicationRegistryService

Created y the eXo platform team User: Tuan Nguyen Date: 20 april 2007

Method Summary

void	clearAllRegistries() remove all ApplicationCategory and Application in it
java.util.List<Application>	getAllApplications() get list of all current applications
Application	getApplication(java.lang.String id) get application with id provided
Application	getApplication(java.lang.String category, java.lang.String name) get application in specific category and have name provided in param
java.util.List<ApplicationCategory>	getApplicationCategories() get list of all current application categories (unsorted)
java.util.List<ApplicationCategory>	getApplicationCategories(java.util.Comparator<ApplicationCategory> sortComparator) get list of all current application categories (sorted)
java.util.List<ApplicationCategory>	getApplicationCategories(java.lang.String accessUser, java.lang.String... appTypes) get list of application categories (and applications in each category)
ApplicationCategory	getApplicationCategory(java.lang.String name) get ApplicationCategory with name provided
java.util.List<Application>	getApplications(ApplicationCategory category, java.util.Comparator<Application> sortComparator, java.lang.String... appTypes) get list of applications (sorted) in specific category and have specific type
java.util.List<Application>	getApplications(ApplicationCategory category, java.lang.String... appTypes) get list of applications (unsorted) in specific category and have specific type
void	importAllPortlets() Get all deployed portlet, add to portlet's ApplicationCategory If ApplicationCategory currently doesn't exist, it'll be created If Application've already existed, it'll be ignored
void	importExoGadgets() Get all Gadget, add to eXoGadgets application category When first added, it's access permission will be Everyone If ApplicationCategory currently doesn't exist, it'll be created Gadget that has been imported before will be ignored
void	initListener(org.exoplatform.container.component.ComponentPlugin com)
void	remove(Application app) Remove an Application from database
void	remove(ApplicationCategory category) remove application category (and all application in it) from database
void	save(ApplicationCategory category) save an application category to database
void	save(ApplicationCategory category, Application application) Save Application in ApplicationCategory If ApplicationCategory or Application don't exist, they'll be created
void	update(Application application) Update an Application

Method Detail

getApplicationCategories

java.util.List<ApplicationCategory> getApplicationCategories(java.lang.String accessUser,
                                                             java.lang.String... appTypes)
                                                             throws java.lang.Exception

get list of application categories (and applications in each category)

Parameters:

accessUser - - username of user that his access permissions is used to filter app categories and apps

appTypes - - array of application type, used to filter applications in each application category

Throws:

java.lang.Exception

initListener

void initListener(org.exoplatform.container.component.ComponentPlugin com)
                  throws java.lang.Exception

Throws:

java.lang.Exception

getApplicationCategories

java.util.List<ApplicationCategory> getApplicationCategories()
                                                             throws java.lang.Exception

get list of all current application categories (unsorted)

Throws:

java.lang.Exception

getApplicationCategories

java.util.List<ApplicationCategory> getApplicationCategories(java.util.Comparator<ApplicationCategory> sortComparator)
                                                             throws java.lang.Exception

get list of all current application categories (sorted)

Parameters:

sortComparator - - used to sort application category list

Throws:

java.lang.Exception

getApplicationCategory

ApplicationCategory getApplicationCategory(java.lang.String name)
                                           throws java.lang.Exception

get ApplicationCategory with name provided

Parameters:

name - - ApplicationCategory's name

Throws:

java.lang.Exception

save

void save(ApplicationCategory category)
          throws java.lang.Exception

save an application category to database

Parameters:

category - - application category that will be saved

Throws:

java.lang.Exception

remove

void remove(ApplicationCategory category)
            throws java.lang.Exception

remove application category (and all application in it) from database

Parameters:

category - - application category that will be removed

Throws:

java.lang.Exception

getApplications

java.util.List<Application> getApplications(ApplicationCategory category,
                                            java.lang.String... appTypes)
                                            throws java.lang.Exception

get list of applications (unsorted) in specific category and have specific type

Parameters:

category - - ApplicationCategory that you want to list applications

appTypes - - array of application type

Throws:

java.lang.Exception

getApplications

java.util.List<Application> getApplications(ApplicationCategory category,
                                            java.util.Comparator<Application> sortComparator,
                                            java.lang.String... appTypes)
                                            throws java.lang.Exception

get list of applications (sorted) in specific category and have specific type

Parameters:

category - - ApplicationCategory that you want to list applications

sortComparator - - comparator used to sort application list

appTypes - - array of application type

Throws:

java.lang.Exception

getAllApplications

java.util.List<Application> getAllApplications()
                                               throws java.lang.Exception

get list of all current applications

Throws:

java.lang.Exception

getApplication

Application getApplication(java.lang.String id)
                           throws java.lang.Exception

get application with id provided

Parameters:

id - - must be valid applicationId (catgoryname/applicationName), if not, this will throw exception

Throws:

java.lang.Exception

getApplication

Application getApplication(java.lang.String category,
                           java.lang.String name)
                           throws java.lang.Exception

get application in specific category and have name provided in param

Parameters:

category - - name of application category

name - - name of application

Throws:

java.lang.Exception

save

void save(ApplicationCategory category,
          Application application)
          throws java.lang.Exception

Save Application in ApplicationCategory If ApplicationCategory or Application don't exist, they'll be created

Parameters:

category - - ApplicationCategory that your application'll be saved to

application - - Application that will be saved

Throws:

java.lang.Exception

update

void update(Application application)
            throws java.lang.Exception

Update an Application

Parameters:

application - - Application that you want to update

Throws:

java.lang.Exception

remove

void remove(Application app)
            throws java.lang.Exception

Remove an Application from database

Parameters:

app - - Application that you want to remove

Throws:

java.lang.Exception

importAllPortlets

void importAllPortlets()
                       throws java.lang.Exception

Get all deployed portlet, add to portlet's ApplicationCategory If ApplicationCategory currently doesn't exist, it'll be created If Application've already existed, it'll be ignored

Throws:

java.lang.Exception

importExoGadgets

void importExoGadgets()
                      throws java.lang.Exception

Get all Gadget, add to eXoGadgets application category When first added, it's access permission will be Everyone If ApplicationCategory currently doesn't exist, it'll be created Gadget that has been imported before will be ignored

Throws:

java.lang.Exception

clearAllRegistries

void clearAllRegistries()
                        throws java.lang.Exception

remove all ApplicationCategory and Application in it

Throws:

java.lang.Exception