org.jivesoftware.smack.util

Class PacketParserUtils

java.lang.Object

org.jivesoftware.smack.util.PacketParserUtils

public class PacketParserUtils
extends java.lang.Object

Utility class that helps to parse packets. Any parsing packets method that must be shared between many clients must be placed in this utility class.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FEATURE_XML_ROUNDTRIP
static boolean	XML_PULL_PARSER_SUPPORTS_ROUNDTRIP True if the XmlPullParser supports the XML_ROUNDTRIP feature.

Constructor Summary

Constructors

Constructor and Description
PacketParserUtils()

Method Summary

Modifier and Type	Method and Description
static void	addExtensionElement(java.util.Collection<ExtensionElement> collection, org.xmlpull.v1.XmlPullParser parser)
static void	addExtensionElement(java.util.Collection<ExtensionElement> collection, org.xmlpull.v1.XmlPullParser parser, java.lang.String elementName, java.lang.String namespace)
static void	addExtensionElement(Stanza packet, org.xmlpull.v1.XmlPullParser parser)
static void	addExtensionElement(Stanza packet, org.xmlpull.v1.XmlPullParser parser, java.lang.String elementName, java.lang.String namespace)
static void	addPacketExtension(java.util.Collection<ExtensionElement> collection, org.xmlpull.v1.XmlPullParser parser) Deprecated.
static void	addPacketExtension(java.util.Collection<ExtensionElement> collection, org.xmlpull.v1.XmlPullParser parser, java.lang.String elementName, java.lang.String namespace) Deprecated.
static void	addPacketExtension(Stanza packet, org.xmlpull.v1.XmlPullParser parser) Deprecated.
static void	addPacketExtension(Stanza packet, org.xmlpull.v1.XmlPullParser parser, java.lang.String elementName, java.lang.String namespace) Deprecated.
static org.xmlpull.v1.XmlPullParser	getParserFor(java.io.Reader reader)
static org.xmlpull.v1.XmlPullParser	getParserFor(java.lang.String stanza)
static org.xmlpull.v1.XmlPullParser	getParserFor(java.lang.String stanza, java.lang.String startTag)
static org.xmlpull.v1.XmlPullParser	newXmppParser() Creates a new XmlPullParser suitable for parsing XMPP.
static org.xmlpull.v1.XmlPullParser	newXmppParser(java.io.Reader reader) Creates a new XmlPullParser suitable for parsing XMPP.
static Compress.Feature	parseCompressionFeature(org.xmlpull.v1.XmlPullParser parser) Parse the Compression Feature reported from the server.
static java.lang.CharSequence	parseContent(org.xmlpull.v1.XmlPullParser parser) Returns the content of a element.
static java.lang.CharSequence	parseContentDepth(org.xmlpull.v1.XmlPullParser parser, int depth)
static java.lang.CharSequence	parseContentDepth(org.xmlpull.v1.XmlPullParser parser, int depth, boolean fullNamespaces) Returns the content from the current position of the parser up to the closing tag of the given depth.
static java.util.Map<java.lang.String,java.lang.String>	parseDescriptiveTexts(org.xmlpull.v1.XmlPullParser parser, java.util.Map<java.lang.String,java.lang.String> descriptiveTexts)
static java.lang.CharSequence	parseElement(org.xmlpull.v1.XmlPullParser parser) Returns the current element as string.
static java.lang.CharSequence	parseElement(org.xmlpull.v1.XmlPullParser parser, boolean fullNamespaces)
static java.lang.String	parseElementText(org.xmlpull.v1.XmlPullParser parser) Returns the textual content of an element as String.
static XMPPError.Builder	parseError(org.xmlpull.v1.XmlPullParser parser) Parses error sub-packets.
static ExtensionElement	parseExtensionElement(java.lang.String elementName, java.lang.String namespace, org.xmlpull.v1.XmlPullParser parser) Parses an extension element.
static IQ	parseIQ(org.xmlpull.v1.XmlPullParser parser) Parses an IQ packet.
static java.util.Collection<java.lang.String>	parseMechanisms(org.xmlpull.v1.XmlPullParser parser) Parse the available SASL mechanisms reported from the server.
static Message	parseMessage(org.xmlpull.v1.XmlPullParser parser) Parses a message packet.
static ExtensionElement	parsePacketExtension(java.lang.String elementName, java.lang.String namespace, org.xmlpull.v1.XmlPullParser parser) Deprecated. use parseExtensionElement(String, String, XmlPullParser) instead.
static Presence	parsePresence(org.xmlpull.v1.XmlPullParser parser) Parses a presence packet.
static SaslStreamElements.SASLFailure	parseSASLFailure(org.xmlpull.v1.XmlPullParser parser) Parses SASL authentication error packets.
static Session.Feature	parseSessionFeature(org.xmlpull.v1.XmlPullParser parser)
static <S extends Stanza> S	parseStanza(java.lang.String stanza)
static Stanza	parseStanza(org.xmlpull.v1.XmlPullParser parser) Tries to parse and return either a Message, IQ or Presence stanza.
static StartTls	parseStartTlsFeature(org.xmlpull.v1.XmlPullParser parser)
static StreamError	parseStreamError(org.xmlpull.v1.XmlPullParser parser) Parses stream error packets.

