org.jivesoftware.smackx.hoxt.packet

Class AbstractHttpOverXmpp

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.hoxt.packet.AbstractHttpOverXmpp

All Implemented Interfaces:

Element, TopLevelStreamElement

Direct Known Subclasses:

HttpOverXmppReq, HttpOverXmppResp

public abstract class AbstractHttpOverXmpp
extends IQ

Abstract parent for Req and Resp IQ packets.

See Also:

XEP-0332: HTTP over XMPP transport

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractHttpOverXmpp.Base64 Representation of Base64 element.
static class	AbstractHttpOverXmpp.Builder<B extends AbstractHttpOverXmpp.Builder<B,C>,C extends AbstractHttpOverXmpp> A builder for XMPP connection configurations.
static class	AbstractHttpOverXmpp.ChunkedBase64 Representation of ChunkedBase64 element.
static class	AbstractHttpOverXmpp.Data Representation of Data element.
static class	AbstractHttpOverXmpp.Ibb Representation of Ibb element.
static class	AbstractHttpOverXmpp.Text Representation of Text element.
static class	AbstractHttpOverXmpp.Xml Representation of Xml element.

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.IQChildElementXmlStringBuilder, IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE

Fields inherited from class org.jivesoftware.smack.packet.IQ

IQ_ELEMENT, QUERY_ELEMENT

Fields inherited from class org.jivesoftware.smack.packet.Stanza

DEFAULT_LANGUAGE, ITEM, language, TEXT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHttpOverXmpp(String element, AbstractHttpOverXmpp.Builder<?,?> builder)

Method Summary

Modifier and Type	Method and Description
AbstractHttpOverXmpp.Data	getData() Returns Data element.
HeadersExtension	getHeaders() Returns Headers element.
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml) This method must be overwritten by IQ subclasses to create their child content.
protected abstract IQ.IQChildElementXmlStringBuilder	getIQHoxtChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml) Returns start tag.
String	getVersion() Returns version attribute.

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createErrorResponse, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementXML, getChildElementXML, getType, initializeAsResultFor, initialzeAsResultFor, isRequestIQ, setType, toString, toXML

Methods inherited from class org.jivesoftware.smack.packet.Stanza

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensions, getFrom, getLanguage, getPacketID, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, removeExtension, setError, setError, setFrom, setFrom, setLanguage, setPacketID, setStanzaId, setStanzaId, setTo, setTo

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

AbstractHttpOverXmpp

protected AbstractHttpOverXmpp(String element,
                               AbstractHttpOverXmpp.Builder<?,?> builder)

Method Detail

getIQChildElementBuilder

protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)

Description copied from class: IQ

This method must be overwritten by IQ subclasses to create their child content. It is important you don't use the builder to add the final end tag. This will be done automatically by IQ.IQChildElementXmlStringBuilder after eventual existing ExtensionElements have been added.

For example to create an IQ with a extra attribute and an additional child element

 
 <iq to='foo@example.org' id='123'>
   <bar xmlns='example:bar' extraAttribute='blaz'>
      <extraElement>elementText</extraElement>
   </bar>
 </iq>
 
 

the body of the getIQChildElementBuilder looks like

 
 // The builder 'xml' will already have the child element and the 'xmlns' attribute added
 // So the current builder state is "<bar xmlns='example:bar'"
 xml.attribute("extraAttribute", "blaz");
 xml.rightAngleBracket();
 xml.element("extraElement", "elementText");
 // Do not close the 'bar' attribute by calling xml.closeElement('bar')
 
 

If your IQ only contains attributes and no child elements, i.e. it can be represented as empty element, then you can mark it as such.

 xml.attribute("myAttribute", "myAttributeValue");
 xml.setEmptyElement();
 

If your IQ does not contain any attributes or child elements (besides ExtensionElements), consider sub-classing SimpleIQ instead.

Specified by:

getIQChildElementBuilder in class IQ

Parameters:

xml - a pre-created builder which already has the child element and the 'xmlns' attribute set.

Returns:

the build to create the IQ child content.

getIQHoxtChildElementBuilder

protected abstract IQ.IQChildElementXmlStringBuilder getIQHoxtChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)

Returns start tag.

Parameters:

xml - builder.

Returns:

start tag

getVersion

public String getVersion()

Returns version attribute.

Returns:

version attribute

getHeaders

public HeadersExtension getHeaders()

Returns Headers element.

Returns:

Headers element

getData

public AbstractHttpOverXmpp.Data getData()

Returns Data element.

Returns:

Data element