org.exoplatform.services.cms.scripts.impl

Class ScriptServiceImpl

java.lang.Object

org.exoplatform.services.cms.impl.BaseResourceLoaderService

org.exoplatform.services.cms.scripts.impl.ScriptServiceImpl

All Implemented Interfaces:

javax.jcr.observation.EventListener, ScriptService, org.picocontainer.Startable

public class ScriptServiceImpl
extends BaseResourceLoaderService
implements ScriptService, javax.jcr.observation.EventListener

Field Summary

Fields inherited from class org.exoplatform.services.cms.impl.BaseResourceLoaderService

cservice_, nodeHierarchyCreator_, repositoryService_, resourceCache_

Constructor Summary

Constructors

Constructor and Description

ScriptServiceImpl(org.exoplatform.services.jcr.RepositoryService repositoryService, org.exoplatform.container.configuration.ConfigurationManager cservice, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, org.exoplatform.services.cache.CacheService cacheService, DMSConfiguration dmsConfiguration) Constructor method Init repositoryService, configurationManager, nodeHierarchyCreator, caService, dmsConfiguration

Method Summary

Modifier and Type	Method and Description
void	addScript(String name, String text, org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will add script by giving the following params: name, text, provider
void	addScript(String name, String description, String text, org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will add script by giving the following params: name, text, description, provider
void	addScriptPlugin(org.exoplatform.container.component.ComponentPlugin plugin) add ScriptPlugin
Set<String>	getAllConfiguredScripts() gets all configured scripts
protected String	getBasePath() get Base Script Path
String	getBaseScriptPath() This method will get base path of script
List<javax.jcr.Node>	getECMActionScripts(org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will get all node for ECM Action Scripts by giving the following params: provider
List<javax.jcr.Node>	getECMInterceptorScripts(org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will get all node for ECM Interceptor Scripts by giving the following params: provider
javax.jcr.Node	getECMScriptHome(org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will get node for ECM Explorer Scripts by giving the following params: provider
List<javax.jcr.Node>	getECMWidgetScripts(org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will get all node for ECM Widget Scripts by giving the following params: provider
CmsScript	getScript(String scriptName) This method will get script by giving the following params: scriptPath
String	getScriptAsText(javax.jcr.Node script) This method will return the script as Text based on the script node.
javax.jcr.Node	getScriptNode(String scriptName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will get script node by giving the following params: scriptName, provider
void	initRepo() This method will init the current repository
void	onEvent(javax.jcr.observation.EventIterator events) onEvent
protected void	removeFromCache(String scriptName) remove From Cache
void	removeScript(String scriptName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will remove script by giving the following params: name, text, provider
void	start()

Methods inherited from class org.exoplatform.services.cms.impl.BaseResourceLoaderService

addResource, addResource, addResource, addScripts, getNodeTypeByResourceName, getResourceAsStream, getResourceAsText, getResourceByName, getResourceDescription, getResourceNameByNodeType, getResources, getResourcesHome, hasResources, init, removeResource, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptServiceImpl

public ScriptServiceImpl(org.exoplatform.services.jcr.RepositoryService repositoryService,
                         org.exoplatform.container.configuration.ConfigurationManager cservice,
                         org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator,
                         org.exoplatform.services.cache.CacheService cacheService,
                         DMSConfiguration dmsConfiguration)
                  throws Exception

Constructor method Init repositoryService, configurationManager, nodeHierarchyCreator, caService, dmsConfiguration

Parameters:

repositoryService - RepositoryService

cservice - ConfigurationManager

nodeHierarchyCreator - NodeHierarchyCreator

cacheService - CacheService

dmsConfiguration - DMSConfiguration

Throws:

Exception

Method Detail

start

public void start()

Specified by:

start in interface org.picocontainer.Startable

Overrides:

start in class BaseResourceLoaderService

addScriptPlugin

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

add ScriptPlugin

Parameters:

plugin - ComponentPlugin

See Also:

ScriptPlugin, ComponentPlugin

getBasePath

protected String getBasePath()

get Base Script Path

Specified by:

getBasePath in class BaseResourceLoaderService

Returns:

String

See Also:

NodeHierarchyCreator

initRepo

public void initRepo()
              throws Exception

This method will init the current repository

Specified by:

initRepo in interface ScriptService

Throws:

Exception

See Also:

ManageableRepository, ObservationManager, Session

getECMScriptHome

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

This method will get node for ECM Explorer Scripts by giving the following params: provider

Specified by:

getECMScriptHome in interface ScriptService

Parameters:

provider - SessionProvider

Returns:

Node

Throws:

Exception

See Also:

Node, NodeHierarchyCreator, SessionProvider

getECMActionScripts

public List<javax.jcr.Node> getECMActionScripts(org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                         throws Exception

This method will get all node for ECM Action Scripts by giving the following params: provider

Specified by:

getECMActionScripts in interface ScriptService

Returns:

Node

Throws:

Exception

See Also:

Node, NodeHierarchyCreator, SessionProvider

getECMInterceptorScripts

public List<javax.jcr.Node> getECMInterceptorScripts(org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                              throws Exception

This method will get all node for ECM Interceptor Scripts by giving the following params: provider

Specified by:

getECMInterceptorScripts in interface ScriptService

Returns:

nodes list

Throws:

Exception

See Also:

Node, NodeHierarchyCreator, SessionProvider

getECMWidgetScripts

public List<javax.jcr.Node> getECMWidgetScripts(org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                         throws Exception

This method will get all node for ECM Widget Scripts by giving the following params: provider

Specified by:

getECMWidgetScripts in interface ScriptService

Returns:

nodes list

Throws:

Exception

See Also:

Node, NodeHierarchyCreator, SessionProvider

getBaseScriptPath

public String getBaseScriptPath()
                         throws Exception

This method will get base path of script

Specified by:

getBaseScriptPath in interface ScriptService

Returns:

String

Throws:

Exception

See Also:

NodeHierarchyCreator

getScriptAsText

public String getScriptAsText(javax.jcr.Node script)
                       throws Exception

This method will return the script as Text based on the script node.}

Specified by:

getScriptAsText in interface ScriptService

Parameters:

script - Node The script node

Returns:

String

Throws:

Exception

See Also:

Node

getScript

public CmsScript getScript(String scriptName)
                    throws Exception

This method will get script by giving the following params: scriptPath

Specified by:

getScript in interface ScriptService

Parameters:

scriptName - String The path of script

Returns:

CmsScript

Throws:

Exception

See Also:

CmsScript

addScript

public void addScript(String name,
                      String text,
                      org.exoplatform.services.jcr.ext.common.SessionProvider provider)
               throws Exception

This method will add script by giving the following params: name, text, provider

Specified by:

addScript in interface ScriptService

Parameters:

name - String The name of script

text - String

provider - SessionProvider

Throws:

Exception

See Also:

SessionProvider

addScript

public void addScript(String name,
                      String description,
                      String text,
                      org.exoplatform.services.jcr.ext.common.SessionProvider provider)
               throws Exception

This method will add script by giving the following params: name, text, description, provider

Specified by:

addScript in interface ScriptService

Parameters:

name - String The name of script

description - String

text - String

provider - SessionProvider

Throws:

Exception

See Also:

SessionProvider

removeScript

public void removeScript(String scriptName,
                         org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                  throws Exception

This method will remove script by giving the following params: name, text, provider

Specified by:

removeScript in interface ScriptService

Parameters:

scriptName - String The path of script

provider - SessionProvider

Throws:

Exception

See Also:

Node, SessionProvider

removeFromCache

protected void removeFromCache(String scriptName)

remove From Cache

Specified by:

removeFromCache in class BaseResourceLoaderService

Parameters:

scriptName - String The name of script

See Also:

ExoContainer, ExoContainerContext

onEvent

public void onEvent(javax.jcr.observation.EventIterator events)

onEvent

Specified by:

onEvent in interface javax.jcr.observation.EventListener

Parameters:

events - EventIterator

See Also:

Session, DMSRepositoryConfiguration, ManageableRepository

getScriptNode

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

This method will get script node by giving the following params: scriptName, provider

Specified by:

getScriptNode in interface ScriptService

Parameters:

scriptName - String The name of script

provider - SessionProvider

Returns:

Node

Throws:

Exception

See Also:

Node, SessionProvider

getAllConfiguredScripts

public Set<String> getAllConfiguredScripts()

gets all configured scripts}

Specified by:

getAllConfiguredScripts in interface ScriptService

Returns: