org.springframework.xd.extension.process

Class ShellCommandProcessor

java.lang.Object

org.springframework.xd.extension.process.ShellCommandProcessor

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle

public class ShellCommandProcessor
extends java.lang.Object
implements org.springframework.context.Lifecycle, org.springframework.beans.factory.InitializingBean

Creates a process to run a shell command and communicate with it using String payloads over stdin and stdout.

Author:

David Turanski, Gary Russell

Constructor Summary

Constructors

Constructor and Description
ShellCommandProcessor(org.springframework.integration.ip.tcp.serializer.AbstractByteArraySerializer serializer, java.lang.String command) Creates a process to invoke a shell command to send and receive messages from the processes using the process's stdin and stdout.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
boolean	isRunning()
java.lang.String	receive() Receive data from the process.
void	send(java.lang.String data) Send data as a String to stdin.
java.lang.String	sendAndReceive(java.lang.String data) Send and receive data in request/response fashion.
void	setCharset(java.lang.String charset) Set the charset name for String encoding.
void	setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment) A map containing environment variables to add to the process environment.
void	setRedirectErrorStream(boolean redirectErrorStream) Set to true to redirect stderr to stdout.
void	setWorkingDirectory(java.lang.String workingDirectory) Set the process working directory
void	start() Start the process.
void	stop() Stop the process and close streams.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShellCommandProcessor

public ShellCommandProcessor(org.springframework.integration.ip.tcp.serializer.AbstractByteArraySerializer serializer,
                     java.lang.String command)

Creates a process to invoke a shell command to send and receive messages from the processes using the process's stdin and stdout.

Parameters:

serializer - an AbstractByteArraySerializer to delimit messages

command - the shell command with command line arguments as separate strings

Method Detail

start

public void start()

Start the process.

Specified by:

start in interface org.springframework.context.Lifecycle

receive

public java.lang.String receive()

Receive data from the process.

Returns:

any available data from stdout

send

public void send(java.lang.String data)

Send data as a String to stdin.

Parameters:

data - the data

sendAndReceive

public java.lang.String sendAndReceive(java.lang.String data)

Send and receive data in request/response fashion.

Parameters:

data - the input

Returns:

the output

stop

public void stop()

Stop the process and close streams.

Specified by:

stop in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

setRedirectErrorStream

public void setRedirectErrorStream(boolean redirectErrorStream)

Set to true to redirect stderr to stdout.

Parameters:

redirectErrorStream -

setEnvironment

public void setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment)

A map containing environment variables to add to the process environment.

Parameters:

environment -

setWorkingDirectory

public void setWorkingDirectory(java.lang.String workingDirectory)

Set the process working directory

Parameters:

workingDirectory - the file path

setCharset

public void setCharset(java.lang.String charset)

Set the charset name for String encoding. Default is UTF-8

Parameters:

charset - the charset name

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception