Package org.exoplatform.portal.config

Class NewPortalConfigListener

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.portal.config.NewPortalConfigListener

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

public class NewPortalConfigListener
extends org.exoplatform.container.component.BaseComponentPlugin

Created by The eXo Platform SARL Author : Tuan Nguyen tuan08@users.sourceforge.net May 22, 2006

Field Summary

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor

Description

NewPortalConfigListener(UserPortalConfigService owner, org.exoplatform.portal.mop.service.LayoutService layoutService, org.exoplatform.container.configuration.ConfigurationManager cmanager, org.exoplatform.container.xml.InitParams params, org.exoplatform.portal.mop.service.NavigationService navigationService, org.exoplatform.portal.mop.storage.DescriptionStorage descriptionStorage, UserACL userACL, org.exoplatform.services.resources.LocaleConfigService localeConfigService)

Method Summary

Modifier and Type	Method	Description
void	createPage(NewPortalConfig config, String owner)
org.exoplatform.portal.config.model.Page	createPageFromTemplate(String ownerType, String owner, String temp)
void	createPageNavigation(NewPortalConfig config, String owner)
boolean	createPortalConfig(NewPortalConfig config, String owner)
void	deleteListenerElements(NewPortalConfigListener other)	This is used to delete an already loaded NewPortalConfigListener(s)
<T> T	getConfig(String portalType, String portalName, Class<T> objectType, String parentLocation)
<T> org.exoplatform.portal.config.model.UnmarshalledObject<T>	getConfig(String portalType, String portalName, Class<T> objectType, String fileName, String parentLocation)
<T> org.exoplatform.portal.config.model.UnmarshalledObject<T>	getConfig(String portalType, String portalName, Class<T> objectType, String fileName, String parentLocation, String templateName)
<T> org.exoplatform.portal.config.model.UnmarshalledObject<T>	getConfig(String portalName, String portalType, Class<T> objectType, String parentLocation, List<String> relativePaths)
<T> org.exoplatform.portal.config.model.UnmarshalledObject<T>	getConfig(NewPortalConfig config, String portalName, String fileName, Class<T> objectType)	Best effort to load and unmarshall a configuration.
org.exoplatform.portal.config.model.PortalConfig	getPortalConfigFromTemplate(String siteType, String templateName)	Get detail configuration from a template file
String	getTemplateConfig(String type, String name)
Set<String>	getTemplateConfigs(String siteType)	Get all template configurations
void	initPageDB(NewPortalConfig config)
void	initPageNavigationDB(NewPortalConfig config)
void	initPortalConfigDB(NewPortalConfig config)
void	mergePlugin(NewPortalConfigListener other)	This is used to merge an other NewPortalConfigListener to this one
void	reloadConfig(String ownerType, String predefinedOwner, String location, String importMode, boolean overrideMode)
void	run()

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Details

NewPortalConfigListener

public NewPortalConfigListener(UserPortalConfigService owner,
 org.exoplatform.portal.mop.service.LayoutService layoutService,
 org.exoplatform.container.configuration.ConfigurationManager cmanager,
 org.exoplatform.container.xml.InitParams params,
 org.exoplatform.portal.mop.service.NavigationService navigationService,
 org.exoplatform.portal.mop.storage.DescriptionStorage descriptionStorage,
 UserACL userACL,
 org.exoplatform.services.resources.LocaleConfigService localeConfigService)

Method Details

run

public void run()
         throws Exception

Throws:

Exception

mergePlugin

public void mergePlugin(NewPortalConfigListener other)

This is used to merge an other NewPortalConfigListener to this one

Parameters:

other -

deleteListenerElements

public void deleteListenerElements(NewPortalConfigListener other)

This is used to delete an already loaded NewPortalConfigListener(s)

Parameters:

other -

initPortalConfigDB

public void initPortalConfigDB(NewPortalConfig config)
                        throws Exception

Throws:

Exception

initPageDB

public void initPageDB(NewPortalConfig config)
                throws Exception

Throws:

Exception

initPageNavigationDB

public void initPageNavigationDB(NewPortalConfig config)
                          throws Exception

Throws:

Exception

createPortalConfig

public boolean createPortalConfig(NewPortalConfig config,
 String owner)
                           throws Exception

Throws:

Exception

createPage

public void createPage(NewPortalConfig config,
 String owner)
                throws Exception

Throws:

Exception

createPageNavigation

public void createPageNavigation(NewPortalConfig config,
 String owner)
                          throws Exception

Throws:

Exception

getConfig

public <T>
org.exoplatform.portal.config.model.UnmarshalledObject<T> getConfig(NewPortalConfig config,
 String portalName,
 String fileName,
 Class<T> objectType)
                                                             throws Exception

Best effort to load and unmarshall a configuration.

Type Parameters:

T - the generic type to unmarshall to

Parameters:

config - the config object

portalName - the owner

fileName - the file name

objectType - the type to unmarshall to

Returns:

the xml of the config or null

Throws:

Exception - any exception

getConfig

public <T> T getConfig(String portalType,
 String portalName,
 Class<T> objectType,
 String parentLocation)

getConfig

public <T>
org.exoplatform.portal.config.model.UnmarshalledObject<T> getConfig(String portalType,
 String portalName,
 Class<T> objectType,
 String fileName,
 String parentLocation)

getConfig

public <T>
org.exoplatform.portal.config.model.UnmarshalledObject<T> getConfig(String portalType,
 String portalName,
 Class<T> objectType,
 String fileName,
 String parentLocation,
 String templateName)

getConfig

public <T>
org.exoplatform.portal.config.model.UnmarshalledObject<T> getConfig(String portalName,
 String portalType,
 Class<T> objectType,
 String parentLocation,
 List<String> relativePaths)

createPageFromTemplate

public org.exoplatform.portal.config.model.Page createPageFromTemplate(String ownerType,
 String owner,
 String temp)
                                                                throws Exception

Throws:

Exception

getTemplateConfig

public String getTemplateConfig(String type,
 String name)

getTemplateConfigs

public Set<String> getTemplateConfigs(String siteType)

Get all template configurations

Parameters:

siteType - (portal, group, user)

Returns:

set of template name

getPortalConfigFromTemplate

public org.exoplatform.portal.config.model.PortalConfig getPortalConfigFromTemplate(String siteType,
 String templateName)

Get detail configuration from a template file

Parameters:

siteType - (portal, group, user)

templateName - name of template

Returns:

PortalConfig object

reloadConfig

public void reloadConfig(String ownerType,
 String predefinedOwner,
 String location,
 String importMode,
 boolean overrideMode)