Methods inherited from class java.lang.Object

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

Field Detail

FEATURE_XML_ROUNDTRIP

public static final java.lang.String FEATURE_XML_ROUNDTRIP

See Also:

Constant Field Values

XML_PULL_PARSER_SUPPORTS_ROUNDTRIP

public static final boolean XML_PULL_PARSER_SUPPORTS_ROUNDTRIP

True if the XmlPullParser supports the XML_ROUNDTRIP feature.

Constructor Detail

PacketParserUtils

public PacketParserUtils()

Method Detail

getParserFor

public static org.xmlpull.v1.XmlPullParser getParserFor(java.lang.String stanza)
                                                 throws org.xmlpull.v1.XmlPullParserException,
                                                        java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

getParserFor

public static org.xmlpull.v1.XmlPullParser getParserFor(java.io.Reader reader)
                                                 throws org.xmlpull.v1.XmlPullParserException,
                                                        java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

getParserFor

public static org.xmlpull.v1.XmlPullParser getParserFor(java.lang.String stanza,
                                                        java.lang.String startTag)
                                                 throws org.xmlpull.v1.XmlPullParserException,
                                                        java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

parseStanza

public static <S extends Stanza> S parseStanza(java.lang.String stanza)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

parseStanza

public static Stanza parseStanza(org.xmlpull.v1.XmlPullParser parser)
                          throws java.lang.Exception

Tries to parse and return either a Message, IQ or Presence stanza. connection is optional and is used to return feature-not-implemented errors for unknown IQ stanzas.

Parameters:

parser -

Returns:

a stanza(/packet) which is either a Message, IQ or Presence.

Throws:

java.lang.Exception

newXmppParser

public static org.xmlpull.v1.XmlPullParser newXmppParser()
                                                  throws org.xmlpull.v1.XmlPullParserException

Creates a new XmlPullParser suitable for parsing XMPP. This means in particular that FEATURE_PROCESS_NAMESPACES is enabled.

Note that not all XmlPullParser implementations will return a String on getText() if the parser is on START_TAG or END_TAG. So you must not rely on this behavior when using the parser.

Returns:

A suitable XmlPullParser for XMPP parsing

Throws:

org.xmlpull.v1.XmlPullParserException

newXmppParser

public static org.xmlpull.v1.XmlPullParser newXmppParser(java.io.Reader reader)
                                                  throws org.xmlpull.v1.XmlPullParserException

Creates a new XmlPullParser suitable for parsing XMPP. This means in particular that FEATURE_PROCESS_NAMESPACES is enabled.

Note that not all XmlPullParser implementations will return a String on getText() if the parser is on START_TAG or END_TAG. So you must not rely on this behavior when using the parser.

Parameters:

reader -

Returns:

A suitable XmlPullParser for XMPP parsing

Throws:

org.xmlpull.v1.XmlPullParserException

parseMessage

public static Message parseMessage(org.xmlpull.v1.XmlPullParser parser)
                            throws java.lang.Exception

Parses a message packet.

Parameters:

parser - the XML parser, positioned at the start of a message packet.

Returns:

a Message packet.

Throws:

java.lang.Exception

parseElementText

public static java.lang.String parseElementText(org.xmlpull.v1.XmlPullParser parser)
                                         throws org.xmlpull.v1.XmlPullParserException,
                                                java.io.IOException

Returns the textual content of an element as String. After this method returns the parser position will be END_TAG, following the established pull parser calling convention.

The parser must be positioned on a START_TAG of an element which MUST NOT contain Mixed Content (as defined in XML 3.2.2), or else an XmlPullParserException will be thrown.

This method is used for the parts where the XMPP specification requires elements that contain only text or are the empty element.

Parameters:

parser -

Returns:

the textual content of the element as String

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

parseElement

public static java.lang.CharSequence parseElement(org.xmlpull.v1.XmlPullParser parser)
                                           throws org.xmlpull.v1.XmlPullParserException,
                                                  java.io.IOException

