Package org.jivesoftware.smackx.commands

Class 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.

    • Method Detail

      • getSpecificErrorCondition

        public static AdHocCommand.SpecificErrorCondition getSpecificErrorCondition​(StanzaError 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 Jid 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.

      • addNote

        protected void addNote​(AdHocCommandNote note)
        Adds a note to the current stage. This should be used when setting a response to the execution of an action. All the notes added here are returned by the getNotes() method during the current stage. Once the stage changes all the notes are discarded.
        Parameters:
        note - the note.

      • getRaw

        public java.lang.String getRaw()

      • getForm

        public DataForm 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.

      • setForm

        protected void setForm​(DataForm form)
        Sets the form of the current stage. This should be used when setting a response. It could be a form to fill out the information needed to go to the next stage or the result of an execution.
        Parameters:
        form - the form of the current stage to fill out or the result of the execution.

      • getActions

        protected java.util.List<AdHocCommand.Action> getActions()
        Returns a collection with the allowed actions based on the current stage. Possible actions are: prev, next and complete. This method will be only invoked for commands that have one or more stages.
        Returns:
        a collection with the allowed actions based on the current stage as defined in the SessionData.

      • addActionAvailable

        protected void addActionAvailable​(AdHocCommand.Action action)
        Add an action to the current stage available actions. This should be used when creating a response.
        Parameters:
        action - the action.

      • getExecuteAction

        protected AdHocCommand.Action getExecuteAction()
        Returns the action available for the current stage which is considered the equivalent to "execute". When the requester sends his reply, if no action was defined in the command then the action will be assumed "execute" thus assuming the action returned by this method. This method will never be invoked for commands that have no stages.
        Returns:
        the action available for the current stage which is considered the equivalent to "execute".

      • setExecuteAction

        protected void setExecuteAction​(AdHocCommand.Action action)
        Sets which of the actions available for the current stage is considered the equivalent to "execute". This should be used when setting a response. When the requester sends his reply, if no action was defined in the command then the action will be assumed "execute" thus assuming the action returned by this method.
        Parameters:
        action - the action.

      • isCompleted

        public boolean isCompleted()
        Check if this command has been completed successfully.
        Returns:
        true if this command is completed.
        Since:
        4.2

      • isValidAction

        protected boolean isValidAction​(AdHocCommand.Action action)
        Returns true if the action is available in the current stage. The cancel action is always allowed. To define the available actions use the addActionAvailable method.
        Parameters:
        action - TODO javadoc me please The action to check if it is available.
        Returns:
        True if the action is available for the current stage.