org.exoplatform.services.cms.templates.impl

Class TemplateServiceImpl

java.lang.Object

org.exoplatform.services.cms.templates.impl.TemplateServiceImpl

All Implemented Interfaces:

TemplateService, org.picocontainer.Startable

public class TemplateServiceImpl
extends Object
implements TemplateService, org.picocontainer.Startable

Author:

benjaminmestrallet

Field Summary

Fields inherited from interface org.exoplatform.services.cms.templates.TemplateService

DEFAULT_DIALOG, DEFAULT_DIALOGS_PATH, DEFAULT_SKIN, DEFAULT_VIEW, DEFAULT_VIEWS_PATH, DIALOGS, DOCUMENT_TEMPLATE_PROP, LTR, NT_UNSTRUCTURED, RTL, SKINS, TEMPLATE_LABEL, UNDELETABLE_TEMPLATES, VIEWS

Constructor Summary

Constructors

Constructor and Description

TemplateServiceImpl(org.exoplatform.services.jcr.RepositoryService jcrService, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, org.exoplatform.services.security.IdentityRegistry identityRegistry, org.exoplatform.groovyscript.text.TemplateService templateService, DMSConfiguration dmsConfiguration, org.exoplatform.services.resources.LocaleConfigService localeConfigService, org.exoplatform.services.cache.CacheService caService) Constructor method.

Method Summary

