com.diffusiondata.gateway.framework.convertors

Interface InboundPayloadConvertor<V,D>

Type Parameters:

V - the back end value type

D - the Diffusion value type - must be JSON, String, Long, Double or Binary types.

All Superinterfaces:

PayloadConvertor<V,D>

public interface InboundPayloadConvertor<V,D>
extends PayloadConvertor<V,D>

The interface that an inbound payload convertor implements.

An inbound convertor converts values of external data types to Diffusion data types. It is used to convert the values passed to a Publisher within a SourceHandler or HybridHandler via its publish method.

Inbound Payload convertors are declared with configuration files in the resource directory META-INF/services. The file name should be META-INF/services/com.diffusiondata.gateway.framework.convertors.InboundPayloadConvertor and each line within the file declares the full name of a payload convertor class.

See Package Guide for more details.

Author:

DiffusionData Limited

Field Summary

Fields

Modifier and Type	Field and Description
static String	AVRO_TO_JSON The name of the provided Avro to JSON inbound payload convertor.
static String	CSV_TO_JSON The name of the provided CSV to JSON inbound payload convertor.

Fields inherited from interface com.diffusiondata.gateway.framework.convertors.PayloadConvertor

DEFAULT_BINARY, DEFAULT_DOUBLE, DEFAULT_INT64, DEFAULT_JSON, DEFAULT_STRING

Method Summary

Modifier and Type	Method and Description
D	toDiffusionType(Object value) Converts a value object of the format known to the back end into a Diffusion typed object, matching a Diffusion topic type.

Methods inherited from interface com.diffusiondata.gateway.framework.convertors.PayloadConvertor

getDiffusionType, getName

Field Detail

AVRO_TO_JSON

static final String AVRO_TO_JSON

The name of the provided Avro to JSON inbound payload convertor.

see the Package Guide for full details of the conversions this convertor performs.

See Also:

Constant Field Values

CSV_TO_JSON

static final String CSV_TO_JSON

The name of the provided CSV to JSON inbound payload convertor.

see the Package Guide for full details of the conversions this convertor performs.

See Also:

Constant Field Values

Method Detail

toDiffusionType

D toDiffusionType(Object value)
           throws PayloadConversionException

Converts a value object of the format known to the back end into a Diffusion typed object, matching a Diffusion topic type.

Parameters:

value - the unconverted value

Returns:

the converted value

Throws:

PayloadConversionException - if the convertor fails to convert the value