org.jivesoftware.smack.packet

Class Packet

java.lang.Object

org.jivesoftware.smack.packet.Packet

All Implemented Interfaces:

Element, TopLevelStreamElement

Direct Known Subclasses:

IQ, Message, Presence

public abstract class Packet
extends java.lang.Object
implements TopLevelStreamElement

Base class for XMPP Stanzas, which are called packets in Smack.

Every packet has a unique ID (which is automatically generated, but can be overridden). Optionally, the "to" and "from" fields can be set.

XMPP Stanzas are Message, IQ and Presence. Which therefore subclass this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_LANGUAGE
static java.lang.String	ITEM
protected java.lang.String	language Optional value of the 'xml:lang' attribute of the outermost element of the stanza.
static java.lang.String	TEXT

Constructor Summary

Constructors

Constructor and Description
Packet()
Packet(Packet p)
Packet(java.lang.String packetID)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCommonAttributes(XmlStringBuilder xml) Add to, from, id and 'xml:lang' attributes
void	addExtension(PacketExtension extension) Adds a packet extension to the packet.
void	addExtensions(java.util.Collection<PacketExtension> extensions) Adds a collection of packet extensions to the packet.
protected void	appendErrorIfExists(XmlStringBuilder xml) Append an XMPPError is this packet has one set.
static java.lang.String	getDefaultLanguage() Returns the default language used for all messages containing localized content.
XMPPError	getError() Returns the error associated with this packet, or null if there are no errors.
PacketExtension	getExtension(java.lang.String namespace) Returns the first extension of this packet that has the given namespace.
<PE extends PacketExtension> PE	getExtension(java.lang.String elementName, java.lang.String namespace) Returns the first packet extension that matches the specified element name and namespace, or null if it doesn't exist.
java.util.List<PacketExtension>	getExtensions() Returns a copy of the packet extensions attached to the packet.
protected XmlStringBuilder	getExtensionsXML() Returns the extension sub-packets (including properties data) as an XML String, or the Empty String if there are no packet extensions.
java.lang.String	getFrom() Returns who the packet is being sent "from" or null if the value is not set.
java.lang.String	getLanguage() Returns the xml:lang of this Stanza, or null if one has not been set.
java.lang.String	getPacketID() Returns the unique ID of the packet.
java.lang.String	getTo() Returns who the packet is being sent "to", or null if the value is not set.
boolean	hasExtension(java.lang.String namespace) Check if a packet extension with the given namespace exists.
boolean	hasExtension(java.lang.String elementName, java.lang.String namespace) Check if a packet extension with the given element and namespace exists.
PacketExtension	removeExtension(PacketExtension extension) Removes a packet extension from the packet.
PacketExtension	removeExtension(java.lang.String elementName, java.lang.String namespace) Remove the packet extension with the given elementName and namespace.
void	setError(XMPPError error) Sets the error for this packet.
void	setFrom(java.lang.String from) Sets who the packet is being sent "from".
void	setLanguage(java.lang.String language) Sets the xml:lang of this Stanza.
void	setPacketID(java.lang.String packetID) Sets the unique ID of the packet.
void	setTo(java.lang.String to) Sets who the packet is being sent "to".
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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

toXML

Field Detail

TEXT

public static final java.lang.String TEXT

See Also:

Constant Field Values

ITEM

public static final java.lang.String ITEM

See Also:

Constant Field Values

DEFAULT_LANGUAGE

protected static final java.lang.String DEFAULT_LANGUAGE

language

protected java.lang.String language

Optional value of the 'xml:lang' attribute of the outermost element of the stanza.

Such an attribute is defined for all stanza types. For IQ, see for example XEP-50 3.7: "The requester SHOULD provide its locale information using the "xml:lang " attribute on either the (RECOMMENDED) or element."

Constructor Detail

Packet

public Packet()

Packet

public Packet(java.lang.String packetID)

Packet

public Packet(Packet p)

Method Detail

getPacketID

public java.lang.String getPacketID()

Returns the unique ID of the packet. The returned value could be null when ID_NOT_AVAILABLE was set as the packet's id.

Returns:

the packet's unique ID or null if the packet's id is not available.

setPacketID

public void setPacketID(java.lang.String packetID)

Sets the unique ID of the packet. To indicate that a packet has no id pass the constant ID_NOT_AVAILABLE as the packet's id value.

Parameters:

packetID - the unique ID for the packet.

getTo

public java.lang.String getTo()

Returns who the packet is being sent "to", or null if the value is not set. The XMPP protocol often makes the "to" attribute optional, so it does not always need to be set.

