com.diffusiondata.gateway.framework.convertors

Interface OutboundPayloadConvertor<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 OutboundPayloadConvertor<V,D>
extends PayloadConvertor<V,D>

The interface that an outbound payload convertor implements.

An outbound convertor converts values of Diffusion data types to external data types. It is used to convert values passed to a SinkHandler via its update method or to a HybridHandler via its update method.

Outbound 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.OutboundPayloadConvertor 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	JSON_TO_AVRO The name of the provided JSON to Avro outbound 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
V	fromDiffusionType(D value) Converts a Diffusion typed value object to an object of the type known to the back end.

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

getDiffusionType, getName

Field Detail

JSON_TO_AVRO

static final String JSON_TO_AVRO

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

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

See Also:

Constant Field Values

Method Detail

fromDiffusionType

V fromDiffusionType(D value)
             throws PayloadConversionException

Converts a Diffusion typed value object to an object of the type known to the back end.

Parameters:

value - the Diffusion typed value

Returns:

the converted object

Throws:

PayloadConversionException - if the convertor fails to convert the value