org.eclipse.ditto.services.connectivity.mapping

Interface MessageMapperFactory

All Known Implementing Classes:

DefaultMessageMapperFactory

public interface MessageMapperFactory

Instantiates MessageMapper and MessageMapperRegistry instances from MappingContext information.

Method Summary

Modifier and Type	Method and Description
Optional<MessageMapper>	mapperOf(String mapperId, org.eclipse.ditto.model.connectivity.MappingContext context) Creates an configures a MessageMapper instance of the given context.
MessageMapperRegistry	registryOf(org.eclipse.ditto.model.connectivity.MappingContext defaultContext, org.eclipse.ditto.model.connectivity.PayloadMappingDefinition mappingDefinitions) Creates a MessageMapperRegistry.

Method Detail

mapperOf

Optional<MessageMapper> mapperOf(String mapperId,
                                 org.eclipse.ditto.model.connectivity.MappingContext context)

Creates an configures a MessageMapper instance of the given context. It is possible, that there is no mapper available for a specific context.

Parameters:

mapperId - the id of this mapper

context - the mapping context containing the type and configuration of the mapper

Returns:

the mapper

Throws:

NullPointerException - if the context is null

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

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

registryOf

MessageMapperRegistry registryOf(org.eclipse.ditto.model.connectivity.MappingContext defaultContext,
                                 org.eclipse.ditto.model.connectivity.PayloadMappingDefinition mappingDefinitions)

Creates a MessageMapperRegistry. Mappers that are not available will not be added to the registry.

Parameters:

defaultContext - the context used to instantiate the default mapper

mappingDefinitions - the mapping definitions used to instantiate the registry mapper

Returns:

the registry

Throws:

NullPointerException - if a parameters is null

IllegalArgumentException - if the default mapper could not be instantiated

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

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