org.jahia.services.content.rules

Class RulesListener

java.lang.Object

org.jahia.services.content.DefaultEventListener

org.jahia.services.content.rules.RulesListener

All Implemented Interfaces:

javax.jcr.observation.EventListener, org.springframework.beans.factory.DisposableBean

public class RulesListener
extends DefaultEventListener
implements org.springframework.beans.factory.DisposableBean

Jahia rules-based event listener. User: toto Date: 6 juil. 2007 Time: 18:03:47

Field Summary

Fields inherited from class org.jahia.services.content.DefaultEventListener

availableDuringPublish, operationTypes, propertiesToIgnore, workspace

Constructor Summary

Constructors

Constructor and Description
RulesListener()

Method Summary

Modifier and Type	Method and Description
void	addGlobalObject(String key, Object value)
void	addRules(File dsrlFile)
void	addRules(org.springframework.core.io.Resource dsrlFile, JahiaTemplatesPackage aPackage)
void	addRulesDescriptor(File file)
void	addRulesDescriptor(org.springframework.core.io.Resource resource)
void	addRulesDescriptor(org.springframework.core.io.Resource resource, JahiaTemplatesPackage aPackage)
void	destroy()
void	executeRules(Collection<?> facts, Map<String,Object> globals)
void	executeRules(Object[] facts, Map<String,Object> globals)
void	executeRules(Object fact, Map<String,Object> globals)
int	getEventTypes()
List<String>	getFilesAccepted()
Map<String,Object>	getGlobals(String username, String userRealm, List<Updateable> delayedUpdates)
static RulesListener	getInstance(String workspace)
static List<RulesListener>	getInstances()
Map<String,String>	getModulePackageNameMap()
org.drools.core.RuleBase	getRuleBase() Returns the rule base, used by this listener.
void	onEvent(javax.jcr.observation.EventIterator eventIterator)
void	removeGlobalObject(String key)
void	removeRules(JahiaTemplatesPackage module)
boolean	removeRulesDescriptor(org.springframework.core.io.Resource resource)
void	setDisabledRules(String rulesToDisable) Sets the configuration for rules to be disabled.
void	setFilesAccepted(List<String> fileAccepted)
void	setGlobalObjects(Map<String,Object> globalObjects)
void	setRuleFiles(Set<String> ruleFiles)
void	start()

Methods inherited from class org.jahia.services.content.DefaultEventListener

getMoveFilteredEvents, getNodeTypes, getOperationTypes, getPath, getUuids, getWorkspace, isAvailableDuringPublish, isDeep, isExternal, isSupportedOperationType, setAvailableDuringPublish, setOperationTypes, setWorkspace

Methods inherited from class java.lang.Object

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

Constructor Detail

RulesListener

public RulesListener()

Method Detail

getInstance

public static RulesListener getInstance(String workspace)

getEventTypes

public int getEventTypes()

Specified by:

getEventTypes in class DefaultEventListener

executeRules

public void executeRules(Object fact,
                         Map<String,Object> globals)

executeRules

public void executeRules(Object[] facts,
                         Map<String,Object> globals)

executeRules

public void executeRules(Collection<?> facts,
                         Map<String,Object> globals)

setRuleFiles

public void setRuleFiles(Set<String> ruleFiles)

start

public void start()
           throws Exception

Throws:

Exception

addRules

public void addRules(File dsrlFile)

addRules

public void addRules(org.springframework.core.io.Resource dsrlFile,
                     JahiaTemplatesPackage aPackage)

onEvent

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

Specified by:

onEvent in interface javax.jcr.observation.EventListener

getGlobals

public Map<String,Object> getGlobals(String username,
                                     String userRealm,
                                     List<Updateable> delayedUpdates)

addRulesDescriptor

public void addRulesDescriptor(File file)

addRulesDescriptor

public void addRulesDescriptor(org.springframework.core.io.Resource resource)

addRulesDescriptor

public void addRulesDescriptor(org.springframework.core.io.Resource resource,
                               JahiaTemplatesPackage aPackage)

setGlobalObjects

public void setGlobalObjects(Map<String,Object> globalObjects)

addGlobalObject

public void addGlobalObject(String key,
                            Object value)

removeGlobalObject

public void removeGlobalObject(String key)

getInstances

public static List<RulesListener> getInstances()

getFilesAccepted

public List<String> getFilesAccepted()

setFilesAccepted

public void setFilesAccepted(List<String> fileAccepted)

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

removeRules

public void removeRules(JahiaTemplatesPackage module)

removeRulesDescriptor

public boolean removeRulesDescriptor(org.springframework.core.io.Resource resource)

getModulePackageNameMap

public Map<String,String> getModulePackageNameMap()

setDisabledRules

public void setDisabledRules(String rulesToDisable)

Sets the configuration for rules to be disabled. The string format is as follows:

 ["<workspace>".]"<package-name-1>"."<rule-name-1>",["<workspace>".]"<package-name-2>"."<rule-name-2>"...
 

The workspace part is optional. For example the following configuration:

 "org.jahia.modules.rules"."Image update","live"."org.jahia.modules.dm.thumbnails"."Automatically generate thumbnail for the document"
 

will disable rule Image update (from package org.jahia.modules.rules) in rules for all workspaces (live and default) and the rule Automatically generate thumbnail for the document (package org.jahia.modules.dm.thumbnails) will be disabled in rules for live workspace only.

Parameters:

rulesToDisable - the configuration for rules to be disabled

getRuleBase

public org.drools.core.RuleBase getRuleBase()

Returns the rule base, used by this listener.

Returns:

the rule base, used by this listener