Package org.springframework.integration.transformer

Class PayloadDeserializingTransformer

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.transformer.AbstractTransformer

org.springframework.integration.transformer.AbstractPayloadTransformer<T,U>

org.springframework.integration.transformer.PayloadTypeConvertingTransformer<byte[],Object>

org.springframework.integration.transformer.PayloadDeserializingTransformer

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, ComponentSourceAware, ExpressionCapable, GenericTransformer<Message<?>,Message<?>>, NamedComponent, Transformer

public class PayloadDeserializingTransformer
extends PayloadTypeConvertingTransformer<byte[],Object>

Transformer that deserializes the inbound byte array payload to an object by delegating to a Converter<byte[], Object>. Default delegate is a AllowListDeserializingConverter using Java serialization.

The byte array payload must be a result of equivalent serialization.

Since:

1.0.1

Author:

Mark Fisher, Gary Russell, Artem Bilan, Glenn Renfro

Field Summary

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

Constructor	Description
PayloadDeserializingTransformer()	Instantiate based on the AllowListDeserializingConverter with the DefaultDeserializer.

Method Summary

Modifier and Type	Method	Description
void	addAllowedPatterns(String... patterns)	When using a AllowListDeserializingConverter (the default) add patterns for packages/classes that are allowed to be deserialized, in addition to the existing ones (by default the AllowListDeserializingConverter.DEFAULT_ALLOWED_PATTERNS).
String	getComponentType()
void	setAllowedPatterns(String... patterns)	When using a AllowListDeserializingConverter (the default) set patterns for packages/classes that are allowed to be deserialized.
void	setDeserializer(Deserializer<Object> deserializer)	Set a Deserializer to be wrapped into a new AllowListDeserializingConverter.

Methods inherited from class org.springframework.integration.transformer.PayloadTypeConvertingTransformer

doSetConverter, getConverter, onInit, setConverter, transformPayload

Methods inherited from class org.springframework.integration.transformer.AbstractPayloadTransformer

doTransform

Methods inherited from class org.springframework.integration.transformer.AbstractTransformer

transform

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Constructor Details

PayloadDeserializingTransformer

public PayloadDeserializingTransformer()

Instantiate based on the AllowListDeserializingConverter with the DefaultDeserializer.

Method Details

setDeserializer

public void setDeserializer(Deserializer<Object> deserializer)

Set a Deserializer to be wrapped into a new AllowListDeserializingConverter. The allowed patterns of the current AllowListDeserializingConverter, if any, are carried over to the new one.

Parameters:

deserializer - the deserializer to use.

setAllowedPatterns

public void setAllowedPatterns(String... patterns)

When using a AllowListDeserializingConverter (the default) set patterns for packages/classes that are allowed to be deserialized. A class can be fully qualified, or a wildcard '*' is allowed at the beginning or end of the class name. Examples: com.example.*, *.MyClass. Replaces all the existing patterns, including the AllowListDeserializingConverter.DEFAULT_ALLOWED_PATTERNS. Use addAllowedPatterns(String...) to keep the defaults.

Parameters:

patterns - the patterns.

Since:

5.4

addAllowedPatterns

public void addAllowedPatterns(String... patterns)

When using a AllowListDeserializingConverter (the default) add patterns for packages/classes that are allowed to be deserialized, in addition to the existing ones (by default the AllowListDeserializingConverter.DEFAULT_ALLOWED_PATTERNS).

Parameters:

patterns - the patterns to add.

Since:

7.2

See Also:

• setAllowedPatterns(String...)

getComponentType

public String getComponentType()

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class PayloadTypeConvertingTransformer<byte[],Object>