org.nuxeo.ecm.core.event.pipe

Interface EventBundlePipe

All Known Implementing Classes:

AbstractEventBundlePipe, LocalEventBundlePipe

public interface EventBundlePipe

Interface for a pipe of events. This is the abstraction used to bridge the Nuxeo events to pipes that consume them.

Since:

8.4

Method Summary

Modifier and Type	Method and Description
void	initPipe(String name, Map<String,String> params) Initialize the Pipe when Nuxeo Event Service starts
void	sendEventBundle(EventBundle events) Send an EventBundle inside the pipe
void	shutdown() Shutdown callback when the EventService stops
boolean	waitForCompletion(long timeoutMillis) Wait until the end of event consumption

Method Detail

initPipe

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

Initialize the Pipe when Nuxeo Event Service starts

Parameters:

name - the name as defined in the XMap descriptor

params - the parameters as defined in the XMap descriptor

sendEventBundle

void sendEventBundle(EventBundle events)

Send an EventBundle inside the pipe

Parameters:

events -

waitForCompletion

boolean waitForCompletion(long timeoutMillis)
                   throws InterruptedException

Wait until the end of event consumption

Parameters:

timeoutMillis -

Returns:

Throws:

InterruptedException

shutdown

void shutdown()
       throws InterruptedException

Shutdown callback when the EventService stops

Throws:

InterruptedException