org.nuxeo.ecm.core.event.pipe

Class AbstractPipeConsumer<T>

java.lang.Object

org.nuxeo.ecm.core.event.pipe.AbstractPipeConsumer<T>

All Implemented Interfaces:

PipeConsumer<T>

Direct Known Subclasses:

AbstractListenerPipeConsumer

public abstract class AbstractPipeConsumer<T>
extends Object
implements PipeConsumer<T>

Provides partial default implementation for a PipeConsumer

Since:

8.4

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected Map<String,String>	params

Constructor Summary

Constructors

Constructor and Description
AbstractPipeConsumer()

Method Summary

Modifier and Type	Method and Description
protected String	getName()
protected Map<String,String>	getParameters()
void	initConsumer(String name, Map<String,String> params) Initialize the Consumer when the EventBundlePipe is initialized
protected abstract boolean	processEventBundles(List<EventBundle> bundles)
boolean	receiveMessage(List<T> messages) Callback when a batch of messages is available
protected abstract List<EventBundle>	unmarshallEventBundle(List<T> messages)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.core.event.pipe.PipeConsumer

shutdown, waitForCompletion

Field Detail

name

protected String name

params

protected Map<String,String> params

Constructor Detail

AbstractPipeConsumer

public AbstractPipeConsumer()

Method Detail

initConsumer

public void initConsumer(String name,
                         Map<String,String> params)

Description copied from interface: PipeConsumer

Initialize the Consumer when the EventBundlePipe is initialized

Specified by:

initConsumer in interface PipeConsumer<T>

getName

protected String getName()

getParameters

protected Map<String,String> getParameters()

receiveMessage

public boolean receiveMessage(List<T> messages)

Description copied from interface: PipeConsumer

Callback when a batch of messages is available

Specified by:

receiveMessage in interface PipeConsumer<T>

Returns:

unmarshallEventBundle

protected abstract List<EventBundle> unmarshallEventBundle(List<T> messages)

processEventBundles

protected abstract boolean processEventBundles(List<EventBundle> bundles)