abs.ixi.client.xmpp.packet

Class XMPPPacket

java.lang.Object

abs.ixi.client.xmpp.packet.XMPPPacket

All Implemented Interfaces:

ByteConvertible, Packet, Writable, XMLConvertible, Serializable

Direct Known Subclasses:

AckPacket, AckRequestPacket, Challenge, FailedPacket, Failure, Proceed, ResourceBind, SASLAuth, SMEnable, SMEnabledPacket, Stanza, StartTLS, StreamFeaturePacket, StreamHeader, StreamResume, StreamResumed, Success, XMPPError

public abstract class XMPPPacket
extends Object
implements Packet, XMLConvertible, ByteConvertible

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XMPPPacket()

Method Summary

Modifier and Type	Method and Description
StringBuilder	appendXml(StringBuilder sb) Generate XML String out of the this entity, And append this string to given StringBuilder and return it.
byte[]	getBytes() The object is converted into bytes with a mechanism implemented as part of this method.
int	getBytes(byte[] dest, int offset) Converts this object into bytes and copies the bytes into given array starting from offset.
String	getId() Returns packet Id and returns null if packet doesn't have id.
boolean	isStanza()
long	writeTo(OutputStream os) Write to an OutputStream
long	writeTo(Socket socket) Write this entity to a network socket.
long	writeTo(SocketChannel socketChannel) Write this entity to a SocketChannel

Methods inherited from class java.lang.Object

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

Methods inherited from interface abs.ixi.client.core.XMLConvertible

xml

Constructor Detail

XMPPPacket

public XMPPPacket()

Method Detail

getBytes

public byte[] getBytes()

Description copied from interface: ByteConvertible

The object is converted into bytes with a mechanism implemented as part of this method. The returned bytes can be transmitted on wire/network.

Specified by:

getBytes in interface ByteConvertible

Returns:

raw byte representation of this object

getBytes

public int getBytes(byte[] dest,
                    int offset)

Description copied from interface: ByteConvertible

Converts this object into bytes and copies the bytes into given array starting from offset.

Specified by:

getBytes in interface ByteConvertible

Parameters:

dest - destination byte array in which bytes will be copied

offset - start index from which bytes will be copied

Returns:

return new offset after the content bytes has been copied

writeTo

public long writeTo(Socket socket)
             throws IOException

Description copied from interface: Writable

Write this entity to a network socket. The byte conversion mechanism is up to the implementation to decide.

Specified by:

writeTo in interface Writable

Parameters:

socket - network socket on which bytes will be written

Returns:

no of bytes written

Throws:

IOException - if any IO error occurred

writeTo

public long writeTo(SocketChannel socketChannel)
             throws IOException

Description copied from interface: Writable

Write this entity to a SocketChannel

Specified by:

writeTo in interface Writable

Parameters:

socketChannel - network socket channel

Returns:

no of bytes written

Throws:

IOException - if any IO error occurred while writing bytes

writeTo

public long writeTo(OutputStream os)
             throws IOException

Description copied from interface: Writable

Write to an OutputStream

Specified by:

writeTo in interface Writable

Parameters:

os - OutputStream insatnce

Returns:

no of bytes written

Throws:

IOException - if IO error occurrs

isStanza

public boolean isStanza()

Specified by:

isStanza in interface Packet

Returns:

true if packet is one of (Message, Presence, IQ).

getId

public String getId()

Description copied from interface: Packet

Returns packet Id and returns null if packet doesn't have id.

Specified by:

getId in interface Packet

Returns:

Id of this packet

appendXml

public StringBuilder appendXml(StringBuilder sb)

Description copied from interface: XMLConvertible

Generate XML String out of the this entity, And append this string to given StringBuilder and return it.

Specified by:

appendXml in interface XMLConvertible

Parameters:

sb - string

Returns:

StringBuilder string