org.irenical.dumpy.api

Interface IExtractor<TYPE,ERROR extends Exception>

public interface IExtractor<TYPE,ERROR extends Exception>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IExtractor.Entity<TYPE>
static class	IExtractor.Response<TYPE>

Method Summary

Modifier and Type	Method and Description
default IExtractor.Response<TYPE>	createResponse(List<IExtractor.Entity<TYPE>> entities, String nextCursor, boolean hasNext) Utility to build a paginated response.
IExtractor.Response<TYPE>	get(List<String> ids, String cursor) Get entities from the source system identified by the given ids.
IExtractor.Response<TYPE>	get(String cursor) Get entities from the source system since the given cursor.

Method Detail

get

IExtractor.Response<TYPE> get(String cursor)
                       throws ERROR extends Exception

Get entities from the source system since the given cursor. Cursor can be null (or empty) - usually on the first run.

Parameters:

cursor -

Returns:

a paginated response for the requested entities

Throws:

ERROR extends Exception

get

IExtractor.Response<TYPE> get(List<String> ids,
                              String cursor)
                       throws ERROR extends Exception

Get entities from the source system identified by the given ids.

Parameters:

ids -

cursor -

Returns:

a paginated response for the requested entities

Throws:

ERROR extends Exception

createResponse

default IExtractor.Response<TYPE> createResponse(List<IExtractor.Entity<TYPE>> entities,
                                                 String nextCursor,
                                                 boolean hasNext)

Utility to build a paginated response.