org.exoplatform.services.cms.actions.impl

Class ActionServiceContainerImpl

java.lang.Object

org.exoplatform.services.cms.actions.impl.ActionServiceContainerImpl

All Implemented Interfaces:

ActionServiceContainer, org.picocontainer.Startable

public class ActionServiceContainerImpl
extends Object
implements ActionServiceContainer, org.picocontainer.Startable

Process with action for node

Author:

exo

Constructor Summary

Constructors

Constructor and Description
ActionServiceContainerImpl(org.exoplatform.services.jcr.RepositoryService repositoryService, CmsService cmsService) Constructor method

Method Summary

Modifier and Type	Method and Description
void	addAction(javax.jcr.Node storeActionNode, String actionType, boolean isDeep, String[] uuid, String[] nodeTypeNames, Map mappings) Add mixintype = exo:actionable to current node Add new node to current node with nodetype = type
void	addAction(javax.jcr.Node storeActionNode, String actionType, Map mappings) Add mixintype = exo:actionable to current node Add new node to current node with nodetype = type
void	addPlugin(org.exoplatform.container.component.ComponentPlugin plugin) Add ComponentPlugin
void	createActionType(String actionTypeName, String parentActionTypeName, String executable, String actionLabel, List<String> variableNames, boolean isMoveType, boolean isUpdate) Create NodeTypeValue is in kind of ActionType following action type name
void	executeAction(String userId, javax.jcr.Node node, String actionName) Call addAction(Node node, String repository, String type, Map mappings) to execute action following userId, node, repository, initiated variables
void	executeAction(String userId, javax.jcr.Node node, String actionName, Map variables) Execute action following userId, node, variables, repository
javax.jcr.Node	getAction(javax.jcr.Node node, String actionName) get node by using actionName as relative path with current node
ActionPlugin	getActionPlugin(String actionsServiceName) Get ActionPlugin following ActionSeriveName
ActionPlugin	getActionPluginForActionType(String actionTypeName) Get ActionPlugin following action type name
Collection<String>	getActionPluginNames() Collection of String
List<javax.jcr.Node>	getActions(javax.jcr.Node node) Get list of child node with NodeType = exo:action
List<javax.jcr.Node>	getActions(javax.jcr.Node node, String lifecyclePhase) Get list of child node with exo:lifecyclePhase = lifecyclePhase
Collection<javax.jcr.nodetype.NodeType>	getCreatedActionTypes(String repository) Get all created node with nodetype = "exo:action
List<javax.jcr.Node>	getCustomActionsNode(javax.jcr.Node node, String lifecyclePhase) Get list of node that have same level with current node, exo:lifecyclePhase = lifecyclePhase
Collection<org.exoplatform.container.component.ComponentPlugin>	getPlugins() Get all ComponentPlugin
boolean	hasActions(javax.jcr.Node node) Check node type is exo:actionable or not
void	init() Init all available action plugins.
void	initiateObservation(javax.jcr.Node node) Add action listener for all action child node of current node in current repository
void	removeAction(javax.jcr.Node node, String repository) Remove all action registered in node
void	removeAction(javax.jcr.Node node, String actionName, String repository) Remove all relative node of current node with node type = exo:actionable
org.exoplatform.container.component.ComponentPlugin	removePlugin(String pluginName) Need implemented
void	start() Implement method start service Add mixin exo:actionable for node
void	stop() Implement method stop service

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionServiceContainerImpl

public ActionServiceContainerImpl(org.exoplatform.services.jcr.RepositoryService repositoryService,
                                  CmsService cmsService)
                           throws Exception

Constructor method

Parameters:

repositoryService - RepositoryService

cmsService - CmsService

Throws:

Exception

Method Detail

start

public void start()

Implement method start service Add mixin exo:actionable for node

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Implement method stop service

Specified by:

stop in interface org.picocontainer.Startable

init

public void init()

Init all available action plugins.

Specified by:

init in interface ActionServiceContainer

getActionPluginNames

public Collection<String> getActionPluginNames()

Collection of String

Specified by:

getActionPluginNames in interface ActionServiceContainer

Returns:

collection of ActionPlugin namess

getActionPlugin

public ActionPlugin getActionPlugin(String actionsServiceName)

Get ActionPlugin following ActionSeriveName

Specified by:

getActionPlugin in interface ActionServiceContainer

Parameters:

actionsServiceName - name of action service

Returns:

ActionPlugin

createActionType

public void createActionType(String actionTypeName,
                             String parentActionTypeName,
                             String executable,
                             String actionLabel,
                             List<String> variableNames,
                             boolean isMoveType,
                             boolean isUpdate)
                      throws Exception

Create NodeTypeValue is in kind of ActionType following action type name

Specified by:

createActionType in interface ActionServiceContainer

Parameters:

actionTypeName - name of action type

parentActionTypeName - name of parent action

executable - String value of executable

variableNames - List name of variable

isMoveType - is moved or not

actionLabel - Label of action type

isUpdate - True if the action type is updating

Throws:

Exception

getCreatedActionTypes

public Collection<javax.jcr.nodetype.NodeType> getCreatedActionTypes(String repository)
                                                              throws Exception

