org.forgerock.audit.events.handlers.buffering

Interface BatchPublisher

All Known Implementing Classes:

BufferedBatchPublisher

public interface BatchPublisher

Implementations of BatchPublisher are able to consume multiple audit events and build batches out of them. These batches are then passed on to some consumer.

Method Summary

Modifier and Type	Method and Description
boolean	offer(String topic, JsonValue event) Offers up an event to be added to a batch.
void	shutdown() Informs the publisher to stop processing offered events.
void	startup() Informs the publisher to start processing offered events.

Method Detail

startup

void startup()

Informs the publisher to start processing offered events.

shutdown

void shutdown()

Informs the publisher to stop processing offered events.

offer

boolean offer(String topic,
              JsonValue event)

Offers up an event to be added to a batch.

Parameters:

topic - event topic

event - the event

Returns:

whether the event was successfully consumed