org.jivesoftware.smack.packet

Class IQ

java.lang.Object

org.jivesoftware.smack.packet.TopLevelStreamElement

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.IQ

All Implemented Interfaces:

Element

Direct Known Subclasses:

Bind, PacketParserUtils.UnparsedResultIQ, RosterPacket, Session

public abstract class IQ
extends Packet

The base IQ (Info/Query) packet. IQ packets are used to get and set information on the server, including authentication, roster operations, and creating accounts. Each IQ packet has a specific type that indicates what type of action is being taken: "get", "set", "result", or "error".

IQ packets can contain a single child element that exists in a specific XML namespace. The combination of the element name and namespace determines what type of IQ packet it is. Some example IQ subpacket snippets:

• <query xmlns="jabber:iq:auth"> -- an authentication IQ.
• <query xmlns="jabber:iq:private"> -- a private storage IQ.
• <pubsub xmlns="http://jabber.org/protocol/pubsub"> -- a pubsub IQ.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IQ.Type A enum to represent the type of the IQ packet.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT
static java.lang.String	QUERY_ELEMENT

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

DEFAULT_LANGUAGE, ITEM, TEXT

Constructor Summary

Constructors

Constructor and Description
IQ()
IQ(IQ iq)

Method Summary

Methods

Modifier and Type	Method and Description
static IQ	createErrorResponse(IQ request, XMPPError error) Convenience method to create a new IQ.Type.error IQ based on a IQ.Type.get or IQ.Type.set IQ.
static IQ	createResultIQ(IQ request) Convenience method to create a new empty IQ.Type.result IQ based on a IQ.Type.get or IQ.Type.set IQ.
abstract java.lang.CharSequence	getChildElementXML() Returns the sub-element XML section of the IQ packet, or null if there isn't one.
IQ.Type	getType() Returns the type of the IQ packet.
void	setType(IQ.Type type) Sets the type of the IQ packet.
java.lang.CharSequence	toXML() Returns the XML representation of this Element.

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

addCommonAttributes, addExtension, addExtensions, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getTo, hashCode, removeExtension, setError, setFrom, setPacketID, setTo, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

QUERY_ELEMENT

public static final java.lang.String QUERY_ELEMENT

See Also:

Constant Field Values

Constructor Detail

IQ

public IQ()

IQ

public IQ(IQ iq)

Method Detail

getType

public IQ.Type getType()

Returns the type of the IQ packet.

Returns:

the type of the IQ packet.

setType

public void setType(IQ.Type type)

Sets the type of the IQ packet.

Parameters:

type - the type of the IQ packet.

toXML

public java.lang.CharSequence toXML()

Description copied from interface: Element

Returns the XML representation of this Element.

Returns:

the packet extension as XML.

getChildElementXML

public abstract java.lang.CharSequence getChildElementXML()

Returns the sub-element XML section of the IQ packet, or null if there isn't one. Packet extensions must be included, if any are defined.

Extensions of this class must override this method.

Returns:

the child element section of the IQ XML.

createResultIQ

public static IQ createResultIQ(IQ request)

Convenience method to create a new empty IQ.Type.result IQ based on a IQ.Type.get or IQ.Type.set IQ. The new packet will be initialized with:

• The sender set to the recipient of the originating IQ.
• The recipient set to the sender of the originating IQ.
• The type set to IQ.Type.result.
• The id set to the id of the originating IQ.
• No child element of the IQ element.

Parameters:

request - the IQ.Type.get or IQ.Type.set IQ packet.

Returns:

a new IQ.Type.result IQ based on the originating IQ.

Throws:

java.lang.IllegalArgumentException - if the IQ packet does not have a type of IQ.Type.get or IQ.Type.set.

createErrorResponse

public static IQ createErrorResponse(IQ request,
                     XMPPError error)

Convenience method to create a new IQ.Type.error IQ based on a IQ.Type.get or IQ.Type.set IQ. The new packet will be initialized with:

• The sender set to the recipient of the originating IQ.
• The recipient set to the sender of the originating IQ.
• The type set to IQ.Type.error.
• The id set to the id of the originating IQ.
• The child element contained in the associated originating IQ.
• The provided XMPPError.

Parameters:

request - the IQ.Type.get or IQ.Type.set IQ packet.

error - the error to associate with the created IQ packet.

Returns:

a new IQ.Type.error IQ based on the originating IQ.

Throws:

java.lang.IllegalArgumentException - if the IQ packet does not have a type of IQ.Type.get or IQ.Type.set.