org.eclipse.ditto.services.connectivity.mapping

Interface MessageMapperConfiguration

All Known Subinterfaces:

JavaScriptMessageMapperConfiguration

All Known Implementing Classes:

DefaultMessageMapperConfiguration

public interface MessageMapperConfiguration

Configuration properties for a MessageMapper.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessageMapperConfiguration.Builder<T extends MessageMapperConfiguration> Builder for MessageMapperConfiguration instances to be used as a base for a more concrete builder.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE_BLACKLIST The key of the mapper configuration which all mappers share: A comma separated blacklist of content-types which shall not be handled by the mapper which is configured.

Method Summary

Modifier and Type	Method and Description
default Optional<String>	findProperty(String propertyName) Searches the configuration for a specific property.
default Collection<String>	getContentTypeBlacklist() Determines the content-type blacklist for this mapper configuration.
String	getId()
Map<String,String>	getProperties() Returns the configuration properties as Map.
default String	getProperty(String propertyName) Extracts a required property from the configuration and fails with an exception if missing.

Field Detail

CONTENT_TYPE_BLACKLIST

static final String CONTENT_TYPE_BLACKLIST

The key of the mapper configuration which all mappers share: A comma separated blacklist of content-types which shall not be handled by the mapper which is configured.

See Also:

Constant Field Values

Method Detail

getId

String getId()

Returns:

the ID of the mapping

getProperties

Map<String,String> getProperties()

Returns the configuration properties as Map.

Returns:

an unmodifiable Map containing the configuration properties.

findProperty

default Optional<String> findProperty(String propertyName)

Searches the configuration for a specific property.

Parameters:

propertyName - the property name.

Returns:

the property if present.

getProperty

default String getProperty(String propertyName)

Extracts a required property from the configuration and fails with an exception if missing.

Parameters:

propertyName - the property name.

Returns:

the property value.

Throws:

org.eclipse.ditto.model.connectivity.MessageMapperConfigurationInvalidException - if no value for the the requested property name is present

getContentTypeBlacklist

default Collection<String> getContentTypeBlacklist()

Determines the content-type blacklist for this mapper configuration. All content-types defined in the blacklist are not handled by the mapper configured by this configuration.

Returns:

the content-type blacklist.