org.nuxeo.ecm.automation.core.events

Class EventHandler

java.lang.Object

org.nuxeo.ecm.automation.core.events.EventHandler

public class EventHandler
extends Object

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
protected Filter	attribute
protected String	chainId
protected String	condition
protected Set<String>	doctypes
protected Set<String>	events
protected String	expression Deprecated. since 5.7: expression evaluation was inverted so a new attribute condition has been defined, see NXP-8630
protected String	facet
protected Boolean	isAdministrator
protected boolean	isPostCommit
protected String[]	lifeCycle
protected List<String>	memberOf the principal should be member of at least one of the groups.
protected String	pathStartsWith

Constructor Summary

Constructors

Constructor and Description
EventHandler()
EventHandler(Set<String> eventId, String chainId)
EventHandler(String eventId, String chainId)

Method Summary

Modifier and Type	Method and Description
protected void	_setCondition(String expr)
protected void	_setExpression(String expr)
protected String	convertExpr(String expr)
Filter	getAttribute()
String	getChainId()
String	getCondition() Condition to define on event handler
Set<String>	getDoctypes()
Set<String>	getEvents()
Expression	getExpr() Deprecated. since 5.7: use
String	getExpression() Deprecated. since 5.7: use getCondition() instead
String	getFacet()
Boolean	getIsAdministrator()
String[]	getLifeCycle()
List<String>	getMemberOf()
String	getPathStartsWith()
boolean	isEnabled(OperationContext ctx, EventContext eventCtx, boolean quick) Checks if this handler should run for the event and operation context.
boolean	isPostCommit()
void	setAttribute(String attribute)
void	setAttributeFilter(Filter attribute)
void	setChainId(String chainId)
void	setCondition(String condition)
void	setDoctypes(Set<String> doctypes)
void	setExpression(String expression) Deprecated. since 5.7.1 use setCondition(String) instead
void	setFacet(String facet)
void	setIsAdministrator(Boolean isAdministrator)
void	setLifeCycle(String[] lifeCycle)
protected void	setLifeCycleExpr(String lifeCycles)
void	setMemberOf(List<String> groups)
void	setPathStartsWith(String pathStartsWith)
void	setPostCommit(boolean isPostCommit)

Methods inherited from class java.lang.Object

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

Field Detail

chainId

protected String chainId

isPostCommit

protected boolean isPostCommit

events

protected Set<String> events

doctypes

protected Set<String> doctypes

facet

protected String facet

lifeCycle

protected String[] lifeCycle

pathStartsWith

protected String pathStartsWith

attribute

protected Filter attribute

memberOf

protected List<String> memberOf

the principal should be member of at least one of the groups. OR is used

isAdministrator

protected Boolean isAdministrator

expression

@Deprecated
protected String expression

Deprecated. since 5.7: expression evaluation was inverted so a new attribute condition has been defined, see NXP-8630

condition

protected String condition

Since:

5.7: added to replace the 'expression' element as its evaluation is inverted

Constructor Detail

EventHandler

public EventHandler()

EventHandler

public EventHandler(String eventId,
                    String chainId)

EventHandler

public EventHandler(Set<String> eventId,
                    String chainId)

Method Detail

setLifeCycleExpr

protected void setLifeCycleExpr(String lifeCycles)

setAttribute

public void setAttribute(String attribute)

_setExpression

protected void _setExpression(String expr)

_setCondition

protected void _setCondition(String expr)

convertExpr

protected String convertExpr(String expr)

getEvents

public Set<String> getEvents()

getChainId

public String getChainId()

setPostCommit

public void setPostCommit(boolean isPostCommit)

isPostCommit

public boolean isPostCommit()

setAttributeFilter

public void setAttributeFilter(Filter attribute)

setIsAdministrator

public void setIsAdministrator(Boolean isAdministrator)

setMemberOf

public void setMemberOf(List<String> groups)

setPathStartsWith

public void setPathStartsWith(String pathStartsWith)

setExpression

@Deprecated
public void setExpression(String expression)

Deprecated. since 5.7.1 use setCondition(String) instead

setDoctypes

public void setDoctypes(Set<String> doctypes)

setFacet

public void setFacet(String facet)

setLifeCycle

public void setLifeCycle(String[] lifeCycle)

setChainId

public void setChainId(String chainId)

getExpression

@Deprecated
public String getExpression()

Deprecated. since 5.7: use getCondition() instead

getCondition

public String getCondition()

Condition to define on event handler

Since:

5.7

setCondition

public void setCondition(String condition)

Since:

5.9.1

getFacet

public String getFacet()

getAttribute

public Filter getAttribute()

getLifeCycle

public String[] getLifeCycle()

getMemberOf

public List<String> getMemberOf()

getIsAdministrator

public Boolean getIsAdministrator()

getPathStartsWith

public String getPathStartsWith()

getDoctypes

public Set<String> getDoctypes()

getExpr

@Deprecated
public Expression getExpr()

Deprecated. since 5.7: use

isEnabled

public boolean isEnabled(OperationContext ctx,
                         EventContext eventCtx,
                         boolean quick)

Checks if this handler should run for the event and operation context.

Parameters:

quick - If true, then this method may not check all filter parameters like filter/expression and just return true to avoid costly evaluations on ShallowDocumentModel instances