org.springframework.cloud.stream.converter

Class AbstractFromMessageConverter

java.lang.Object

org.springframework.messaging.converter.AbstractMessageConverter

org.springframework.cloud.stream.converter.AbstractFromMessageConverter

All Implemented Interfaces:

org.springframework.messaging.converter.MessageConverter, org.springframework.messaging.converter.SmartMessageConverter

Direct Known Subclasses:

ByteArrayToStringMessageConverter, JavaToSerializedMessageConverter, JsonToPojoMessageConverter, JsonToTupleMessageConverter, PojoToJsonMessageConverter, PojoToStringMessageConverter, SerializedToJavaMessageConverter, StringToByteArrayMessageConverter, TupleToJsonMessageConverter

public abstract class AbstractFromMessageConverter
extends org.springframework.messaging.converter.AbstractMessageConverter

Base class for converters applied via Spring Integration 4.x data type channels. Extend this class to implement MessageConverters used with custom Message conversion. Only AbstractMessageConverter.fromMessage(org.springframework.messaging.Message<?>, java.lang.Class<?>) is supported.

Author:

David Turanski, Ilayaperumal Gopinathan, Marius Bogoevici

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger
protected List<org.springframework.util.MimeType>	targetMimeTypes

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFromMessageConverter(Collection<org.springframework.util.MimeType> targetMimeTypes)
protected	AbstractFromMessageConverter(Collection<org.springframework.util.MimeType> supportedSourceMimeTypes, Collection<org.springframework.util.MimeType> targetMimeTypes) Creates a converter that handles one or more content-type message headers and one or more target MIME types
protected	AbstractFromMessageConverter(Collection<org.springframework.util.MimeType> supportedSourceMimeTypes, org.springframework.util.MimeType targetMimeType) Creates a converter that handles one or more content-type message headers
protected	AbstractFromMessageConverter(org.springframework.util.MimeType targetMimeType) Creates a converter that ignores content-type message headers
protected	AbstractFromMessageConverter(org.springframework.util.MimeType supportedSourceMimeType, Collection<org.springframework.util.MimeType> targetMimeTypes) Creates a converter that requires a specific content-type message header and supports multiple target MIME types.
protected	AbstractFromMessageConverter(org.springframework.util.MimeType supportedSourceMimeType, org.springframework.util.MimeType targetMimeType) Creates a converter that requires a specific content-type message header

Method Summary

Modifier and Type	Method and Description
protected boolean	canConvertFrom(org.springframework.messaging.Message<?> message, Class<?> targetClass)
protected boolean	canConvertTo(Object payload, org.springframework.messaging.MessageHeaders headers) Not supported by default
Object	convertToInternal(Object payload, org.springframework.messaging.MessageHeaders headers, Object conversionHint) Not supported by default
protected abstract Class<?>[]	supportedPayloadTypes() Subclasses implement this to specify supported payload types
protected abstract Class<?>[]	supportedTargetTypes() Subclasses implement this to specify supported target types
protected boolean	supports(Class<?> clazz)
protected boolean	supportsPayloadType(Class<?> clazz)
boolean	supportsTargetMimeType(org.springframework.util.MimeType mimeType)

Methods inherited from class org.springframework.messaging.converter.AbstractMessageConverter

convertFromInternal, convertFromInternal, convertToInternal, fromMessage, fromMessage, getContentTypeResolver, getDefaultContentType, getMimeType, getSerializedPayloadClass, getSupportedMimeTypes, isStrictContentTypeMatch, setContentTypeResolver, setSerializedPayloadClass, setStrictContentTypeMatch, supportsMimeType, toMessage, toMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected final org.apache.commons.logging.Log logger

targetMimeTypes

protected final List<org.springframework.util.MimeType> targetMimeTypes

Constructor Detail

AbstractFromMessageConverter

protected AbstractFromMessageConverter(org.springframework.util.MimeType targetMimeType)

Creates a converter that ignores content-type message headers

Parameters:

targetMimeType - the required target type

AbstractFromMessageConverter

protected AbstractFromMessageConverter(Collection<org.springframework.util.MimeType> targetMimeTypes)

AbstractFromMessageConverter

protected AbstractFromMessageConverter(Collection<org.springframework.util.MimeType> supportedSourceMimeTypes,
                                       org.springframework.util.MimeType targetMimeType)

Creates a converter that handles one or more content-type message headers

Parameters:

supportedSourceMimeTypes - list of MimeType that may present in content-type header

targetMimeType - the required target type

AbstractFromMessageConverter

protected AbstractFromMessageConverter(Collection<org.springframework.util.MimeType> supportedSourceMimeTypes,
                                       Collection<org.springframework.util.MimeType> targetMimeTypes)

Creates a converter that handles one or more content-type message headers and one or more target MIME types

Parameters:

supportedSourceMimeTypes - a list of supported content types

targetMimeTypes - a list of supported target types

AbstractFromMessageConverter

protected AbstractFromMessageConverter(org.springframework.util.MimeType supportedSourceMimeType,
                                       org.springframework.util.MimeType targetMimeType)

Creates a converter that requires a specific content-type message header

Parameters:

supportedSourceMimeType - MimeType that must be present in content-type header

targetMimeType - the required target type

AbstractFromMessageConverter

protected AbstractFromMessageConverter(org.springframework.util.MimeType supportedSourceMimeType,
                                       Collection<org.springframework.util.MimeType> targetMimeTypes)

Creates a converter that requires a specific content-type message header and supports multiple target MIME types.

Parameters:

supportedSourceMimeType - MimeType that must be present in content-type header

targetMimeTypes - a list of supported target types

Method Detail

supportedTargetTypes

protected abstract Class<?>[] supportedTargetTypes()

Subclasses implement this to specify supported target types

Returns:

an array of supported classes or null if any target type is supported

supportedPayloadTypes

protected abstract Class<?>[] supportedPayloadTypes()

Subclasses implement this to specify supported payload types

Returns:

an array of supported classes or null if any target type is supported

supportsPayloadType

protected boolean supportsPayloadType(Class<?> clazz)

supports

protected boolean supports(Class<?> clazz)

Specified by:

supports in class org.springframework.messaging.converter.AbstractMessageConverter

canConvertFrom

protected boolean canConvertFrom(org.springframework.messaging.Message<?> message,
                                 Class<?> targetClass)

Overrides:

canConvertFrom in class org.springframework.messaging.converter.AbstractMessageConverter

supportsTargetMimeType

public boolean supportsTargetMimeType(org.springframework.util.MimeType mimeType)

canConvertTo

protected boolean canConvertTo(Object payload,
                               org.springframework.messaging.MessageHeaders headers)

Not supported by default

Overrides:

canConvertTo in class org.springframework.messaging.converter.AbstractMessageConverter

convertToInternal

public Object convertToInternal(Object payload,
                                org.springframework.messaging.MessageHeaders headers,
                                Object conversionHint)

Not supported by default

Overrides:

convertToInternal in class org.springframework.messaging.converter.AbstractMessageConverter