Returns:

who the packet is being sent to, or null if the value has not been set.

setTo

public void setTo(java.lang.String to)

Sets who the packet is being sent "to". The XMPP protocol often makes the "to" attribute optional, so it does not always need to be set.

Parameters:

to - who the packet is being sent to.

getFrom

public java.lang.String getFrom()

Returns who the packet is being sent "from" or null if the value is not set. The XMPP protocol often makes the "from" attribute optional, so it does not always need to be set.

Returns:

who the packet is being sent from, or null if the value has not been set.

setFrom

public void setFrom(java.lang.String from)

Sets who the packet is being sent "from". The XMPP protocol often makes the "from" attribute optional, so it does not always need to be set.

Parameters:

from - who the packet is being sent to.

getError

public XMPPError getError()

Returns the error associated with this packet, or null if there are no errors.

Returns:

the error sub-packet or null if there isn't an error.

setError

public void setError(XMPPError error)

Sets the error for this packet.

Parameters:

error - the error to associate with this packet.

getLanguage

public java.lang.String getLanguage()

Returns the xml:lang of this Stanza, or null if one has not been set.

Returns:

the xml:lang of this Stanza, or null.

setLanguage

public void setLanguage(java.lang.String language)

Sets the xml:lang of this Stanza.

Parameters:

language - the xml:lang of this Stanza.

getExtensions

public java.util.List<PacketExtension> getExtensions()

Returns a copy of the packet extensions attached to the packet.

Returns:

the packet extensions.

getExtension

public PacketExtension getExtension(java.lang.String namespace)

Returns the first extension of this packet that has the given namespace.

When possible, use getExtension(String,String) instead.

Parameters:

namespace - the namespace of the extension that is desired.

Returns:

the packet extension with the given namespace.

getExtension

public <PE extends PacketExtension> PE getExtension(java.lang.String elementName,
                                           java.lang.String namespace)

Returns the first packet extension that matches the specified element name and namespace, or null if it doesn't exist. If the provided elementName is null, only the namespace is matched. Packet extensions are are arbitrary XML sub-documents in standard XMPP packets. By default, a DefaultPacketExtension instance will be returned for each extension. However, PacketExtensionProvider instances can be registered with the ProviderManager class to handle custom parsing. In that case, the type of the Object will be determined by the provider.

Parameters:

elementName - the XML element name of the packet extension. (May be null)

namespace - the XML element namespace of the packet extension.

Returns:

the extension, or null if it doesn't exist.

addExtension

public void addExtension(PacketExtension extension)

Adds a packet extension to the packet. Does nothing if extension is null.

Parameters:

extension - a packet extension.

addExtensions

public void addExtensions(java.util.Collection<PacketExtension> extensions)

Adds a collection of packet extensions to the packet. Does nothing if extensions is null.

Parameters:

extensions - a collection of packet extensions

hasExtension

public boolean hasExtension(java.lang.String elementName,
                   java.lang.String namespace)

Check if a packet extension with the given element and namespace exists.

The argument elementName may be null.

Parameters:

elementName -

namespace -

Returns:

true if a packet extension exists, false otherwise.

hasExtension

public boolean hasExtension(java.lang.String namespace)

Check if a packet extension with the given namespace exists.

Parameters:

namespace -

Returns:

true if a packet extension exists, false otherwise.

removeExtension

public PacketExtension removeExtension(java.lang.String elementName,
                              java.lang.String namespace)

Remove the packet extension with the given elementName and namespace.

Parameters:

elementName -

namespace -

Returns:

the removed packet extension or null.

removeExtension

public PacketExtension removeExtension(PacketExtension extension)

Removes a packet extension from the packet.

Parameters:

extension - the packet extension to remove.

Returns:

the removed packet extension or null.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getExtensionsXML

protected final XmlStringBuilder getExtensionsXML()

Returns the extension sub-packets (including properties data) as an XML String, or the Empty String if there are no packet extensions.

Returns:

the extension sub-packets as XML or the Empty String if there are no packet extensions.

getDefaultLanguage

public static java.lang.String getDefaultLanguage()

Returns the default language used for all messages containing localized content.

Returns:

the default language

addCommonAttributes

protected void addCommonAttributes(XmlStringBuilder xml)

Add to, from, id and 'xml:lang' attributes

Parameters:

xml -

appendErrorIfExists

protected void appendErrorIfExists(XmlStringBuilder xml)

Append an XMPPError is this packet has one set.

Parameters:

xml - the XmlStringBuilder to append the error to.