org.eclipse.ditto.services.connectivity.mapping

Annotation Type PayloadMapper

@Target(value=TYPE)
 @IndexAnnotated
 @Retention(value=RUNTIME)
public @interface PayloadMapper

Classes annotated with PayloadMapper are indexed and loaded on startup to be referenced by its alias in payload mapping definitions of a Connection. If the mapper requires no MappingContext for initialization it can also be directly used in the list of mappings of a Source or a Target using one of the defined aliases.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	alias

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	requiresMandatoryConfiguration

Element Detail

alias

public abstract String[] alias

Returns:

the aliases which can be used to reference this PayloadMapper.

requiresMandatoryConfiguration

public abstract boolean requiresMandatoryConfiguration

Returns:

true if the mapper requires mandatory config options for initialization, i.e. it cannot be used directly as a mapping without providing the MappingContext.getOptions().

Default:

false