Get all created node with nodetype = "exo:action

Specified by:

getCreatedActionTypes in interface ActionServiceContainer

Parameters:

repository - repository name

Returns:

Collection of NodeType

Throws:

Exception

getActionPluginForActionType

public ActionPlugin getActionPluginForActionType(String actionTypeName)

Get ActionPlugin following action type name

Specified by:

getActionPluginForActionType in interface ActionServiceContainer

Parameters:

actionTypeName - name of action type

Returns:

ActionPlugin

getAction

public javax.jcr.Node getAction(javax.jcr.Node node,
                                String actionName)
                         throws Exception

get node by using actionName as relative path with current node

Specified by:

getAction in interface ActionServiceContainer

Parameters:

node - current processing node

actionName - name of action

Returns:

Node

Throws:

Exception

hasActions

public boolean hasActions(javax.jcr.Node node)
                   throws Exception

Check node type is exo:actionable or not

Specified by:

hasActions in interface ActionServiceContainer

Returns:

true: NodeType is exo:actionable false NodeType is not exo:actionable

Throws:

Exception

getActions

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

Get list of child node with NodeType = exo:action

Specified by:

getActions in interface ActionServiceContainer

Parameters:

node - current node

Returns:

list of node

Throws:

Exception

getCustomActionsNode

public List<javax.jcr.Node> getCustomActionsNode(javax.jcr.Node node,
                                                 String lifecyclePhase)
                                          throws Exception

Get list of node that have same level with current node, exo:lifecyclePhase = lifecyclePhase

Specified by:

getCustomActionsNode in interface ActionServiceContainer

Parameters:

node - current node

lifecyclePhase - exo:lifecyclePhase value

Returns:

list of node

Throws:

Exception

getActions

public List<javax.jcr.Node> getActions(javax.jcr.Node node,
                                       String lifecyclePhase)
                                throws Exception

Get list of child node with exo:lifecyclePhase = lifecyclePhase

Specified by:

getActions in interface ActionServiceContainer

Parameters:

node - current node

lifecyclePhase - exo:lifecyclePhase value

Returns:

list of node

Throws:

Exception

removeAction

public void removeAction(javax.jcr.Node node,
                         String repository)
                  throws Exception

Remove all action registered in node

Specified by:

removeAction in interface ActionServiceContainer

Throws:

Exception

removeAction

public void removeAction(javax.jcr.Node node,
                         String actionName,
                         String repository)
                  throws Exception

Remove all relative node of current node with node type = exo:actionable

Specified by:

removeAction in interface ActionServiceContainer

Parameters:

node - current node

actionName - relative path = exo:actionable / actionName

repository - repository name

Throws:

Exception

addAction

public void addAction(javax.jcr.Node storeActionNode,
                      String actionType,
                      boolean isDeep,
                      String[] uuid,
                      String[] nodeTypeNames,
                      Map mappings)
               throws Exception

Add mixintype = exo:actionable to current node Add new node to current node with nodetype = type}

Specified by:

addAction in interface ActionServiceContainer

Parameters:

storeActionNode - current node

actionType - nodetype name

isDeep - affect to child node of node

uuid - affect only to parent node of event having given uuid

nodeTypeNames - affect to parent node of event having nodetype in nodeTypeNames

mappings - value of property for adding to new node

Throws:

Exception

addAction

public void addAction(javax.jcr.Node storeActionNode,
                      String actionType,
                      Map mappings)
               throws Exception

Add mixintype = exo:actionable to current node Add new node to current node with nodetype = type

Specified by:

addAction in interface ActionServiceContainer

Parameters:

storeActionNode - current node

actionType - nodetype name

mappings - value of property for adding to new node

Throws:

Exception

executeAction

public void executeAction(String userId,
                          javax.jcr.Node node,
                          String actionName)
                   throws Exception

Call addAction(Node node, String repository, String type, Map mappings) to execute action following userId, node, repository, initiated variables

Specified by:

executeAction in interface ActionServiceContainer

Parameters:

userId - user identify

node - current node

actionName - name of action

Throws:

Exception

See Also:

ActionServiceContainer.executeAction(String, Node, String, Map)

executeAction

public void executeAction(String userId,
                          javax.jcr.Node node,
                          String actionName,
                          Map variables)
                   throws Exception

Execute action following userId, node, variables, repository

Specified by:

executeAction in interface ActionServiceContainer

Parameters:

userId - user identify

node - current node

actionName - name of action

variables - Map with variables and value

Throws:

Exception

addPlugin

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

Add ComponentPlugin

Parameters:

plugin - ComponentPlugin

removePlugin

public org.exoplatform.container.component.ComponentPlugin removePlugin(String pluginName)

Need implemented

Parameters:

pluginName -

Returns:

getPlugins

public Collection<org.exoplatform.container.component.ComponentPlugin> getPlugins()

Get all ComponentPlugin

Returns:

Collection of ComponentPlugins

initiateObservation

public void initiateObservation(javax.jcr.Node node)
                         throws Exception

Add action listener for all action child node of current node in current repository

Specified by:

initiateObservation in interface ActionServiceContainer

Parameters:

node - current node

Throws:

Exception