org.jabber.jabberbeans
Class XMLStreamHeader

java.lang.Object
  |
  +--org.jabber.jabberbeans.XMLData
        |
        +--org.jabber.jabberbeans.XMLStreamHeader

public class XMLStreamHeader

extends XMLData

implements Packet

Class which represents an XMLStream header - this names the overall namespace (format) of the XML data being transmitted and received. This is also the only packet which isn't really a 'packet' per-se - it isn't closed. It is instead the header which is sent on first connect to verify this is indeed a Jabber server, and set the framework for communication

Version:

$Revision: 1.1.1.1 $

Author:

David Waite <dwaite@jabber.com>, $Author: lucky $

See Also:

Serialized Form

Field Summary

private JID	fromAddress
private java.lang.String	id id is the reserved XML id, it also holds the session ID which is prepended to any keys or passwords and hashed to do any digest-based authentication
private JID	toAddress
private java.lang.String	XMLNS XMLNS holds the namespace of the protocol being spoken.

Constructor Summary

XMLStreamHeader(XMLStreamHeaderBuilder builder)
Creates a new XMLStreamHeader instance.

Method Summary

void	appendItem(java.lang.StringBuffer retval) appendItem appends the XML representation of the current packet data to the specified StringBuffer.
JID	getFromAddress()
java.lang.String	getIdentifier()
JID	getToAddress()
java.lang.String	getXMLNS()

Methods inherited from class org.jabber.jabberbeans.XMLData

appendAttrib, appendAttrib, appendChild, appendChild, escapeString, toString

Methods inherited from class java.lang.Object

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

Field Detail

XMLNS

private java.lang.String XMLNS

XMLNS holds the namespace of the protocol being spoken.

id

private java.lang.String id

id is the reserved XML id, it also holds the session ID which is prepended to any keys or passwords and hashed to do any digest-based authentication

toAddress

private JID toAddress

fromAddress

private JID fromAddress

Constructor Detail

XMLStreamHeader

public XMLStreamHeader(XMLStreamHeaderBuilder builder)

Creates a new XMLStreamHeader instance.

Parameters:

server - server we are connecting to (specific virtualhost)

xmlns - namespace of the protocol

identifier - identifier used as session ID

Method Detail

getXMLNS

public java.lang.String getXMLNS()

getIdentifier

public java.lang.String getIdentifier()

getToAddress

public JID getToAddress()

getFromAddress

public JID getFromAddress()

appendItem

public void appendItem(java.lang.StringBuffer retval)

appendItem appends the XML representation of the current packet data to the specified StringBuffer.

Specified by:

appendItem in interface Packet

Overrides:

appendItem in class XMLData

Parameters:

retval - The StringBuffer to append to