Modifier and Type	Method and Description
void	addContentTypeFilterPlugin(ContentTypeFilterPlugin filterPlugin) This method is used to filter types of NodeType which is added in folder.
String	addTemplate(String templateType, String nodeTypeName, String label, boolean isDocumentTemplate, String templateName, String[] roles, InputStream templateFile) Insert a new template into NodeType by giving the following parameters.
String	addTemplate(String templateType, String nodeTypeName, String label, boolean isDocumentTemplate, String templateName, String[] roles, InputStream templateFile, javax.jcr.Node templatesHome) Insert a new template into NodeType by giving the following parameters.
void	addTemplates(org.exoplatform.container.component.ComponentPlugin plugin)
String	buildDialogForm(String nodeTypeName) Build string of dialog form template base on properties of nodetype.
String	buildStyleSheet(String nodeTypeName) Build string of view template form base on properties of nodetype.
String	buildViewForm(String nodeTypeName) Build string of view template form base on properties of nodetype.
String	createTemplate(javax.jcr.Node templateFolder, String name, InputStream data, String[] roles) Deprecated.
String	createTemplate(javax.jcr.Node templateFolder, String title, String templateName, InputStream data, String[] roles) Insert a template into JCR database as an nt:file node.
Set<String>	getAllConfiguredNodeTypes() gets all node types configured
List<String>	getAllDocumentNodeTypes() Get All Document NodeTypes of the current repository.
Set<String>	getAllEditedConfiguredNodeTypes() Gets all node types configured whose templates were edited.
Set<String>	getAllowanceFolderType() Get set of folder type.
javax.jcr.NodeIterator	getAllTemplatesOfNodeType(boolean isDialog, String nodeTypeName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Return all teamplate of the specified NodeType.
List<String>	getCreationableContentTypes(javax.jcr.Node node) Return CreationableContent Types to the given node.
String	getDefaultTemplatePath(boolean isDialog, String nodeTypeName) Return path of default template by giving the following parameters.
List<String>	getDocumentTemplates() Get all templates is document type of the specified repository.
String	getSkinPath(String nodeTypeName, String skinName, String locale) Get path of css file which included in view template.
String	getTemplate(javax.jcr.Node template) Get a template from JCR database.
String	getTemplate(String type, String nodeTypeName, String templateName) Return template file of the specified node.
String	getTemplateLabel(String nodeTypeName) Return the label of the specified template by giving the following parameters.
javax.jcr.Node	getTemplateNode(String type, String nodeTypeName, String templateName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Return template Node (Name of NodeType, Name of Template) by giving the following parameters.
String	getTemplatePath(boolean isDialog, String nodeTypeName, String templateName) Return path template of the specified node.
String	getTemplatePath(javax.jcr.Node node, boolean isDialog) Return path template of the specified node.
String	getTemplatePathByAnonymous(boolean isDialog, String nodeTypeName) Return the path public template.
String	getTemplatePathByUser(boolean isDialog, String nodeTypeName, String userName) Return the template by user.
String	getTemplateRoles(javax.jcr.Node template) Get roles from a template.
javax.jcr.Node	getTemplatesHome(org.exoplatform.services.jcr.ext.common.SessionProvider provider) Return template home of current repository.
void	init() Get all template that is configured in XML file of current repository.
boolean	isChildNodePrimaryTypeAllowed(javax.jcr.Node parent, String childNodeTypeName)
boolean	isManagedNodeType(String nodeTypeName) Return true if the given repository has document type named 'nodeTypeName'.
void	removeAllTemplateCached() Remove all templates cached.
void	removeCacheTemplate(String name) Remove cache of template.
void	removeManagedNodeType(String nodeTypeName) Removes the NodeType by giving the name of NodeType.
void	removeTemplate(String type, String nodeTypeName, String templateName) Remove a template of NodeType by giving the following parameters.
void	start()
void	stop()
String	updateTemplate(javax.jcr.Node template, InputStream data, String[] roles) Update a template inside JCR database.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateServiceImpl

public TemplateServiceImpl(org.exoplatform.services.jcr.RepositoryService jcrService,
                           org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator,
                           org.exoplatform.services.security.IdentityRegistry identityRegistry,
                           org.exoplatform.groovyscript.text.TemplateService templateService,
                           DMSConfiguration dmsConfiguration,
                           org.exoplatform.services.resources.LocaleConfigService localeConfigService,
                           org.exoplatform.services.cache.CacheService caService)
                    throws Exception

Constructor method. Init jcrService, nodeHierarchyCreator, identityRegistry, localeConfigService, caService, dmsConfiguration

Parameters:

jcrService - RepositoryService

nodeHierarchyCreator - NodeHierarchyCreator

identityRegistry - IdentityRegistry

localeConfigService - LocaleConfigService

caService - CacheService

dmsConfiguration - DMSConfiguration

Throws:

Exception

Method Detail

start

public void start()

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable

addContentTypeFilterPlugin

public void addContentTypeFilterPlugin(ContentTypeFilterPlugin filterPlugin)

This method is used to filter types of NodeType which is added in folder.

Specified by:

addContentTypeFilterPlugin in interface TemplateService

Parameters:

filterPlugin - Content filer plugin

getAllowanceFolderType

public Set<String> getAllowanceFolderType()

Get set of folder type.

Specified by:

getAllowanceFolderType in interface TemplateService

addTemplates

public void addTemplates(org.exoplatform.container.component.ComponentPlugin plugin)

init

public void init()
          throws Exception

Get all template that is configured in XML file of current repository.

Specified by:

init in interface TemplateService

Throws:

Exception

See Also:

TemplatePlugin

getTemplatesHome

public javax.jcr.Node getTemplatesHome(org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                throws Exception

Return template home of current repository.

Specified by:

getTemplatesHome in interface TemplateService

Parameters:

provider - SessionProvider The SessionProvider object is used to managed Sessions

Throws:

Exception

See Also:

Node

getCreationableContentTypes

public List<String> getCreationableContentTypes(javax.jcr.Node node)
                                         throws Exception

Return CreationableContent Types to the given node.

Specified by:

getCreationableContentTypes in interface TemplateService

Parameters:

node - The specified node

Throws:

Exception

See Also:

Node

isChildNodePrimaryTypeAllowed

public boolean isChildNodePrimaryTypeAllowed(javax.jcr.Node parent,
                                             String childNodeTypeName)
                                      throws Exception

Throws:

Exception

isManagedNodeType

public boolean isManagedNodeType(String nodeTypeName)
                          throws javax.jcr.RepositoryException

Return true if the given repository has document type named 'nodeTypeName'.

Specified by:

isManagedNodeType in interface TemplateService

Parameters:

nodeTypeName - String The name of NodeType

Throws:

javax.jcr.RepositoryException

See Also:

SessionProvider, Session, Node

getTemplatePath

public String getTemplatePath(javax.jcr.Node node,
                              boolean isDialog)
                       throws Exception

Return path template of the specified node.

Specified by:

getTemplatePath in interface TemplateService

Parameters:

node - Node The specified node

isDialog - boolean The boolean value which specify the type of template

Throws:

Exception

See Also:

Node

getAllTemplatesOfNodeType

public javax.jcr.NodeIterator getAllTemplatesOfNodeType(boolean isDialog,
                                                        String nodeTypeName,
                                                        org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                                 throws Exception

Return all teamplate of the specified NodeType.

Specified by:

getAllTemplatesOfNodeType in interface TemplateService

Parameters:

isDialog - boolean The boolean value which specify the type of template

nodeTypeName - String The name of NodeType

provider - SessionProvider The SessionProvider object is used to managed Sessions

Throws:

Exception

See Also:

SessionProvider, Node

getDefaultTemplatePath

public String getDefaultTemplatePath(boolean isDialog,
                                     String nodeTypeName)

Return path of default template by giving the following parameters.

Specified by:

getDefaultTemplatePath in interface TemplateService

Parameters:

isDialog - boolean The boolean value which specify the type of template

nodeTypeName - String The name of NodeType

getTemplateNode

public javax.jcr.Node getTemplateNode(String type,
                                      String nodeTypeName,
                                      String templateName,
                                      org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                               throws Exception

Return template Node (Name of NodeType, Name of Template) by giving the following parameters.

Specified by:

getTemplateNode in interface TemplateService

Parameters:

type - String The value which specify the type of template

nodeTypeName - String The name of NodeType

templateName - String The name of template

provider - SessionProvider The SessionProvider object is used to managed Sessions

Throws:

Exception

See Also:

SessionProvider, Node

getTemplatePathByUser

public String getTemplatePathByUser(boolean isDialog,
                                    String nodeTypeName,
                                    String userName)
                             throws javax.jcr.RepositoryException

Return the template by user.

Specified by:

getTemplatePathByUser in interface TemplateService

Parameters:

isDialog - boolean The boolean value which specify the type of template

nodeTypeName - String The specify name of node type

userName - String The current user

Throws:

javax.jcr.RepositoryException

See Also:

Node, Session

getTemplatePath

public String getTemplatePath(boolean isDialog,
                              String nodeTypeName,
                              String templateName)
                       throws Exception

Return path template of the specified node.

Specified by:

getTemplatePath in interface TemplateService

Parameters:

isDialog - boolean The boolean value which specify the type of template

nodeTypeName - String The specify name of node type

templateName - String The name of template

Throws:

Exception

See Also:

Session, Node

getTemplateLabel

public String getTemplateLabel(String nodeTypeName)
                        throws Exception

Return the label of the specified template by giving the following parameters.

Specified by:

getTemplateLabel in interface TemplateService

Parameters:

nodeTypeName - String The specified name of NodeType

Throws:

Exception

See Also:

SessionProvider, Node

getTemplate

public String getTemplate(String type,
                          String nodeTypeName,
                          String templateName)
                   throws Exception

Return template file of the specified node.

Specified by:

getTemplate in interface TemplateService

Parameters:

type - String The string value which specify the type of template

nodeTypeName - String The specify name of node type

templateName - String The name of template

Throws:

Exception

See Also:

Session, Node

removeTemplate

public void removeTemplate(String type,
                           String nodeTypeName,
                           String templateName)
                    throws Exception

Remove a template of NodeType by giving the following parameters.

Specified by:

removeTemplate in interface TemplateService

Parameters:

type - String The value which specify the type of template

nodeTypeName - String The specify name of NodType

templateName - String The name of template

Throws:

Exception

See Also:

Session, Node

removeManagedNodeType

public void removeManagedNodeType(String nodeTypeName)
                           throws Exception

Removes the NodeType by giving the name of NodeType.

Specified by:

removeManagedNodeType in interface TemplateService

Parameters:

nodeTypeName - String The name of NodeType

Throws:

Exception

See Also:

Session, Node

getDocumentTemplates

public List<String> getDocumentTemplates()
                                  throws javax.jcr.RepositoryException

Get all templates is document type of the specified repository.

Specified by:

getDocumentTemplates in interface TemplateService

Throws:

javax.jcr.RepositoryException

See Also:

Session, Node

getTemplatePathByAnonymous

public String getTemplatePathByAnonymous(boolean isDialog,
                                         String nodeTypeName)
                                  throws javax.jcr.RepositoryException

Return the path public template.

Specified by:

getTemplatePathByAnonymous in interface TemplateService

Parameters:

isDialog - boolean The boolean value which specify the type of template

nodeTypeName - String The specify name of node type

Throws:

javax.jcr.RepositoryException

removeCacheTemplate

public void removeCacheTemplate(String name)
                         throws Exception

Remove cache of template.

Specified by:

removeCacheTemplate in interface TemplateService

Parameters:

name - String jcr path of template

Throws:

Exception

removeAllTemplateCached

public void removeAllTemplateCached()

Remove all templates cached.

Specified by:

removeAllTemplateCached in interface TemplateService

getAllDocumentNodeTypes

public List<String> getAllDocumentNodeTypes()
                                     throws javax.jcr.PathNotFoundException,
                                            javax.jcr.RepositoryException

Description copied from interface: TemplateService

Get All Document NodeTypes of the current repository.

Specified by:

getAllDocumentNodeTypes in interface TemplateService

Returns:

all document nodetypes

Throws:

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

getSkinPath

public String getSkinPath(String nodeTypeName,
                          String skinName,
                          String locale)
                   throws Exception

Get path of css file which included in view template.

Specified by:

getSkinPath in interface TemplateService

Parameters:

nodeTypeName - String The node type name

skinName - String The name of css file

locale - String The locale which specified by user

Returns:

String The path of css file

Throws:

Exception

buildDialogForm

public String buildDialogForm(String nodeTypeName)
                       throws Exception

Build string of dialog form template base on properties of nodetype.

Specified by:

buildDialogForm in interface TemplateService

Returns:

Throws:

Exception

buildViewForm

public String buildViewForm(String nodeTypeName)
                     throws Exception

Build string of view template form base on properties of nodetype.

Specified by:

buildViewForm in interface TemplateService

Returns:

Throws:

Exception

buildStyleSheet

public String buildStyleSheet(String nodeTypeName)
                       throws Exception

Build string of view template form base on properties of nodetype.

Specified by:

buildStyleSheet in interface TemplateService

Returns:

Throws:

Exception

addTemplate

public String addTemplate(String templateType,
                          String nodeTypeName,
                          String label,
                          boolean isDocumentTemplate,
                          String templateName,
                          String[] roles,
                          InputStream templateFile)
                   throws Exception

Insert a new template into NodeType by giving the following parameters.

Specified by:

addTemplate in interface TemplateService

Parameters:

templateType - The value which specify the type of template

nodeTypeName - The specify name of NodType

label - The label of the specified template

isDocumentTemplate - The boolean value which yes or no is DocumentTemplate

templateName - The name of template

roles - The roles of template

templateFile - The file of template

Throws:

Exception

See Also:

Session, Node

addTemplate

public String addTemplate(String templateType,
                          String nodeTypeName,
                          String label,
                          boolean isDocumentTemplate,
                          String templateName,
                          String[] roles,
                          InputStream templateFile,
                          javax.jcr.Node templatesHome)
                   throws Exception

Insert a new template into NodeType by giving the following parameters.

Specified by:

addTemplate in interface TemplateService

Parameters:

templateType - The value which specify the type of template

nodeTypeName - The specify name of NodType

label - The label of the specified template

isDocumentTemplate - The boolean value which yes or no is DocumentTemplate

templateName - The name of template

roles - The roles of template

templateFile - The file of template

templatesHome - Node

Throws:

Exception

See Also:

Session, Node

createTemplate

@Deprecated
public String createTemplate(javax.jcr.Node templateFolder,
                                         String name,
                                         InputStream data,
                                         String[] roles)

Deprecated.

Insert a template into JCR database as an nt:file node. This method should be used for all the template types.

Specified by:

createTemplate in interface TemplateService

Parameters:

templateFolder - The parent node which contains the template node

name - The template's name

data - The template's data

roles - The template's roles

createTemplate

public String createTemplate(javax.jcr.Node templateFolder,
                             String title,
                             String templateName,
                             InputStream data,
                             String[] roles)

Insert a template into JCR database as an nt:file node. This method should be used for all the template types.

Specified by:

createTemplate in interface TemplateService

Parameters:

templateFolder - The parent node which contains the template node

title - The template title

templateName - The template's name

data - The template's data

roles - The template's roles

updateTemplate

public String updateTemplate(javax.jcr.Node template,
                             InputStream data,
                             String[] roles)

Update a template inside JCR database. This method should be used for all the template types.

Specified by:

updateTemplate in interface TemplateService

Parameters:

template - The template node

data - The template's data

roles - The template's roles

getTemplate

public String getTemplate(javax.jcr.Node template)

Get a template from JCR database. This method should be used for all the template types.

Specified by:

getTemplate in interface TemplateService

Parameters:

template - The template node

getTemplateRoles

public String getTemplateRoles(javax.jcr.Node template)

Get roles from a template. This method should be used for all the template types.

Specified by:

getTemplateRoles in interface TemplateService

Parameters:

template - The template node

getAllConfiguredNodeTypes

public Set<String> getAllConfiguredNodeTypes()

Description copied from interface: TemplateService

gets all node types configured

Specified by:

getAllConfiguredNodeTypes in interface TemplateService

Returns:

getAllEditedConfiguredNodeTypes

public Set<String> getAllEditedConfiguredNodeTypes()
                                            throws Exception

Description copied from interface: TemplateService

Gets all node types configured whose templates were edited.

Specified by:

getAllEditedConfiguredNodeTypes in interface TemplateService

Returns:

list of String

Throws:

Exception