org.rhq.enterprise.agent.promptcmd
Class SenderPromptCommand

java.lang.Object
  org.rhq.enterprise.agent.promptcmd.SenderPromptCommand

All Implemented Interfaces:

AgentPromptCommand

public class SenderPromptCommand
extends Object
implements AgentPromptCommand

Command to forcibly start or stop the agent's client command sender. This allows you to manually tell the sender to start sending commands or stop sending commands even if auto-discovery is enabled and wants to do the opposite. Note that if auto-discovery is enabled (this includes server polling as well) the sender will probably be set back to its original state when the JON Server's state is auto-detected. This means that even if this command is used to start or stop the sender, when auto-discovery detects the server is down it will stop the sender again - if the server comes up, it will start the sender again.

Author:

John Mazzitelli

Constructor Summary

SenderPromptCommand()

Method Summary

boolean	execute(AgentMain agent, String[] args) Executes the agent prompt command with the given arguments.
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.
String	getSyntax() Returns a one-line usage string to describe the syntax of the command including all optional and required arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

SenderPromptCommand

public SenderPromptCommand()

Method Detail

getPromptCommandString

public String getPromptCommandString()

Description copied from interface: AgentPromptCommand

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 AgentPromptCommand

Returns:

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

See Also:

AgentPromptCommand.getPromptCommandString()

execute

public boolean execute(AgentMain agent,
                       String[] args)

Description copied from interface: AgentPromptCommand

Executes the agent prompt command with the given arguments.

Specified by:

execute in interface AgentPromptCommand

Parameters:

agent - the agent 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

See Also:

AgentPromptCommand.execute(AgentMain, String[])

getSyntax

public String getSyntax()

Description copied from interface: AgentPromptCommand

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

Specified by:

getSyntax in interface AgentPromptCommand

Returns:

syntax string

See Also:

AgentPromptCommand.getSyntax()

getHelp

public String getHelp()

Description copied from interface: AgentPromptCommand

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 AgentPromptCommand

Returns:

help string

See Also:

AgentPromptCommand.getHelp()

getDetailedHelp

public String getDetailedHelp()

Description copied from interface: AgentPromptCommand

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 AgentPromptCommand

Returns:

detailed help string

See Also:

AgentPromptCommand.getDetailedHelp()