EventListenerDescriptor (Nuxeo ECM Projects 8.10-SNAPSHOT API)

java.lang.Object
- org.nuxeo.ecm.core.event.impl.EventListenerDescriptor

public class EventListenerDescriptor
extends Object

XObject descriptor to declare event listeners

Field Summary

Fields
Modifier and Type	Field and Description
`protected Class<?>`	`clazz` The event listener class.
`protected Set<String>`	`events`
`protected EventListener`	`inLineListener`
`protected Boolean`	`isAsync` Applies only for post commit listener
`protected boolean`	`isEnabled`
`protected boolean`	`isPostCommit` Applies only for scripts.
`static org.apache.commons.logging.Log`	`log`
`protected String`	`name`
`protected PostCommitEventListener`	`postCommitEventListener`
`protected Integer`	`priority` The priority to be used to order listeners.
`protected RuntimeContext`	`rc`
`protected Integer`	`retryCount`
`protected String`	`script` A script reference: URL, file path, or bundle entry.
`protected boolean`	`singleThreaded`
`protected Integer`	`transactionTimeOut`

Constructor Summary

Constructors
Constructor and Description

EventListenerDescriptor()

Constructors
Constructor and Description
`EventListenerDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptBundle(EventBundle bundle)` Checks if there's at least one event of interest in the bundle.
`boolean`	`acceptEvent(String eventName)`
`EventListener`	`asEventListener()`
`PostCommitEventListener`	`asPostCommitListener()`
`EventBundle`	`filterBundle(EventBundle bundle)` Filters the event bundle to only keep events of interest to this listener.
`Set<String>`	`getEvents()`
`boolean`	`getIsAsync()`
`String`	`getName()`
`int`	`getPriority()`
`Integer`	`getRetryCount()`
`RuntimeContext`	`getRuntimeContext()`
`Script`	`getScript()`
`Integer`	`getTransactionTimeout()`
`void`	`initListener()`
`boolean`	`isEnabled()`
`boolean`	`isSingleThreaded()`
`void`	`merge(EventListenerDescriptor other)`
`void`	`setEnabled(boolean isEnabled)`
`void`	`setEvents(Set<String> events)`
`void`	`setIsAsync(Boolean isAsync)`
`void`	`setRetryCount(Integer retryCount)`
`void`	`setRuntimeContext(RuntimeContext rc)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static final org.apache.commons.logging.Log log

name
```
protected String name
```

clazz
```
protected Class<?> clazz
```
The event listener class.

script
```
protected String script
```
A script reference: URL, file path, or bundle entry. Runtime variable are expanded. To specify a bundle entry use the URL schema "bundle:"

isPostCommit
```
protected boolean isPostCommit
```
Applies only for scripts.

isAsync
```
protected Boolean isAsync
```
Applies only for post commit listener

transactionTimeOut
```
protected Integer transactionTimeOut
```

priority
```
protected Integer priority
```
The priority to be used to order listeners.

isEnabled
```
protected boolean isEnabled
```

retryCount
```
protected Integer retryCount
```

singleThreaded
```
protected boolean singleThreaded
```

events
```
protected Set<String> events
```

rc
```
protected RuntimeContext rc
```

inLineListener
```
protected EventListener inLineListener
```

postCommitEventListener

protected PostCommitEventListener postCommitEventListener

Constructor Detail
- EventListenerDescriptor
```
public EventListenerDescriptor()
```

Method Detail

getPriority
```
public int getPriority()
```

setRuntimeContext

public void setRuntimeContext(RuntimeContext rc)

getRuntimeContext

public RuntimeContext getRuntimeContext()

isEnabled
```
public boolean isEnabled()
```

getRetryCount
```
public Integer getRetryCount()
```

getEvents
```
public Set<String> getEvents()
```

setEvents

public void setEvents(Set<String> events)

setEnabled

public void setEnabled(boolean isEnabled)

setRetryCount

public void setRetryCount(Integer retryCount)

initListener
```
public void initListener()
```

asEventListener

public EventListener asEventListener()

asPostCommitListener

public PostCommitEventListener asPostCommitListener()

getScript

public Script getScript()
                 throws IOException

Throws:: IOException

getName
```
public String getName()
```

getTransactionTimeout

public Integer getTransactionTimeout()

merge

public void merge(EventListenerDescriptor other)

acceptEvent

public final boolean acceptEvent(String eventName)

setIsAsync

public void setIsAsync(Boolean isAsync)

getIsAsync
```
public boolean getIsAsync()
```

isSingleThreaded
```
public boolean isSingleThreaded()
```

filterBundle
```
public EventBundle filterBundle(EventBundle bundle)
```
Filters the event bundle to only keep events of interest to this listener.

Since:

5.7

acceptBundle
```
public boolean acceptBundle(EventBundle bundle)
```
Checks if there's at least one event of interest in the bundle.

Since:

5.7

Class EventListenerDescriptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

name

clazz

script

isPostCommit

isAsync

transactionTimeOut

priority

isEnabled

retryCount

singleThreaded

events

rc

inLineListener

postCommitEventListener

Constructor Detail

EventListenerDescriptor

Method Detail

getPriority

setRuntimeContext

getRuntimeContext

isEnabled

getRetryCount

getEvents

setEvents

setEnabled

setRetryCount

initListener

asEventListener

asPostCommitListener

getScript

getName

getTransactionTimeout

merge

acceptEvent

setIsAsync

getIsAsync

isSingleThreaded

filterBundle

acceptBundle