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(String node, String name, String sessionId)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods 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
-
-
-
-
Constructor Detail
-
SingleStage
public SingleStage(String node, String name, String sessionId)
-
-
Method Detail
-
executeSingleStage
protected abstract AdHocCommandData executeSingleStage(AdHocCommandDataBuilder response) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
-
execute
protected final AdHocCommandData execute(AdHocCommandDataBuilder response) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
-
next
public final AdHocCommandData next(AdHocCommandDataBuilder response, SubmitForm submittedForm) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
-
complete
public final AdHocCommandData complete(AdHocCommandDataBuilder response, SubmitForm submittedForm) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
-
prev
public final AdHocCommandData prev(AdHocCommandDataBuilder response) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
-
cancel
public final void cancel() throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, 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 classAbstractAdHocCommand
- Throws:
SmackException.NoResponseException
- if there was no response from the remote entity.XMPPException.XMPPErrorException
- if there is a problem executing the command.SmackException.NotConnectedException
- if the XMPP connection is not connected.InterruptedException
- if the calling thread was interrupted.
-
-