org.nuxeo.ecm.core.event.pipe

Interface PipeConsumer<T>

All Known Implementing Classes:

AbstractListenerPipeConsumer, AbstractPipeConsumer, LocalEventBundlePipeConsumer

public interface PipeConsumer<T>

SPI for a consumer of messages inside the EventBundlePipe

Since:

8.4

Method Summary

Modifier and Type	Method and Description
void	initConsumer(String name, Map<String,String> params) Initialize the Consumer when the EventBundlePipe is initialized
boolean	receiveMessage(List<T> messages) Callback when a batch of messages is available
void	shutdown() Shutdown the consumer when the EventBundlePipe is shutdown
boolean	waitForCompletion(long timeoutMillis) Wait until consumer is done

Method Detail

initConsumer

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

Initialize the Consumer when the EventBundlePipe is initialized

Parameters:

name -

params -

receiveMessage

boolean receiveMessage(List<T> messages)

Callback when a batch of messages is available

Parameters:

messages -

Returns:

shutdown

void shutdown()
       throws InterruptedException

Shutdown the consumer when the EventBundlePipe is shutdown

Throws:

InterruptedException

waitForCompletion

boolean waitForCompletion(long timeoutMillis)
                   throws InterruptedException

Wait until consumer is done

Parameters:

timeoutMillis -

Returns:

Throws:

InterruptedException