Returns the current element as string.

The parser must be positioned on START_TAG.

Note that only the outermost namespace attributes ("xmlns") will be returned, not nested ones.

Parameters:

parser - the XML pull parser

Returns:

the element as string

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

parseElement

public static java.lang.CharSequence parseElement(org.xmlpull.v1.XmlPullParser parser,
                                                  boolean fullNamespaces)
                                           throws org.xmlpull.v1.XmlPullParserException,
                                                  java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

parseContent

public static java.lang.CharSequence parseContent(org.xmlpull.v1.XmlPullParser parser)
                                           throws org.xmlpull.v1.XmlPullParserException,
                                                  java.io.IOException

Returns the content of a element.

The parser must be positioned on the START_TAG of the element which content is going to get returned. If the current element is the empty element, then the empty string is returned. If it is a element which contains just text, then just the text is returned. If it contains nested elements (and text), then everything from the current opening tag to the corresponding closing tag of the same depth is returned as String.

Note that only the outermost namespace attributes ("xmlns") will be returned, not nested ones.

Parameters:

parser - the XML pull parser

Returns:

the content of a tag

Throws:

org.xmlpull.v1.XmlPullParserException - if parser encounters invalid XML

java.io.IOException - if an IO error occurs

parseContentDepth

public static java.lang.CharSequence parseContentDepth(org.xmlpull.v1.XmlPullParser parser,
                                                       int depth)
                                                throws org.xmlpull.v1.XmlPullParserException,
                                                       java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

parseContentDepth

public static java.lang.CharSequence parseContentDepth(org.xmlpull.v1.XmlPullParser parser,
                                                       int depth,
                                                       boolean fullNamespaces)
                                                throws org.xmlpull.v1.XmlPullParserException,
                                                       java.io.IOException

Returns the content from the current position of the parser up to the closing tag of the given depth. Note that only the outermost namespace attributes ("xmlns") will be returned, not nested ones, if fullNamespaces is false. If it is true, then namespaces of parent elements will be added to child elements that don't define a different namespace.

This method is able to parse the content with MX- and KXmlParser. KXmlParser does not support xml-roundtrip. i.e. return a String on getText() on START_TAG and END_TAG. We check for the XML_ROUNDTRIP feature. If it's not found we are required to work around this limitation, which results in only partial support for XML namespaces ("xmlns"): Only the outermost namespace of elements will be included in the resulting String, if fullNamespaces is set to false.

In particular Android's XmlPullParser does not support XML_ROUNDTRIP.

Parameters:

parser -

depth -

fullNamespaces -

Returns:

the content of the current depth

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

parsePresence

public static Presence parsePresence(org.xmlpull.v1.XmlPullParser parser)
                              throws java.lang.Exception

Parses a presence packet.

Parameters:

parser - the XML parser, positioned at the start of a presence packet.

Returns:

a Presence packet.

Throws:

java.lang.Exception

parseIQ

public static IQ parseIQ(org.xmlpull.v1.XmlPullParser parser)
                  throws java.lang.Exception

Parses an IQ packet.

Parameters:

parser - the XML parser, positioned at the start of an IQ packet.

Returns:

an IQ object.

Throws:

java.lang.Exception

parseMechanisms

public static java.util.Collection<java.lang.String> parseMechanisms(org.xmlpull.v1.XmlPullParser parser)
                                                              throws org.xmlpull.v1.XmlPullParserException,
                                                                     java.io.IOException

Parse the available SASL mechanisms reported from the server.

Parameters:

parser - the XML parser, positioned at the start of the mechanisms stanza.

Returns:

a collection of Stings with the mechanisms included in the mechanisms stanza.

Throws:

java.io.IOException

org.xmlpull.v1.XmlPullParserException

parseCompressionFeature

public static Compress.Feature parseCompressionFeature(org.xmlpull.v1.XmlPullParser parser)
                                                throws java.io.IOException,
                                                       org.xmlpull.v1.XmlPullParserException

Parse the Compression Feature reported from the server.

Parameters:

parser - the XML parser, positioned at the start of the compression stanza.

Returns:

The CompressionFeature stream element

Throws:

java.io.IOException

org.xmlpull.v1.XmlPullParserException - if an exception occurs while parsing the stanza.

parseDescriptiveTexts

public static java.util.Map<java.lang.String,java.lang.String> parseDescriptiveTexts(org.xmlpull.v1.XmlPullParser parser,
                                                                                     java.util.Map<java.lang.String,java.lang.String> descriptiveTexts)
                                                                              throws org.xmlpull.v1.XmlPullParserException,
                                                                                     java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

