org.springframework.xd.dirt.integration.bus.converter

Class AbstractFromMessageConverter

java.lang.Object

org.springframework.messaging.converter.AbstractMessageConverter

org.springframework.xd.dirt.integration.bus.converter.AbstractFromMessageConverter

All Implemented Interfaces:

org.springframework.messaging.converter.MessageConverter

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 Spring XD Message conversion. Only AbstractMessageConverter.fromMessage(org.springframework.messaging.Message<?>, java.lang.Class<?>) is supported.

Author:

David Turanski

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger
protected java.util.List<org.springframework.util.MimeType>	targetMimeTypes

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFromMessageConverter(java.util.Collection<org.springframework.util.MimeType> targetMimeTypes)
protected	AbstractFromMessageConverter(java.util.Collection<org.springframework.util.MimeType> supportedSourceMimeTypes, java.util.Collection<org.springframework.util.MimeType> targetMimeTypes, org.springframework.messaging.converter.ContentTypeResolver contentTypeResolver) Creates a converter that handles one or more content-type message headers and one or more target MIME types
protected	AbstractFromMessageConverter(java.util.Collection<org.springframework.util.MimeType> supportedSourceMimeTypes, org.springframework.util.MimeType targetMimeType, org.springframework.messaging.converter.ContentTypeResolver contentTypeResolver) 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, java.util.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

Methods

Modifier and Type	Method and Description
protected org.springframework.messaging.Message<?>	buildConvertedMessage(java.lang.Object payload, org.springframework.messaging.MessageHeaders headers, org.springframework.util.MimeType contentType) Convenience method to construct a converted message
protected boolean	canConvertFrom(org.springframework.messaging.Message<?> message, java.lang.Class<?> targetClass)
protected boolean	canConvertTo(java.lang.Object payload, org.springframework.messaging.MessageHeaders headers) Not supported by default
java.lang.Object	convertToInternal(java.lang.Object payload, org.springframework.messaging.MessageHeaders headers) Not supported by default
void	setContentTypeResolver(org.springframework.messaging.converter.ContentTypeResolver resolver)
protected abstract java.lang.Class<?>[]	supportedPayloadTypes() Subclasses implement this to specify supported payload types
protected abstract java.lang.Class<?>[]	supportedTargetTypes() Subclasses implement this to specify supported target types
protected boolean	supports(java.lang.Class<?> clazz)
protected boolean	supportsPayloadType(java.lang.Class<?> clazz)
boolean	supportsTargetMimeType(org.springframework.util.MimeType mimeType)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected org.slf4j.Logger logger

targetMimeTypes

protected final java.util.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 (outputType or inputType for XD)

AbstractFromMessageConverter

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

AbstractFromMessageConverter

protected AbstractFromMessageConverter(java.util.Collection<org.springframework.util.MimeType> supportedSourceMimeTypes,
                            org.springframework.util.MimeType targetMimeType,
                            org.springframework.messaging.converter.ContentTypeResolver contentTypeResolver)

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 (outputType or inputType for XD)

AbstractFromMessageConverter

protected AbstractFromMessageConverter(java.util.Collection<org.springframework.util.MimeType> supportedSourceMimeTypes,
                            java.util.Collection<org.springframework.util.MimeType> targetMimeTypes,
                            org.springframework.messaging.converter.ContentTypeResolver contentTypeResolver)

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 (outputType or inputType for XD)

contentTypeResolver - the ContentTypeResolver to use

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 (outputType or inputType for XD)

AbstractFromMessageConverter

protected AbstractFromMessageConverter(org.springframework.util.MimeType supportedSourceMimeType,
                            java.util.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 (outputType or inputType for XD)

Method Detail

supportedTargetTypes

protected abstract java.lang.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 java.lang.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(java.lang.Class<?> clazz)

supports

protected boolean supports(java.lang.Class<?> clazz)

Specified by:

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

canConvertFrom

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

Overrides:

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

supportsTargetMimeType

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

setContentTypeResolver

public void setContentTypeResolver(org.springframework.messaging.converter.ContentTypeResolver resolver)

Overrides:

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

canConvertTo

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

Not supported by default

Overrides:

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

convertToInternal

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

Not supported by default

Specified by:

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

buildConvertedMessage

protected final org.springframework.messaging.Message<?> buildConvertedMessage(java.lang.Object payload,
                                                             org.springframework.messaging.MessageHeaders headers,
                                                             org.springframework.util.MimeType contentType)

Convenience method to construct a converted message

Parameters:

payload - the converted payload

headers - the existing message headers

contentType - the value of the content-type header

Returns:

the converted message