org.arl.fjage.shell

Class ShellExecReq

java.lang.Object

org.arl.fjage.Message

org.arl.fjage.shell.ShellExecReq

All Implemented Interfaces:

java.io.Serializable

public class ShellExecReq
extends Message

Request to execute shell command/script.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.arl.fjage.Message

inReplyTo, msgID, perf, recipient, sender, sentAt

Constructor Summary

Constructors

Constructor and Description
ShellExecReq() Create an empty request for shell command.
ShellExecReq(AgentID to) Create an empty request for shell command.
ShellExecReq(AgentID to, java.io.File script) Create request to execute shell script.
ShellExecReq(AgentID to, java.io.File script, java.util.List<java.lang.String> args) Create request to execute shell script with arguments.
ShellExecReq(AgentID to, java.lang.String cmd) Create request for shell command.
ShellExecReq(java.io.File script) Create request to execute shell script.
ShellExecReq(java.io.File script, java.util.List<java.lang.String> args) Create request to execute shell script with arguments.
ShellExecReq(java.lang.String cmd) Create request for shell command.

Method Summary

Modifier and Type	Method and Description
boolean	getAns() Get the flag that indicates whether the output from the command should be returned in the response, when possible.
java.lang.String	getCommand() Get the command to execute.
java.util.List<java.lang.String>	getScriptArgs() Get the script arguments.
java.io.File	getScriptFile() Get the script to execute.
boolean	isScript() Check if the request is for a script.
void	setAns(boolean ans) Set a flag to indicate that the output from the command should be returned in the response, when possible.
void	setCommand(java.lang.String cmd) Set the command to execute.
void	setScript(java.io.File script) Set the command to execute.
void	setScript(java.io.File script, java.util.List<java.lang.String> args) Set the command to execute.

Methods inherited from class org.arl.fjage.Message

getInReplyTo, getJsonCache, getMessageID, getPerformative, getRecipient, getSender, getSentAt, setInReplyTo, setJsonCache, setMessageID, setPerformative, setRecipient, setSender, setSentAt, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ShellExecReq

public ShellExecReq()

Create an empty request for shell command.

ShellExecReq

public ShellExecReq(AgentID to)

Create an empty request for shell command.

Parameters:

to - shell agent id.

ShellExecReq

public ShellExecReq(java.lang.String cmd)

Create request for shell command.

Parameters:

cmd - command to execute.

ShellExecReq

public ShellExecReq(AgentID to,
                    java.lang.String cmd)

Create request for shell command.

Parameters:

to - shell agent id.

cmd - command to execute.

ShellExecReq

public ShellExecReq(java.io.File script)

Create request to execute shell script.

Parameters:

script - script file to execute.

ShellExecReq

public ShellExecReq(AgentID to,
                    java.io.File script)

Create request to execute shell script.

Parameters:

to - shell agent id.

script - script file to execute.

ShellExecReq

public ShellExecReq(java.io.File script,
                    java.util.List<java.lang.String> args)

Create request to execute shell script with arguments.

Parameters:

script - script file to execute.

args - arguments to pass to script.

ShellExecReq

public ShellExecReq(AgentID to,
                    java.io.File script,
                    java.util.List<java.lang.String> args)

Create request to execute shell script with arguments.

Parameters:

to - shell agent id.

script - script file to execute.

args - arguments to pass to script.

Method Detail

setCommand

public void setCommand(java.lang.String cmd)

Set the command to execute.

Parameters:

cmd - command to execute.

getCommand

public java.lang.String getCommand()

Get the command to execute.

Returns:

command to execute, null if none.

setScript

public void setScript(java.io.File script)

Set the command to execute.

Parameters:

script - script file to execute.

setScript

public void setScript(java.io.File script,
                      java.util.List<java.lang.String> args)

Set the command to execute.

Parameters:

script - script file to execute.

args - arguments to pass to script.

getScriptFile

public java.io.File getScriptFile()

Get the script to execute.

Returns:

script to execute, null if none.

getScriptArgs

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

Get the script arguments.

Returns:

script arguments, null if none.

isScript

public boolean isScript()

Check if the request is for a script.

Returns:

true if request is for a script, false if it is for a command.

setAns

public void setAns(boolean ans)

Set a flag to indicate that the output from the command should be returned in the response, when possible.

Parameters:

ans - true to get output, false otherwise

getAns

public boolean getAns()

Get the flag that indicates whether the output from the command should be returned in the response, when possible.

Returns:

true to get output, false otherwise