org.jivesoftware.smackx.commands
Class AdHocCommand

java.lang.Object
  org.jivesoftware.smackx.commands.AdHocCommand

Direct Known Subclasses:

LocalCommand, RemoteCommand

public abstract class AdHocCommand
extends java.lang.Object

An ad-hoc command is responsible for executing the provided service and storing the result of the execution. Each new request will create a new instance of the command, allowing information related to executions to be stored in it. For example suppose that a command that retrieves the list of users on a server is implemented. When the command is executed it gets that list and the result is stored as a form in the command instance, i.e. the getForm method retrieves a form with all the users.

Each command has a node that should be unique within a given JID.

Commands may have zero or more stages. Each stage is usually used for gathering information required for the command execution. Users are able to move forward or backward across the different stages. Commands may not be cancelled while they are being executed. However, users may request the "cancel" action when submitting a stage response indicating that the command execution should be aborted. Thus, releasing any collected information. Commands that require user interaction (i.e. have more than one stage) will have to provide the data forms the user must complete in each stage and the allowed actions the user might perform during each stage (e.g. go to the previous stage or go to the next stage).

All the actions may throw an XMPPException if there is a problem executing them. The XMPPError of that exception may have some specific information about the problem. The possible extensions are:

malformed-action. Extension of a bad-request error.

bad-action. Extension of a bad-request error.

bad-locale. Extension of a bad-request error.

bad-payload. Extension of a bad-request error.

bad-sessionid. Extension of a bad-request error.

session-expired. Extension of a not-allowed error.

See the SpecificErrorCondition class for detailed description of each one.

Use the getSpecificErrorConditionFrom to obtain the specific information from an XMPPError.

Author:

Gabriel Guardincerri

Nested Class Summary

static class	AdHocCommand.Action
static class	AdHocCommand.SpecificErrorCondition
static class	AdHocCommand.Status The status of the stage in the adhoc command.

Constructor Summary

AdHocCommand()

Method Summary

abstract void	cancel() Cancels the execution of the command.
abstract void	complete(Form response) Completes the command execution with the information provided in the response.
abstract void	execute() Executes the command.
Form	getForm() Returns the form of the current stage.
java.lang.String	getName() Returns the human readable name of the command.
java.lang.String	getNode() Returns the unique identifier of the command.
java.util.List<AdHocCommandNote>	getNotes() Returns the notes that the command has at the current stage.
abstract java.lang.String	getOwnerJID() Returns the full JID of the owner of this command.
java.lang.String	getRaw()
static AdHocCommand.SpecificErrorCondition	getSpecificErrorCondition(XMPPError error) Returns the specific condition of the error or null if the error doesn't have any.
AdHocCommand.Status	getStatus() Returns the status of the current stage.
abstract void	next(Form response) Executes the next action of the command with the information provided in the response.
abstract void	prev() Goes to the previous stage.
void	setName(java.lang.String name) Set the the human readable name of the command, usually used for displaying in a UI.
void	setNode(java.lang.String node) Sets the unique identifier of the command.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdHocCommand

public AdHocCommand()

Method Detail

getSpecificErrorCondition

public static AdHocCommand.SpecificErrorCondition getSpecificErrorCondition(XMPPError error)

Returns the specific condition of the error or null if the error doesn't have any.

Parameters:

error - the error the get the specific condition from.

Returns:

the specific condition of this error, or null if it doesn't have any.

setName

public void setName(java.lang.String name)

Set the the human readable name of the command, usually used for displaying in a UI.

Parameters:

name - the name.

getName

public java.lang.String getName()

Returns the human readable name of the command.

Returns:

the human readable name of the command

setNode

public void setNode(java.lang.String node)

Sets the unique identifier of the command. This value must be unique for the OwnerJID.

Parameters:

node - the unique identifier of the command.

getNode

public java.lang.String getNode()

Returns the unique identifier of the command. It is unique for the OwnerJID.

Returns:

the unique identifier of the command.

getOwnerJID

public abstract java.lang.String getOwnerJID()

Returns the full JID of the owner of this command. This JID is the "to" of a execution request.

Returns:

the owner JID.

getNotes

public java.util.List<AdHocCommandNote> getNotes()

Returns the notes that the command has at the current stage.

Returns:

a list of notes.

getRaw

public java.lang.String getRaw()

getForm

public Form getForm()

Returns the form of the current stage. Usually it is the form that must be answered to execute the next action. If that is the case it should be used by the requester to fill all the information that the executor needs to continue to the next stage. It can also be the result of the execution.

Returns:

the form of the current stage to fill out or the result of the execution.

execute

public abstract void execute()
                      throws XMPPException

Executes the command. This is invoked only on the first stage of the command. It is invoked on every command. If there is a problem executing the command it throws an XMPPException.

Throws:

XMPPException - if there is an error executing the command.

next

public abstract void next(Form response)
                   throws XMPPException

Executes the next action of the command with the information provided in the response. This form must be the answer form of the previous stage. This method will be only invoked for commands that have one or more stages. If there is a problem executing the command it throws an XMPPException.

Parameters:

response - the form answer of the previous stage.

Throws:

XMPPException - if there is a problem executing the command.

complete

public abstract void complete(Form response)
                       throws XMPPException

Completes the command execution with the information provided in the response. This form must be the answer form of the previous stage. This method will be only invoked for commands that have one or more stages. If there is a problem executing the command it throws an XMPPException.

Parameters:

response - the form answer of the previous stage.

Throws:

XMPPException - if there is a problem executing the command.

prev

public abstract void prev()
                   throws XMPPException

Goes to the previous stage. The requester is asking to re-send the information of the previous stage. The command must change it state to the previous one. If there is a problem executing the command it throws an XMPPException.

Throws:

XMPPException - if there is a problem executing the command.

cancel

public abstract void cancel()
                     throws XMPPException

Cancels the execution of the command. This can be invoked on any stage of the execution. If there is a problem executing the command it throws an XMPPException.

Throws:

XMPPException - if there is a problem executing the command.

getStatus

public AdHocCommand.Status getStatus()

Returns the status of the current stage.

Returns:

the current status.