Package org.springframework.integration.transformer

Class FromProtobufTransformer

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.transformer.AbstractTransformer

org.springframework.integration.transformer.FromProtobufTransformer

All Implemented Interfaces:

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

public class FromProtobufTransformer
extends AbstractTransformer
implements BeanClassLoaderAware

A Protocol Buffer transformer to instantiate Message objects from either byte[] if content type is application/x-protobuf or from String in case of application/json content type.

Since:

6.1

Author:

Christian Tzolov

Field Summary

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

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

Constructor	Description
FromProtobufTransformer()	Construct an instance with the supplied default type to create.
FromProtobufTransformer(ProtobufMessageConverter protobufMessageConverter)	Construct an instance with the supplied default type and ProtobufMessageConverter instance.

Method Summary

Modifier and Type	Method	Description
protected Object	doTransform(Message<?> message)	Subclasses must implement this method to provide the transformation logic.
protected void	onInit()	Subclasses may implement this for initialization logic.
void	setBeanClassLoader(ClassLoader classLoader)
FromProtobufTransformer	setExpectedType(Class<? extends com.google.protobuf.Message> expectedType)	Set an expected protobuf class type.
FromProtobufTransformer	setExpectedTypeExpression(Expression expression)	Set an expression to evaluate against the message to determine the type.
FromProtobufTransformer	setExpectedTypeExpressionString(String expression)	Set an expression to evaluate against the message to determine the type id.

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, getComponentName, getComponentType, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Constructor Details

FromProtobufTransformer

public FromProtobufTransformer()

Construct an instance with the supplied default type to create.

FromProtobufTransformer

public FromProtobufTransformer(ProtobufMessageConverter protobufMessageConverter)

Construct an instance with the supplied default type and ProtobufMessageConverter instance.

Parameters:

protobufMessageConverter - the message converter used.

Method Details

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

setExpectedType

public FromProtobufTransformer setExpectedType(Class<? extends com.google.protobuf.Message> expectedType)

Set an expected protobuf class type. Mutually exclusive with setExpectedTypeExpression(org.springframework.expression.Expression) and setExpectedTypeExpressionString(java.lang.String).

Parameters:

expectedType - expected protobuf class type.

Returns:

updated FromProtobufTransformer instance.

setExpectedTypeExpressionString

public FromProtobufTransformer setExpectedTypeExpressionString(String expression)

Set an expression to evaluate against the message to determine the type id. Defaults toheaders['proto_type']. Mutually exclusive with setExpectedType(java.lang.Class<? extends com.google.protobuf.Message>) and setExpectedTypeExpression(org.springframework.expression.Expression).

Parameters:

expression - the expression.

Returns:

updated FromProtobufTransformer instance.

setExpectedTypeExpression

public FromProtobufTransformer setExpectedTypeExpression(Expression expression)

Set an expression to evaluate against the message to determine the type. Default headers['proto_type']. Mutually exclusive with setExpectedType(java.lang.Class<? extends com.google.protobuf.Message>) and setExpectedTypeExpressionString(java.lang.String).

Parameters:

expression - the expression.

Returns:

updated FromProtobufTransformer instance.

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

doTransform

protected Object doTransform(Message<?> message)

Description copied from class: AbstractTransformer

Subclasses must implement this method to provide the transformation logic. If the return value is itself a Message, it will be used as the result. Otherwise, any non-null return value will be used as the payload of the result Message.

Specified by:

doTransform in class AbstractTransformer

Parameters:

message - The message.

Returns:

The result of the transformation.