Package org.jivesoftware.smackx.commands

Class AdHocCommandHandler.SingleStage

java.lang.Object

org.jivesoftware.smackx.commands.AbstractAdHocCommand

org.jivesoftware.smackx.commands.AdHocCommandHandler

org.jivesoftware.smackx.commands.AdHocCommandHandler.SingleStage

Enclosing class:

AdHocCommandHandler

public abstract static class AdHocCommandHandler.SingleStage
extends AdHocCommandHandler

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smackx.commands.AdHocCommandHandler

AdHocCommandHandler.SingleStage

Constructor Summary

Constructors

Constructor	Description
SingleStage(java.lang.String node, java.lang.String name, java.lang.String sessionId)

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancels the execution of the command.
AdHocCommandData	complete(AdHocCommandDataBuilder response, SubmitForm submittedForm)
protected AdHocCommandData	execute(AdHocCommandDataBuilder response)
protected abstract AdHocCommandData	executeSingleStage(AdHocCommandDataBuilder response)
AdHocCommandData	next(AdHocCommandDataBuilder response, SubmitForm submittedForm)
AdHocCommandData	prev(AdHocCommandDataBuilder response)

Methods inherited from class org.jivesoftware.smackx.commands.AdHocCommandHandler

getCreationDate, getCurrentStage, hasPermission, newBadRequestException, newXmppErrorException, newXmppErrorException

Methods inherited from class org.jivesoftware.smackx.commands.AbstractAdHocCommand

getActions, getExecuteAction, getLastRequest, getLastResult, getName, getNode, getNotes, getSessionId, getSpecificErrorCondition, getStatus, isCompleted, isValidAction, setSessionId

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleStage

public SingleStage(java.lang.String node,
                   java.lang.String name,
                   java.lang.String sessionId)

Method Detail

executeSingleStage

protected abstract AdHocCommandData executeSingleStage(AdHocCommandDataBuilder response)
                                                throws org.jivesoftware.smack.SmackException.NoResponseException,
                                                       org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                                       org.jivesoftware.smack.SmackException.NotConnectedException,
                                                       java.lang.InterruptedException

Throws:

org.jivesoftware.smack.SmackException.NoResponseException

org.jivesoftware.smack.XMPPException.XMPPErrorException

org.jivesoftware.smack.SmackException.NotConnectedException

java.lang.InterruptedException

execute

protected final AdHocCommandData execute(AdHocCommandDataBuilder response)
                                  throws org.jivesoftware.smack.SmackException.NoResponseException,
                                         org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                         org.jivesoftware.smack.SmackException.NotConnectedException,
                                         java.lang.InterruptedException

Specified by:

execute in class AdHocCommandHandler

Throws:

org.jivesoftware.smack.SmackException.NoResponseException

org.jivesoftware.smack.XMPPException.XMPPErrorException

org.jivesoftware.smack.SmackException.NotConnectedException

java.lang.InterruptedException

next

public final AdHocCommandData next(AdHocCommandDataBuilder response,
                                   SubmitForm submittedForm)
                            throws org.jivesoftware.smack.SmackException.NoResponseException,
                                   org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                   org.jivesoftware.smack.SmackException.NotConnectedException,
                                   java.lang.InterruptedException

Specified by:

next in class AdHocCommandHandler

Throws:

org.jivesoftware.smack.SmackException.NoResponseException

org.jivesoftware.smack.XMPPException.XMPPErrorException

org.jivesoftware.smack.SmackException.NotConnectedException

java.lang.InterruptedException

complete

public final AdHocCommandData complete(AdHocCommandDataBuilder response,
                                       SubmitForm submittedForm)
                                throws org.jivesoftware.smack.SmackException.NoResponseException,
                                       org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                       org.jivesoftware.smack.SmackException.NotConnectedException,
                                       java.lang.InterruptedException

Specified by:

complete in class AdHocCommandHandler

Throws:

org.jivesoftware.smack.SmackException.NoResponseException

org.jivesoftware.smack.XMPPException.XMPPErrorException

org.jivesoftware.smack.SmackException.NotConnectedException

java.lang.InterruptedException

prev

public final AdHocCommandData prev(AdHocCommandDataBuilder response)
                            throws org.jivesoftware.smack.SmackException.NoResponseException,
                                   org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                   org.jivesoftware.smack.SmackException.NotConnectedException,
                                   java.lang.InterruptedException

Specified by:

prev in class AdHocCommandHandler

Throws:

org.jivesoftware.smack.SmackException.NoResponseException

org.jivesoftware.smack.XMPPException.XMPPErrorException

org.jivesoftware.smack.SmackException.NotConnectedException

java.lang.InterruptedException

cancel

public final void cancel()
                  throws org.jivesoftware.smack.SmackException.NoResponseException,
                         org.jivesoftware.smack.XMPPException.XMPPErrorException,
                         org.jivesoftware.smack.SmackException.NotConnectedException,
                         java.lang.InterruptedException

Description copied from class: AbstractAdHocCommand

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.

Specified by:

cancel in class AbstractAdHocCommand

Throws:

org.jivesoftware.smack.SmackException.NoResponseException - if there was no response from the remote entity.

org.jivesoftware.smack.XMPPException.XMPPErrorException - if there is a problem executing the command.

org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.

java.lang.InterruptedException - if the calling thread was interrupted.