org.zalando.nakadiproducer.snapshots

Class SimpleSnapshotEventGenerator

java.lang.Object

org.zalando.nakadiproducer.snapshots.SimpleSnapshotEventGenerator

All Implemented Interfaces:

SnapshotEventGenerator

public final class SimpleSnapshotEventGenerator
extends Object
implements SnapshotEventGenerator

This is a simple implementation of the SnapshotEventGenerator. It is meant to be used in a functional style.

See Also:

SnapshotEventGenerator

Constructor Summary

Constructors

Constructor and Description
SimpleSnapshotEventGenerator(String supportedEventType, java.util.function.BiFunction<Object,String,List<Snapshot>> snapshotEventFactory) Creates a SnapshotEventGenerator for an event type, with filtering support.
SimpleSnapshotEventGenerator(String supportedEventType, java.util.function.Function<Object,List<Snapshot>> snapshotEventFactory) Creates a SnapshotEventGenerator for an event type, which doesn't support filtering.

Method Summary

Modifier and Type	Method and Description
List<Snapshot>	generateSnapshots(Object withIdGreaterThan, String filter) Returns a batch of snapshots of given type (event type is an event channel topic name).
String	getSupportedEventType() The name of the event type supported by this snapshot generator.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleSnapshotEventGenerator

public SimpleSnapshotEventGenerator(String supportedEventType,
                                    java.util.function.Function<Object,List<Snapshot>> snapshotEventFactory)

Creates a SnapshotEventGenerator for an event type, which doesn't support filtering.

Parameters:

supportedEventType - the eventType that this SnapShotEventProvider will support.

snapshotEventFactory - a snapshot event factory function conforming to the specification of SnapshotEventGenerator.generateSnapshots(Object, String) (but without the filter parameter). Any filter provided by the caller will be thrown away.

SimpleSnapshotEventGenerator

public SimpleSnapshotEventGenerator(String supportedEventType,
                                    java.util.function.BiFunction<Object,String,List<Snapshot>> snapshotEventFactory)

Creates a SnapshotEventGenerator for an event type, with filtering support.

Parameters:

supportedEventType - the eventType that this SnapShotEventProvider will support.

snapshotEventFactory - a snapshot event factory function conforming to the specification of SnapshotEventGenerator.generateSnapshots(Object, String).

Method Detail

generateSnapshots

public List<Snapshot> generateSnapshots(Object withIdGreaterThan,
                                        String filter)

Description copied from interface: SnapshotEventGenerator

Returns a batch of snapshots of given type (event type is an event channel topic name). The implementation may return an arbitrary amount of results, but it must return at least one element if there are entities matching the parameters.

Calling this method must have no side effects.

The library will call your implementation like this:

• Request: generateSnapshots(null, filter), Response: 1,2,3
• Request: generateSnapshots(3, filter), Response: 4,5
• Request: generateSnapshots(5, filter), Response: emptyList

It is your responsibility to make sure that the returned events are ordered by their ID ascending and that, given you return a list of events for entities with IDs {id₁, ..., id_N}, there exists no entity with an ID between id₁ and id_N, that is not part of the result.

Specified by:

generateSnapshots in interface SnapshotEventGenerator

Parameters:

withIdGreaterThan - if not null, only events for entities with an ID greater than the given one must be returned

filter - a filter for the snapshot generation mechanism. This value is simply passed through from the request body of the REST endpoint (or from any other triggering mechanism). If there was no request body, this will be null. Implementors can interpret it in whatever way they want (even ignore it). All calls for one snapshot generation will receive the same string.

Returns:

list of elements (wrapped in Snapshot objects) ordered by their ID.

getSupportedEventType

public String getSupportedEventType()

Description copied from interface: SnapshotEventGenerator

The name of the event type supported by this snapshot generator.

Specified by:

getSupportedEventType in interface SnapshotEventGenerator