Package org.springframework.integration.groovy

Class GroovyCommandMessageProcessor

java.lang.Object

org.springframework.integration.scripting.AbstractScriptExecutingMessageProcessor<Object>

org.springframework.integration.groovy.GroovyCommandMessageProcessor

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, MessageProcessor<Object>, IntegrationPattern

@Deprecated(since="6.4",
            forRemoval=true)
public class GroovyCommandMessageProcessor
extends AbstractScriptExecutingMessageProcessor<Object>
implements IntegrationPattern

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of ControlBusMessageProcessor

Since:

2.0

Author:

Dave Syer, Mark Fisher, Oleg Zhurakousky, Artem Bilan, Stefan Reuter, Gary Russell

Constructor Summary

Constructors

Constructor	Description
GroovyCommandMessageProcessor()	Deprecated, for removal: This API element is subject to removal in a future version. Creates a GroovyCommandMessageProcessor that will use the DefaultScriptVariableGenerator.
GroovyCommandMessageProcessor(groovy.lang.Binding binding)	Deprecated, for removal: This API element is subject to removal in a future version. Creates a GroovyCommandMessageProcessor that will use the DefaultScriptVariableGenerator and provided Binding.
GroovyCommandMessageProcessor(groovy.lang.Binding binding, ScriptVariableGenerator scriptVariableGenerator)	Deprecated, for removal: This API element is subject to removal in a future version. Creates a GroovyCommandMessageProcessor that will use the provided ScriptVariableGenerator and Binding.
GroovyCommandMessageProcessor(ScriptVariableGenerator scriptVariableGenerator)	Deprecated, for removal: This API element is subject to removal in a future version. Creates a GroovyCommandMessageProcessor that will use the provided ScriptVariableGenerator.

Method Summary

Modifier and Type	Method	Description
protected Object	executeScript(ScriptSource scriptSource, Map<String,Object> variables)	Deprecated, for removal: This API element is subject to removal in a future version. Subclasses must implement this method.
protected String	generateScriptName(Message<?> message)	Deprecated, for removal: This API element is subject to removal in a future version.
IntegrationPatternType	getIntegrationPatternType()	Deprecated, for removal: This API element is subject to removal in a future version. Return a pattern type this component implements.
protected ScriptSource	getScriptSource(Message<?> message)	Deprecated, for removal: This API element is subject to removal in a future version. Subclasses must implement this method to create a script source, optionally using the message to locate or create the script.
void	setCustomizer(GroovyObjectCustomizer customizer)	Deprecated, for removal: This API element is subject to removal in a future version. Sets a GroovyObjectCustomizer for this processor.

Methods inherited from class org.springframework.integration.scripting.AbstractScriptExecutingMessageProcessor

getBeanClassLoader, getBeanFactory, getScriptVariableGenerator, processMessage, setBeanClassLoader, setBeanFactory

Methods inherited from class java.lang.Object

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

Constructor Details

GroovyCommandMessageProcessor

public GroovyCommandMessageProcessor()

Deprecated, for removal: This API element is subject to removal in a future version.

Creates a GroovyCommandMessageProcessor that will use the DefaultScriptVariableGenerator.

GroovyCommandMessageProcessor

public GroovyCommandMessageProcessor(ScriptVariableGenerator scriptVariableGenerator)

Deprecated, for removal: This API element is subject to removal in a future version.

Creates a GroovyCommandMessageProcessor that will use the provided ScriptVariableGenerator.

Parameters:

scriptVariableGenerator - The variable generator.

GroovyCommandMessageProcessor

public GroovyCommandMessageProcessor(groovy.lang.Binding binding)

Deprecated, for removal: This API element is subject to removal in a future version.

Creates a GroovyCommandMessageProcessor that will use the DefaultScriptVariableGenerator and provided Binding. Provided 'binding' will be used in the BindingOverwriteGroovyObjectCustomizerDecorator to overwrite original Groovy Script 'binding'.

Parameters:

binding - The binding.

GroovyCommandMessageProcessor

public GroovyCommandMessageProcessor(groovy.lang.Binding binding,
 ScriptVariableGenerator scriptVariableGenerator)

Deprecated, for removal: This API element is subject to removal in a future version.

Creates a GroovyCommandMessageProcessor that will use the provided ScriptVariableGenerator and Binding. Provided 'binding' will be used in the BindingOverwriteGroovyObjectCustomizerDecorator to overwrite original Groovy Script 'binding'.

Parameters:

binding - The binding.

scriptVariableGenerator - The variable generator.

Method Details

setCustomizer

public void setCustomizer(GroovyObjectCustomizer customizer)

Deprecated, for removal: This API element is subject to removal in a future version.

Sets a GroovyObjectCustomizer for this processor.

Parameters:

customizer - The customizer.

getIntegrationPatternType

public IntegrationPatternType getIntegrationPatternType()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: IntegrationPattern

Return a pattern type this component implements.

Specified by:

getIntegrationPatternType in interface IntegrationPattern

Returns:

the IntegrationPatternType this component implements.

getScriptSource

protected ScriptSource getScriptSource(Message<?> message)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: AbstractScriptExecutingMessageProcessor

Subclasses must implement this method to create a script source, optionally using the message to locate or create the script.

Specified by:

getScriptSource in class AbstractScriptExecutingMessageProcessor<Object>

Parameters:

message - the message being processed

Returns:

a ScriptSource to use to create a script

executeScript

protected Object executeScript(ScriptSource scriptSource,
 Map<String,Object> variables)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: AbstractScriptExecutingMessageProcessor

Subclasses must implement this method. In doing so, the execution context for the script should be populated with the provided script variables.

Specified by:

executeScript in class AbstractScriptExecutingMessageProcessor<Object>

Parameters:

scriptSource - The script source.

variables - The variables.

Returns:

The result of the execution.

generateScriptName

protected String generateScriptName(Message<?> message)

Deprecated, for removal: This API element is subject to removal in a future version.