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, TopLevelStreamElement

public class AdHocCommandData
extends IQ

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdHocCommandData.SpecificError

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

IQ.IQChildElementXmlStringBuilder, IQ.Type

Field Summary

Fields

Modifier and Type	Field and 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 and Description
AdHocCommandData()

Method Summary

Modifier and Type	Method and Description
void	addAction(AdHocCommand.Action action)
void	addNote(AdHocCommandNote note)
AdHocCommand.Action	getAction() Returns the action to execute.
List<AdHocCommand.Action>	getActions()
AdHocCommand.Action	getExecuteAction()
DataForm	getForm() Returns the form of the command.
org.jxmpp.jid.Jid	getId() Returns the JID of the command host.
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()
AdHocCommand.Status	getStatus() Returns the status of the execution.
void	removeNote(AdHocCommandNote note)
void	setAction(AdHocCommand.Action action)
void	setExecuteAction(AdHocCommand.Action executeAction)
void	setForm(DataForm form)
void	setId(org.jxmpp.jid.Jid id)
void	setName(String name)
void	setNode(String node)
void	setSessionID(String sessionID) Set the 'sessionid' attribute of the command.
void	setStatus(AdHocCommand.Status status)

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

createErrorResponse, createErrorResponse, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementXML, getChildElementXML, getType, initializeAsResultFor, initialzeAsResultFor, isRequestIQ, setType, toString, toXML

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

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensions, getFrom, getLanguage, getPacketID, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, removeExtension, setError, setError, setFrom, setFrom, setLanguage, setPacketID, setStanzaId, setStanzaId, setTo, setTo

Methods inherited from class java.lang.Object

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

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()

Method Detail

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.

getId

public org.jxmpp.jid.Jid getId()

Returns the JID of the command host.

Returns:

the JID of the command host.

setId

public void setId(org.jxmpp.jid.Jid id)

getName

public String getName()

Returns the human name of the command.

Returns:

the name of the command.

setName

public void setName(String name)

getNode

public String getNode()

Returns the identifier of the command.

Returns:

the node.

setNode

public void setNode(String node)

getNotes

public List<AdHocCommandNote> getNotes()

Returns the list of notes that the command has.

Returns:

the notes.

addNote

public void addNote(AdHocCommandNote note)

removeNote

public void removeNote(AdHocCommandNote note)

getForm

public DataForm getForm()

Returns the form of the command.

Returns:

the data form associated with the command.

setForm

public void setForm(DataForm form)

getAction

public AdHocCommand.Action getAction()

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

Returns:

the action to execute.

setAction

public void setAction(AdHocCommand.Action action)

getStatus

public AdHocCommand.Status getStatus()

Returns the status of the execution.

Returns:

the status.

setStatus

public void setStatus(AdHocCommand.Status status)

getActions

public List<AdHocCommand.Action> getActions()

addAction

public void addAction(AdHocCommand.Action action)

setExecuteAction

public void setExecuteAction(AdHocCommand.Action executeAction)

getExecuteAction

public AdHocCommand.Action getExecuteAction()

setSessionID

public void setSessionID(String sessionID)

Set the 'sessionid' attribute of the command.

This value can be null or empty for the first command, but MUST be set for subsequent commands. See also XEP-0050 § 3.3 Session Lifetime.

Parameters:

sessionID -

getSessionID

public String getSessionID()