org.eclipse.ditto.services.connectivity.mapping

Interface MessageMapper

All Known Implementing Classes:

AbstractMessageMapper, ConnectionStatusMessageMapper, DittoMessageMapper, NormalizedMessageMapper

public interface MessageMapper

Defines a message mapper which maps a ExternalMessage to a Adaptable and vice versa.

Usually a mapper is bound to a content type.

A message mapper is considered to be dynamically instantiated at runtime, it therefore can only be configured at runtime.

Method Summary

Modifier and Type	Method and Description
void	configure(MappingConfig mappingConfig, MessageMapperConfiguration configuration) Applies configuration for this MessageMapper.
static Optional<String>	findContentType(org.eclipse.ditto.protocoladapter.Adaptable adaptable) Finds the content-type header from the passed Adaptable.
static Optional<String>	findContentType(ExternalMessage externalMessage) Finds the content-type header from the passed ExternalMessage.
Collection<String>	getContentTypeBlacklist() Returns a blacklist of content-types which shall not be handled by this message mapper.
default Map<String,String>	getDefaultOptions()
String	getId() Returns a unique ID of this mapper that can be used in sources and targets to reference this mapper.
List<ExternalMessage>	map(org.eclipse.ditto.protocoladapter.Adaptable adaptable) Maps an Adaptable to an ExternalMessage
List<org.eclipse.ditto.protocoladapter.Adaptable>	map(ExternalMessage message) Maps an ExternalMessage to an Adaptable

Method Detail

getId

String getId()

Returns a unique ID of this mapper that can be used in sources and targets to reference this mapper.

Returns:

a unique ID of this mapper.

getContentTypeBlacklist

Collection<String> getContentTypeBlacklist()

Returns a blacklist of content-types which shall not be handled by this message mapper. Is determined from the passed in MessageMapperConfiguration in configure(MappingConfig, MessageMapperConfiguration).

Returns:

a blacklist of content-types which shall not be handled by this message mapper.

configure

void configure(MappingConfig mappingConfig,
               MessageMapperConfiguration configuration)

Applies configuration for this MessageMapper.

Parameters:

mappingConfig - the config scoped to the mapping section "ditto.connectivity.mapping".

configuration - the configuration to apply.

Throws:

org.eclipse.ditto.model.connectivity.MessageMapperConfigurationInvalidException - if configuration is invalid.

org.eclipse.ditto.model.connectivity.MessageMapperConfigurationFailedException - if the configuration failed for a mapper specific reason.

map

List<org.eclipse.ditto.protocoladapter.Adaptable> map(ExternalMessage message)

Maps an ExternalMessage to an Adaptable

Parameters:

message - the ExternalMessage to map

Returns:

the mapped Adaptable or an empty List if the ExternalMessage should not be mapped after all

Throws:

org.eclipse.ditto.model.connectivity.MessageMappingFailedException - if the given message can not be mapped

org.eclipse.ditto.model.base.exceptions.DittoRuntimeException - if anything during Ditto Adaptable creation went wrong

map

List<ExternalMessage> map(org.eclipse.ditto.protocoladapter.Adaptable adaptable)

Maps an Adaptable to an ExternalMessage

Parameters:

adaptable - the Adaptable to map

Returns:

the ExternalMessage or an empty List if the Adaptable should not be mapped after all

Throws:

org.eclipse.ditto.model.connectivity.MessageMappingFailedException - if the given adaptable can not be mapped

getDefaultOptions

default Map<String,String> getDefaultOptions()

Returns:

a map of default options for this mapper

findContentType

static Optional<String> findContentType(ExternalMessage externalMessage)

Finds the content-type header from the passed ExternalMessage.

Parameters:

externalMessage - the ExternalMessage to look for the content-type header in

Returns:

the optional content-type value

findContentType

static Optional<String> findContentType(org.eclipse.ditto.protocoladapter.Adaptable adaptable)

Finds the content-type header from the passed Adaptable.

Parameters:

adaptable - the Adaptable to look for the content-type header in

Returns:

the optional content-type value