org.jivesoftware.smackx.bytestreams.ibb.packet

Class DataPacketExtension

java.lang.Object

org.jivesoftware.smackx.bytestreams.ibb.packet.DataPacketExtension

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class DataPacketExtension
extends Object
implements ExtensionElement

Represents a chunk of data of an In-Band Bytestream within an IQ stanza or a message stanza.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT The element name of the data stanza extension.
static String	NAMESPACE The XMPP namespace of the In-Band Bytestream.

Constructor Summary

Constructors

Constructor and Description
DataPacketExtension(String sessionID, long seq, String data) Creates a new In-Band Bytestream data packet.

Method Summary

Modifier and Type	Method and Description
String	getData() Returns the data contained in this packet.
byte[]	getDecodedData() Returns the decoded data or null if data could not be decoded.
String	getElementName() Returns the root element name.
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)
String	getNamespace() Returns the root element XML namespace.
long	getSeq() Returns the sequence of this stanza in regard to the other data packets.
String	getSessionID() Returns the unique session ID identifying this In-Band Bytestream.
XmlStringBuilder	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final String ELEMENT

The element name of the data stanza extension.

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

The XMPP namespace of the In-Band Bytestream.

See Also:

Constant Field Values

Constructor Detail

DataPacketExtension

public DataPacketExtension(String sessionID,
                           long seq,
                           String data)

Creates a new In-Band Bytestream data packet.

Parameters:

sessionID - unique session ID identifying this In-Band Bytestream

seq - sequence of this stanza in regard to the other data packets

data - the base64 encoded data contained in this packet

Method Detail

getSessionID

public String getSessionID()

Returns the unique session ID identifying this In-Band Bytestream.

Returns:

the unique session ID identifying this In-Band Bytestream

getSeq

public long getSeq()

Returns the sequence of this stanza in regard to the other data packets.

Returns:

the sequence of this stanza in regard to the other data packets.

getData

public String getData()

Returns the data contained in this packet.

Returns:

the data contained in this packet.

getDecodedData

public byte[] getDecodedData()

Returns the decoded data or null if data could not be decoded.

The encoded data is invalid if it contains bad Base64 input characters or if it contains the pad ('=') character on a position other than the last character(s) of the data. See XEP-0047 Section 6.

Returns:

the decoded data

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getNamespace

public String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

toXML

public XmlStringBuilder toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.

getIQChildElementBuilder

protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)