Package org.jivesoftware.smackx.commands.packet

Class AdHocCommandData

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.commands.packet.AdHocCommandData

All Implemented Interfaces:

Element, IqView, NamedElement, StanzaView, TopLevelStreamElement, XmlElement, XmlLangElement, AdHocCommandDataView

public class AdHocCommandData
extends IQ
implements AdHocCommandDataView

Represents the state and the request of the execution of an adhoc command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdHocCommandData.Action
static class	AdHocCommandData.AllowedAction
static class	AdHocCommandData.SpecificError
static class	AdHocCommandData.Status	The status of the stage in the adhoc command.

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.IQChildElementXmlStringBuilder, IQ.ResponseType, IQ.Type

Field Summary

Fields

Modifier and Type	Field	Description
static String	ELEMENT
static String	NAMESPACE

Fields inherited from class org.jivesoftware.smack.packet.IQ

IQ_ELEMENT, QUERY_ELEMENT

Fields inherited from class org.jivesoftware.smack.packet.Stanza

DEFAULT_LANGUAGE, ITEM, language, TEXT

Constructor Summary

Constructors

Constructor	Description
AdHocCommandData(AdHocCommandDataBuilder builder)

Method Summary

Modifier and Type	Method	Description
static AdHocCommandDataBuilder	builder(String node, String stanzaId)
static AdHocCommandDataBuilder	builder(String node, IqData iqCommon)
static AdHocCommandDataBuilder	builder(String node, XMPPConnection connection)
AdHocCommandData.Action	getAction()	Returns the action to execute.
Set<AdHocCommandData.AllowedAction>	getActions()
AdHocCommandData.AllowedAction	getExecuteAction()
DataForm	getForm()	Returns the form of the command.
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)	This method must be overwritten by IQ subclasses to create their child content.
String	getName()	Returns the human name of the command.
String	getNode()	Returns the identifier of the command.
List<AdHocCommandNote>	getNotes()	Returns the list of notes that the command has.
String	getSessionId()
AdHocCommandData.Status	getStatus()	Returns the status of the execution.

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createErrorResponse, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementQName, getChildElementXML, getElementName, getType, setType, toString, toXML

Methods inherited from class org.jivesoftware.smack.packet.Stanza

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtension, getExtensionElement, getExtensions, getExtensions, getExtensions, getExtensions, getExtensionsMap, getFrom, getLanguage, getNamespace, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, removeExtension, setError, setError, setFrom, setLanguage, setNewStanzaId, setStanzaId, setStanzaId, setTo, throwIfNoStanzaId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jivesoftware.smackx.commands.packet.AdHocCommandDataView

isCompleted, isExecuting

Methods inherited from interface org.jivesoftware.smack.packet.Element

toXML, toXML

Methods inherited from interface org.jivesoftware.smack.packet.IqView

getType, isRequestIQ, isResponseIQ

Methods inherited from interface org.jivesoftware.smack.packet.StanzaView

getError, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getFrom, getStanzaId, getTo, hasExtension, hasExtension, hasExtension

Methods inherited from interface org.jivesoftware.smack.packet.XmlElement

getQName

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

AdHocCommandData

public AdHocCommandData(AdHocCommandDataBuilder builder)

Method Detail

getNode

public String getNode()

Description copied from interface: AdHocCommandDataView

Returns the identifier of the command.

Specified by:

getNode in interface AdHocCommandDataView

Returns:

the node.

getName

public String getName()

Description copied from interface: AdHocCommandDataView

Returns the human name of the command.

Specified by:

getName in interface AdHocCommandDataView

Returns:

the name of the command.

getSessionId

public String getSessionId()

Specified by:

getSessionId in interface AdHocCommandDataView

getNotes

public List<AdHocCommandNote> getNotes()

Description copied from interface: AdHocCommandDataView

Returns the list of notes that the command has.

Specified by:

getNotes in interface AdHocCommandDataView

Returns:

the notes.

getForm

public DataForm getForm()

Description copied from interface: AdHocCommandDataView

Returns the form of the command.

Specified by:

getForm in interface AdHocCommandDataView

Returns:

the data form associated with the command.

getAction

public AdHocCommandData.Action getAction()

Description copied from interface: AdHocCommandDataView

Returns the action to execute. The action is set only on a request.

Specified by:

getAction in interface AdHocCommandDataView

Returns:

the action to execute.

getStatus

public AdHocCommandData.Status getStatus()

Description copied from interface: AdHocCommandDataView

Returns the status of the execution.

Specified by:

getStatus in interface AdHocCommandDataView

Returns:

the status.

getActions

public Set<AdHocCommandData.AllowedAction> getActions()

Specified by:

getActions in interface AdHocCommandDataView

getExecuteAction

public AdHocCommandData.AllowedAction getExecuteAction()

Specified by:

getExecuteAction in interface AdHocCommandDataView

getIQChildElementBuilder

protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)

Description copied from class: IQ

This method must be overwritten by IQ subclasses to create their child content. It is important you don't use the builder to add the final end tag. This will be done automatically by IQ.IQChildElementXmlStringBuilder after eventual existing ExtensionElements have been added.

For example to create an IQ with a extra attribute and an additional child element

 
 <iq to='foo@example.org' id='123'>
   <bar xmlns='example:bar' extraAttribute='blaz'>
      <extraElement>elementText</extraElement>
   </bar>
 </iq>
 
 

the body of the getIQChildElementBuilder looks like

 
 // The builder 'xml' will already have the child element and the 'xmlns' attribute added
 // So the current builder state is "<bar xmlns='example:bar'"
 xml.attribute("extraAttribute", "blaz");
 xml.rightAngleBracket();
 xml.element("extraElement", "elementText");
 // Do not close the 'bar' attribute by calling xml.closeElement('bar')
 
 

If your IQ only contains attributes and no child elements, i.e. it can be represented as empty element, then you can mark it as such.

 xml.attribute("myAttribute", "myAttributeValue");
 xml.setEmptyElement();
 

If your IQ does not contain any attributes or child elements (besides ExtensionElements), consider sub-classing SimpleIQ instead.

Specified by:

getIQChildElementBuilder in class IQ

Parameters:

xml - a pre-created builder which already has the child element and the 'xmlns' attribute set.

Returns:

the build to create the IQ child content.

builder

public static AdHocCommandDataBuilder builder(String node,
                                              IqData iqCommon)

builder

public static AdHocCommandDataBuilder builder(String node,
                                              String stanzaId)

builder

public static AdHocCommandDataBuilder builder(String node,
                                              XMPPConnection connection)