org.jivesoftware.smackx.httpfileupload.element

Class SlotRequest

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.httpfileupload.element.SlotRequest

All Implemented Interfaces:

Element, TopLevelStreamElement

Direct Known Subclasses:

SlotRequest_V0_2

public class SlotRequest
extends IQ

Upload slot request.

See Also:

XEP-0363: HTTP File Upload

Nested Class Summary

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

IQ.IQChildElementXmlStringBuilder, IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected String	contentType
static String	ELEMENT
protected String	filename
static String	NAMESPACE
protected long	size

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
	SlotRequest(org.jxmpp.jid.DomainBareJid uploadServiceAddress, String filename, long size)
	SlotRequest(org.jxmpp.jid.DomainBareJid uploadServiceAddress, String filename, long size, String contentType) Create new slot request.
protected	SlotRequest(org.jxmpp.jid.DomainBareJid uploadServiceAddress, String filename, long size, String contentType, String namespace)

Method Summary

Modifier and Type	Method and Description
String	getContentType()
String	getFilename()
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml) This method must be overwritten by IQ subclasses to create their child content.
long	getSize()

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

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

filename

protected final String filename

size

protected final long size

contentType

protected final String contentType

Constructor Detail

SlotRequest

public SlotRequest(org.jxmpp.jid.DomainBareJid uploadServiceAddress,
                   String filename,
                   long size)

SlotRequest

public SlotRequest(org.jxmpp.jid.DomainBareJid uploadServiceAddress,
                   String filename,
                   long size,
                   String contentType)

Create new slot request.

Parameters:

uploadServiceAddress - the XMPP address of the service to request the slot from.

filename - name of file

size - size of file in bytes

contentType - file content type or null

Throws:

IllegalArgumentException - if size is less than or equal to zero

SlotRequest

protected SlotRequest(org.jxmpp.jid.DomainBareJid uploadServiceAddress,
                      String filename,
                      long size,
                      String contentType,
                      String namespace)

Method Detail

getFilename

public String getFilename()

getSize

public long getSize()

getContentType

public String getContentType()

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.