org.rhq.enterprise.client.commands
Class ScriptCommand

java.lang.Object
  org.rhq.enterprise.client.commands.ScriptCommand

All Implemented Interfaces:

ClientCommand

public class ScriptCommand
extends Object
implements ClientCommand

Author:

Greg Hinkle, Lukas Krejci

Field Summary

Fields inherited from interface org.rhq.enterprise.client.commands.ClientCommand

COMMANDS

Constructor Summary

ScriptCommand()

Method Summary

boolean	execute(ClientMain client, String[] args) Executes the agent prompt command with the given arguments.
ScriptContext	getContext()
String	getDetailedHelp() Returns a detailed help message to describe to the user what the command's syntax is and any detailed information that is useful to the user that wants to use this command.
String	getHelp() Returns a help summary to describe to the user what the prompt command does and its purpose.
String	getPromptCommandString() All implementations must indicate what the prompt command is that will trigger its execution.
ScriptEngine	getScriptEngine()
String	getSyntax() Returns a one-line usage string to describe the syntax of the command including all optional and required arguments.
void	initClient(ClientMain client)

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptCommand

public ScriptCommand()

Method Detail

getScriptEngine

public ScriptEngine getScriptEngine()

getPromptCommandString

public String getPromptCommandString()

Description copied from interface: ClientCommand

All implementations must indicate what the prompt command is that will trigger its execution. This method returns the prompt command name.

Specified by:

getPromptCommandString in interface ClientCommand

Returns:

the prompt command string - if the first prompt argument is this value, then this prompt command will be executed.

execute

public boolean execute(ClientMain client,
                       String[] args)

Description copied from interface: ClientCommand

Executes the agent prompt command with the given arguments.

Specified by:

execute in interface ClientCommand

Parameters:

client - the ClientMain class itself

args - the arguments passed to the agent on the agent prompt

Returns:

true if the agent can continue accepting prompt commands; false if the agent should die

initClient

public void initClient(ClientMain client)

getSyntax

public String getSyntax()

Description copied from interface: ClientCommand

Returns a one-line usage string to describe the syntax of the command including all optional and required arguments.

Specified by:

getSyntax in interface ClientCommand

Returns:

syntax string

getHelp

public String getHelp()

Description copied from interface: ClientCommand

Returns a help summary to describe to the user what the prompt command does and its purpose. It is usually a short one line help summary.

Specified by:

getHelp in interface ClientCommand

Returns:

help string

getDetailedHelp

public String getDetailedHelp()

Description copied from interface: ClientCommand

Returns a detailed help message to describe to the user what the command's syntax is and any detailed information that is useful to the user that wants to use this command.

Specified by:

getDetailedHelp in interface ClientCommand

Returns:

detailed help string

getContext

public ScriptContext getContext()