org.exoplatform.services.cms.views.impl

Class ApplicationTemplateManagerServiceImpl

java.lang.Object

org.exoplatform.services.cms.views.impl.ApplicationTemplateManagerServiceImpl

All Implemented Interfaces:

ApplicationTemplateManagerService, org.picocontainer.Startable

public class ApplicationTemplateManagerServiceImpl
extends Object
implements ApplicationTemplateManagerService, org.picocontainer.Startable

Created by The eXo Platform SAS Author : Hoa Pham hoa.phamvu@exoplatform.com Oct 15, 2008

Field Summary

Fields

Modifier and Type	Field and Description
static String	EDITED_CONFIGURED_TEMPLATES

Fields inherited from interface org.exoplatform.services.cms.views.ApplicationTemplateManagerService

CLV_LIST_TEMPLATE_CATEGORY, CLV_NAVIGATION_TEMPLATE_CATEGORY, CLV_PAGINATOR_TEMPLATE_CATEGORY, CLV_TEMPLATE_STORAGE_FOLDER

Constructor Summary

Constructors

Constructor and Description
ApplicationTemplateManagerServiceImpl(org.exoplatform.services.jcr.RepositoryService repositoryService, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator hierarchyCreator, DMSConfiguration dmsConfiguration) Instantiates a new application template manager service impl.

Method Summary

Modifier and Type	Method and Description
void	addPlugin(PortletTemplatePlugin portletTemplatePlugin) Adds a plugin.
void	addTemplate(javax.jcr.Node portletTemplateHome, PortletTemplatePlugin.PortletTemplateConfig config) Adds a template to the portlet template home.
List<String>	getAllManagedPortletName(String repository) Gets all portlet names that have dynamic Groovy templates managed by the service.
javax.jcr.Node	getApplicationTemplateHome(String portletName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Gets the application template home.
Set<String>	getConfiguredAppTemplateMap(String portletName) Gets all configured templates of a given portlet.
javax.jcr.Node	getTemplateByName(String portletName, String category, String templateName, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) Gets a template by its name under a given category.
javax.jcr.Node	getTemplateByPath(String templatePath, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) Gets a template by its path under a given category.
List<javax.jcr.Node>	getTemplatesByCategory(String portletName, String category, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) Gets templates under a given category.
void	removeTemplate(String portletName, String category, String templateName, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) Removes a template from a given portlet.
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

EDITED_CONFIGURED_TEMPLATES

public static final String EDITED_CONFIGURED_TEMPLATES

See Also:

Constant Field Values

Constructor Detail

ApplicationTemplateManagerServiceImpl

public ApplicationTemplateManagerServiceImpl(org.exoplatform.services.jcr.RepositoryService repositoryService,
                                             org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator hierarchyCreator,
                                             DMSConfiguration dmsConfiguration)
                                      throws Exception

Instantiates a new application template manager service impl.

Parameters:

repositoryService - RepositoryService

hierarchyCreator - NodeHierarchyCreator

dmsConfiguration - DMSConfiguration

Throws:

Exception - the exception

See Also:

RepositoryService, NodeHierarchyCreator, DMSConfiguration

Method Detail

addPlugin

public void addPlugin(PortletTemplatePlugin portletTemplatePlugin)
               throws Exception

Adds a plugin.

Specified by:

addPlugin in interface ApplicationTemplateManagerService

Parameters:

portletTemplatePlugin - The portlet template plugin to be added.

Throws:

Exception - The exception

addTemplate

public void addTemplate(javax.jcr.Node portletTemplateHome,
                        PortletTemplatePlugin.PortletTemplateConfig config)
                 throws Exception

Adds a template to the portlet template home.

Specified by:

addTemplate in interface ApplicationTemplateManagerService

Parameters:

portletTemplateHome - The portlet template home.

config - Configuration of the portlet template.

Throws:

Exception - The exception

getApplicationTemplateHome

public javax.jcr.Node getApplicationTemplateHome(String portletName,
                                                 org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                          throws Exception

Gets the application template home.

Specified by:

getApplicationTemplateHome in interface ApplicationTemplateManagerService

Parameters:

portletName - Name of the portlet.

provider - The session provider.

Returns:

The application template home.

Throws:

Exception - The exception

getAllManagedPortletName

public List<String> getAllManagedPortletName(String repository)
                                      throws Exception

Gets all portlet names that have dynamic Groovy templates managed by the service.

Specified by:

getAllManagedPortletName in interface ApplicationTemplateManagerService

Parameters:

repository - Name of the repository.

Returns:

All managed portlet names.

Throws:

Exception - The exception

getTemplateByName

public javax.jcr.Node getTemplateByName(String portletName,
                                        String category,
                                        String templateName,
                                        org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
                                 throws Exception

Gets a template by its name under a given category.

Specified by:

getTemplateByName in interface ApplicationTemplateManagerService

Parameters:

portletName - Name of the portet that contains the given category.

category - The given category.

templateName - Name of the template.

sessionProvider - The session provider.

Returns:

The template.

Throws:

Exception - The exception

getTemplatesByCategory

public List<javax.jcr.Node> getTemplatesByCategory(String portletName,
                                                   String category,
                                                   org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
                                            throws Exception

Gets templates under a given category.

Specified by:

getTemplatesByCategory in interface ApplicationTemplateManagerService

Parameters:

portletName - Name of the portet that contains the given category.

category - The given category.

sessionProvider - The session provider.

Returns:

The templates.

Throws:

Exception - The exception

getTemplateByPath

public javax.jcr.Node getTemplateByPath(String templatePath,
                                        org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
                                 throws Exception

Gets a template by its path under a given category.

Specified by:

getTemplateByPath in interface ApplicationTemplateManagerService

Parameters:

templatePath - Path of the template.

sessionProvider - The session provider.

Returns:

The template.

Throws:

Exception - The exception

removeTemplate

public void removeTemplate(String portletName,
                           String category,
                           String templateName,
                           org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
                    throws Exception

Removes a template from a given portlet.

Specified by:

removeTemplate in interface ApplicationTemplateManagerService

Parameters:

portletName - Name of the given portlet.

category - Category of the template which needs to be removed.

templateName - Name of the removed template.

sessionProvider - The session provider.

Throws:

Exception - The exception

start

public void start()

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable

getConfiguredAppTemplateMap

public Set<String> getConfiguredAppTemplateMap(String portletName)

Description copied from interface: ApplicationTemplateManagerService

Gets all configured templates of a given portlet.

Specified by:

getConfiguredAppTemplateMap in interface ApplicationTemplateManagerService

Parameters:

portletName - Name of the given portlet.

Returns:

Set of configured templates.