parseSASLFailure

public static SaslStreamElements.SASLFailure parseSASLFailure(org.xmlpull.v1.XmlPullParser parser)
                                                       throws org.xmlpull.v1.XmlPullParserException,
                                                              java.io.IOException

Parses SASL authentication error packets.

Parameters:

parser - the XML parser.

Returns:

a SASL Failure packet.

Throws:

java.io.IOException

org.xmlpull.v1.XmlPullParserException

parseStreamError

public static StreamError parseStreamError(org.xmlpull.v1.XmlPullParser parser)
                                    throws java.lang.Exception

Parses stream error packets.

Parameters:

parser - the XML parser.

Returns:

an stream error packet.

Throws:

java.lang.Exception - if an exception occurs while parsing the packet.

parseError

public static XMPPError.Builder parseError(org.xmlpull.v1.XmlPullParser parser)
                                    throws java.lang.Exception

Parses error sub-packets.

Parameters:

parser - the XML parser.

Returns:

an error sub-packet.

Throws:

java.lang.Exception

parsePacketExtension

@Deprecated
public static ExtensionElement parsePacketExtension(java.lang.String elementName,
                                                                java.lang.String namespace,
                                                                org.xmlpull.v1.XmlPullParser parser)
                                                         throws java.lang.Exception

Deprecated. use parseExtensionElement(String, String, XmlPullParser) instead.

Parses an extension element.

Parameters:

elementName - the XML element name of the extension element.

namespace - the XML namespace of the stanza(/packet) extension.

parser - the XML parser, positioned at the starting element of the extension.

Returns:

an extension element.

Throws:

java.lang.Exception - when an error occurs during parsing.

parseExtensionElement

public static ExtensionElement parseExtensionElement(java.lang.String elementName,
                                                     java.lang.String namespace,
                                                     org.xmlpull.v1.XmlPullParser parser)
                                              throws java.lang.Exception

Parses an extension element.

Parameters:

elementName - the XML element name of the extension element.

namespace - the XML namespace of the stanza(/packet) extension.

parser - the XML parser, positioned at the starting element of the extension.

Returns:

an extension element.

Throws:

java.lang.Exception - when an error occurs during parsing.

parseStartTlsFeature

public static StartTls parseStartTlsFeature(org.xmlpull.v1.XmlPullParser parser)
                                     throws org.xmlpull.v1.XmlPullParserException,
                                            java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

parseSessionFeature

public static Session.Feature parseSessionFeature(org.xmlpull.v1.XmlPullParser parser)
                                           throws org.xmlpull.v1.XmlPullParserException,
                                                  java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

addPacketExtension

@Deprecated
public static void addPacketExtension(Stanza packet,
                                                  org.xmlpull.v1.XmlPullParser parser)
                                           throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

addPacketExtension

@Deprecated
public static void addPacketExtension(Stanza packet,
                                                  org.xmlpull.v1.XmlPullParser parser,
                                                  java.lang.String elementName,
                                                  java.lang.String namespace)
                                           throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

addPacketExtension

@Deprecated
public static void addPacketExtension(java.util.Collection<ExtensionElement> collection,
                                                  org.xmlpull.v1.XmlPullParser parser)
                                           throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

addPacketExtension

@Deprecated
public static void addPacketExtension(java.util.Collection<ExtensionElement> collection,
                                                  org.xmlpull.v1.XmlPullParser parser,
                                                  java.lang.String elementName,
                                                  java.lang.String namespace)
                                           throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

addExtensionElement

public static void addExtensionElement(Stanza packet,
                                       org.xmlpull.v1.XmlPullParser parser)
                                throws java.lang.Exception

Throws:

java.lang.Exception

addExtensionElement

public static void addExtensionElement(Stanza packet,
                                       org.xmlpull.v1.XmlPullParser parser,
                                       java.lang.String elementName,
                                       java.lang.String namespace)
                                throws java.lang.Exception

Throws:

java.lang.Exception

addExtensionElement

public static void addExtensionElement(java.util.Collection<ExtensionElement> collection,
                                       org.xmlpull.v1.XmlPullParser parser)
                                throws java.lang.Exception

Throws:

java.lang.Exception

addExtensionElement

public static void addExtensionElement(java.util.Collection<ExtensionElement> collection,
                                       org.xmlpull.v1.XmlPullParser parser,
                                       java.lang.String elementName,
                                       java.lang.String namespace)
                                throws java.lang.Exception

Throws:

java.lang.Exception