com.adaptris.core.services.system

Class DefaultCommandBuilder

java.lang.Object

com.adaptris.core.services.system.DefaultCommandBuilder

All Implemented Interfaces:

CommandBuilder

public class DefaultCommandBuilder
extends java.lang.Object
implements CommandBuilder

Default implementation of CommandBuilder

Constructor Summary

Constructors

Constructor and Description
DefaultCommandBuilder()

Method Summary

Modifier and Type	Method and Description
void	addArgument(CommandArgument arg)
void	addEnvironmentMetadataKey(java.lang.String key)
org.apache.commons.exec.Executor	configure(org.apache.commons.exec.Executor exe) Configure the Executor.
org.apache.commons.exec.CommandLine	createCommandLine(AdaptrisMessage msg) Build a ProcessBuilder object from the available data.
java.util.Map<java.lang.String,java.lang.String>	createEnvironment(AdaptrisMessage msg) Create the environment when executing the process.
java.util.List<CommandArgument>	getArguments()
java.util.List<java.lang.String>	getEnvironmentMetadataKeys()
KeyValuePairSet	getEnvironmentProperties()
java.lang.String	getExecutablePath()
java.lang.Boolean	getQuoteHandling()
java.lang.Integer	getSuccessExitCode()
java.lang.String	getWorkingDirectory()
void	setArguments(java.util.List<CommandArgument> l) Specifies a list of command line arguments to be passed into the executable
void	setEnvironmentMetadataKeys(java.util.List<java.lang.String> l) Specifies any metadata keys that should be specified as Environment Variables.
void	setEnvironmentProperties(KeyValuePairSet env) Specifies any fixed value environment variables that are necessary.
void	setExecutablePath(java.lang.String executable) Specifies the executable to be invoke.
void	setQuoteHandling(java.lang.Boolean b) Specify whether to handle quotes or not.
void	setSuccessExitCode(java.lang.Integer i) Set the exit code value that is considered successful.
void	setWorkingDirectory(java.lang.String wd) Specify the working directory for the process.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCommandBuilder

public DefaultCommandBuilder()

Method Detail

createCommandLine

public org.apache.commons.exec.CommandLine createCommandLine(AdaptrisMessage msg)

Description copied from interface: CommandBuilder

Build a ProcessBuilder object from the available data.

Specified by:

createCommandLine in interface CommandBuilder

Parameters:

msg - the AdaptrisMessage

Returns:

a ProcessBuilder

createEnvironment

public java.util.Map<java.lang.String,java.lang.String> createEnvironment(AdaptrisMessage msg)

Description copied from interface: CommandBuilder

Create the environment when executing the process.

Specified by:

createEnvironment in interface CommandBuilder

Parameters:

msg - the message.

Returns:

the environment for Executor.execute(CommandLine, Map). If null, then the default environment is used.

configure

public org.apache.commons.exec.Executor configure(org.apache.commons.exec.Executor exe)

Description copied from interface: CommandBuilder

Configure the Executor.

Specified by:

configure in interface CommandBuilder

Parameters:

exe - the Executor to configure.

Returns:

the same executor.

getEnvironmentMetadataKeys

public java.util.List<java.lang.String> getEnvironmentMetadataKeys()

setEnvironmentMetadataKeys

public void setEnvironmentMetadataKeys(java.util.List<java.lang.String> l)

Specifies any metadata keys that should be specified as Environment Variables.

Each key, if available as metadata, will become the environment variable with each corresponding value, the value.

Parameters:

l -

addEnvironmentMetadataKey

public void addEnvironmentMetadataKey(java.lang.String key)

getWorkingDirectory

public java.lang.String getWorkingDirectory()

setWorkingDirectory

public void setWorkingDirectory(java.lang.String wd)

Specify the working directory for the process.

Parameters:

wd - the working directory; defaults to null

getEnvironmentProperties

public KeyValuePairSet getEnvironmentProperties()

setEnvironmentProperties

public void setEnvironmentProperties(KeyValuePairSet env)

Specifies any fixed value environment variables that are necessary.

Parameters:

env -

getExecutablePath

public java.lang.String getExecutablePath()

setExecutablePath

public void setExecutablePath(java.lang.String executable)

Specifies the executable to be invoke.

This can be an absolute path or else simply the name of an executable on the PATH. Examples might be "/bin/ls" or "echo" on Unix. Note that this defaults to null, which might create undefined behaviour.

Parameters:

executable -

getArguments

public java.util.List<CommandArgument> getArguments()

setArguments

public void setArguments(java.util.List<CommandArgument> l)

Specifies a list of command line arguments to be passed into the executable

Parameters:

l - the arguments

addArgument

public void addArgument(CommandArgument arg)

getSuccessExitCode

public java.lang.Integer getSuccessExitCode()

setSuccessExitCode

public void setSuccessExitCode(java.lang.Integer i)

Set the exit code value that is considered successful.

Parameters:

i - the exit code that is successful; defaults to 0 if not explicitly set.

getQuoteHandling

public java.lang.Boolean getQuoteHandling()

setQuoteHandling

public void setQuoteHandling(java.lang.Boolean b)

Specify whether to handle quotes or not.

If any argument doesn't include spaces or quotes, return it as is. If it contains double quotes, use single quotes - else surround the argument by double quotes.

Parameters:

b - true or false, if not specified defaults to false.

See Also:

CommandLine.addArgument(String, boolean)