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

Field Summary

Fields

Modifier and Type	Field and Description
static String	REMOTE_DISPLAY_NAME_SUFFIX

Method Summary

Modifier and Type	Method and Description
List<Application>	getAllApplications() Return list of all Application in database (unsorted) If there are not any Application in database, return an empty list
Application	getApplication(String id) Return Application with id provided
Application	getApplication(String category, String name) Return Application in specific category and have name provided in param If it can't be found, return null
List<ApplicationCategory>	getApplicationCategories() Return list of all current application categories (unsorted, all Application in all ApplicationType)
List<ApplicationCategory>	getApplicationCategories(Comparator<ApplicationCategory> sortComparator) Return list of all current application categories (sorted, all applications in all types)
List<ApplicationCategory>	getApplicationCategories(String accessUser, ApplicationType<?>... appTypes) Return list of ApplicationCatgory (and applications in each category)
ApplicationCategory	getApplicationCategory(String name) Return ApplicationCategory with name provided if not found, return null
List<Application>	getApplications(ApplicationCategory category, ApplicationType<?>... appTypes) Return list of applications (unsorted) in specific category and have specific type
List<Application>	getApplications(ApplicationCategory category, Comparator<Application> sortComparator, ApplicationType<?>... appTypes) Return list of applications (sorted) 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 will be ignored
void	initListener(org.exoplatform.container.component.ComponentPlugin com)
void	remove(Application app) Remove an Application from database If it can't be found, it will be ignored (no exception)
void	remove(ApplicationCategory category) Remove application category (and all application in it) from database If it doesn't exist, it will be ignored
void	save(ApplicationCategory category) Save an ApplicationCategory to database If it doesn't exist, a new one will be created, if not, it will be updated
void	save(ApplicationCategory category, Application application) Save Application in an ApplicationCategory If ApplicationCategory or Application don't exist, they'll be created If Application has been already existed, it will be updated
void	update(Application application) Update an Application It must be existed in database, if not, this will throw an IllegalStateException

Field Detail

REMOTE_DISPLAY_NAME_SUFFIX

static final String REMOTE_DISPLAY_NAME_SUFFIX

See Also:

Constant Field Values

Method Detail

getApplicationCategories

List<ApplicationCategory> getApplicationCategories(String accessUser,
                                                   ApplicationType<?>... appTypes)
                                            throws Exception

Return list of ApplicationCatgory (and applications in each category)

Parameters:

accessUser -

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

Throws:

Exception

initListener

void initListener(org.exoplatform.container.component.ComponentPlugin com)

getApplicationCategories

List<ApplicationCategory> getApplicationCategories()
                                            throws Exception

Return list of all current application categories (unsorted, all Application in all ApplicationType)

Throws:

Exception

getApplicationCategories

List<ApplicationCategory> getApplicationCategories(Comparator<ApplicationCategory> sortComparator)
                                            throws Exception

Return list of all current application categories (sorted, all applications in all types)

Parameters:

sortComparator - - Comparator used to sort the returned list

Throws:

Exception

getApplicationCategory

ApplicationCategory getApplicationCategory(String name)

Return ApplicationCategory with name provided
if not found, return null

Parameters:

name - - ApplicationCategory's name

save

void save(ApplicationCategory category)

Save an ApplicationCategory to database
If it doesn't exist, a new one will be created, if not, it will be updated

Parameters:

category - - ApplicationCategory object that will be saved

remove

void remove(ApplicationCategory category)

Remove application category (and all application in it) from database
If it doesn't exist, it will be ignored

Parameters:

category - - ApplicationCategory object that will be removed

getApplications

List<Application> getApplications(ApplicationCategory category,
                                  ApplicationType<?>... appTypes)
                           throws Exception

Return 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:

Exception

getApplications

List<Application> getApplications(ApplicationCategory category,
                                  Comparator<Application> sortComparator,
                                  ApplicationType<?>... appTypes)

Return 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

getAllApplications

List<Application> getAllApplications()
                              throws Exception

Return list of all Application in database (unsorted)
If there are not any Application in database, return an empty list

Throws:

Exception

getApplication

Application getApplication(String id)
                    throws Exception

Return Application with id provided

Parameters:

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

Throws:

Exception

getApplication

Application getApplication(String category,
                           String name)

Return Application in specific category and have name provided in param
If it can't be found, return null

Parameters:

category - - name of application category

name - - name of application

save

void save(ApplicationCategory category,
          Application application)

Save Application in an ApplicationCategory
If ApplicationCategory or Application don't exist, they'll be created
If Application has been already existed, it will be updated

Parameters:

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

application - - Application that will be saved

update

void update(Application application)

Update an Application
It must be existed in database, if not, this will throw an IllegalStateException

Parameters:

application - - Application that you want to update

remove

void remove(Application app)

Remove an Application from database
If it can't be found, it will be ignored (no exception)

Parameters:

app - - Application that you want to remove, must not be null

importAllPortlets

void importAllPortlets()
                throws 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:

Exception

importExoGadgets

void importExoGadgets()
               throws 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 will be ignored

Throws:

Exception