com.neurosys.shell

Class ShellTransformer

java.lang.Object

com.neurosys.shell.ShellTransformer

All Implemented Interfaces:

org.apache.commons.collections.Transformer

public class ShellTransformer
extends Object
implements org.apache.commons.collections.Transformer

Execute OS Shell commands via a ProcessBuilder

One can pass an Array or List of Strings as additional parameters @ runtime
If the input is a Map then each entry will be passed as <key>:<value>

The error streamed is merged with the standard output by default. If you wish to handle shell errors that are not naturally causing an exception, one can rely on exit code values greater than 0. i.e. 1 or above represents an error.

Author:

Arjun Dhar

Constructor Summary

Constructors

Constructor and Description
ShellTransformer()
ShellTransformer(String commandPath)

Method Summary

Modifier and Type	Method and Description
String	getCommandPath() Absolute path to the command like D:/tmp/test.bat
File	getDirectory()
Map<String,String>	getEnvironment() Environment variables needed for the Shell task to execute
boolean	isWaitForProcessEnd()
void	setCommandPath(String commandPath) Absolute path to the command like D:/tmp/test.bat
void	setDirectory(File directory)
void	setEnvironment(Map<String,String> environment) Environment variables needed for the Shell task to execute
void	setWaitForProcessEnd(boolean waitForProcessEnd)
Object	transform(Object input)

Methods inherited from class java.lang.Object

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

Constructor Detail

ShellTransformer

public ShellTransformer()

ShellTransformer

public ShellTransformer(String commandPath)

Method Detail

transform

public Object transform(Object input)

Specified by:

transform in interface org.apache.commons.collections.Transformer

getCommandPath

public String getCommandPath()

Absolute path to the command like D:/tmp/test.bat

setCommandPath

public void setCommandPath(String commandPath)

Absolute path to the command like D:/tmp/test.bat

getEnvironment

public Map<String,String> getEnvironment()

Environment variables needed for the Shell task to execute

Can be null:

true

Default value:

null

setEnvironment

public void setEnvironment(Map<String,String> environment)

Environment variables needed for the Shell task to execute

Can be null:

true

Default value:

null

isWaitForProcessEnd

public boolean isWaitForProcessEnd()

See Also:

; if true will wait for the Process to end
Please note this does NOT guarantee a synchronous or asynchronous execution. It also depends on the script. More often than not you may find the process executing Synchronously irrespective. One may want to wrap this {@link Transformer} in an Asynchronous {@link Transformer} for guaranteed asynch execution.

setWaitForProcessEnd

public void setWaitForProcessEnd(boolean waitForProcessEnd)

See Also:

; if true will wait for the Process to end
Please note this does NOT guarantee a synchronous or asynchronous execution. It also depends on the script. More often than not you may find the process executing Synchronously irrespective. One may want to wrap this {@link Transformer} in an Asynchronous {@link Transformer} for guaranteed asynch execution.

getDirectory

public File getDirectory()

See Also:

ProcessBuilder#directory(File)}

Can be null:

true

Default value:

null

setDirectory

public void setDirectory(File directory)

See Also:

ProcessBuilder#directory(File)}

Can be null:

true

Default value:

null