org.apache.flink.connectors.test.common.external

Interface ExternalContext<T>

Type Parameters:

T - Type of elements after deserialization by source

All Superinterfaces:

AutoCloseable, Serializable

@Experimental
public interface ExternalContext<T>
extends Serializable, AutoCloseable

Context of the test interacting with external system.

This context is responsible for providing:

• Instance of sources connecting to external system
• SourceSplitDataWriter for creating splits and writing test data into the created split
• Test data to write into the external system

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ExternalContext.Factory<T> Factory for ExternalContext.

Method Summary

Modifier and Type	Method and Description
org.apache.flink.api.connector.source.Source<T,?,?>	createSource(org.apache.flink.api.connector.source.Boundedness boundedness) Create a new instance of connector source implemented in Source.
SourceSplitDataWriter<T>	createSourceSplitDataWriter() Create a new split in the external system and a data writer corresponding to the new split.
Collection<T>	generateTestData(int splitIndex, long seed) Generate test data.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

createSource

org.apache.flink.api.connector.source.Source<T,?,?> createSource(org.apache.flink.api.connector.source.Boundedness boundedness)

Create a new instance of connector source implemented in Source.

Returns:

A new instance of Source

createSourceSplitDataWriter

SourceSplitDataWriter<T> createSourceSplitDataWriter()

Create a new split in the external system and a data writer corresponding to the new split.

Returns:

A data writer for the created split.

generateTestData

Collection<T> generateTestData(int splitIndex,
                               long seed)

Generate test data.

Make sure that the T#equals(Object) returns false when the records in different splits.

Parameters:

splitIndex - index of the split.

seed - Seed for generating random test data set.

Returns:

Collection of generated test data.