Package org.jivesoftware.smackx.bytestreams.ibb.packet

Class Open

java.lang.Object
org.jivesoftware.smack.packet.Stanza
org.jivesoftware.smack.packet.IQ
org.jivesoftware.smackx.bytestreams.ibb.packet.Open
All Implemented Interfaces:
org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.IqView, org.jivesoftware.smack.packet.NamedElement, org.jivesoftware.smack.packet.StanzaView, org.jivesoftware.smack.packet.TopLevelStreamElement, org.jivesoftware.smack.packet.XmlElement, org.jivesoftware.smack.packet.XmlLangElement
public class Open extends org.jivesoftware.smack.packet.IQ
Represents a request to open an In-Band Bytestream.

  • Nested Class Summary

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

    org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder, org.jivesoftware.smack.packet.IQ.ResponseType, org.jivesoftware.smack.packet.IQ.Type

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELEMENT
     
    static final 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
    Constructor
    Description
    Open(String sessionID, int blockSize)
    Creates a new In-Band Bytestream open request packet.
    Open(String sessionID, int blockSize, InBandBytestreamManager.StanzaType stanza)
    Creates a new In-Band Bytestream open request packet.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getBlockSize()
    Returns the block size in which the data will be fragmented.
    protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder
    getIQChildElementBuilder(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder xml)
     
    String
    getSessionID()
    Returns the unique session ID identifying this In-Band Bytestream.
    InBandBytestreamManager.StanzaType
    getStanza()
    Returns the stanza type used to encapsulate the data.

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

    createErrorResponse, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementQName, getChildElementXML, getElementName, getType, setType, toString, toXML

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

    addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensionElement, getExtensions, getExtensions, getExtensions, getExtensions, getExtensionsMap, getFrom, getLanguage, getNamespace, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, setError, setFrom, setNewStanzaId, setStanzaId, setTo, throwIfNoStanzaId

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.jivesoftware.smack.packet.Element

    toXML, toXML

    Methods inherited from interface org.jivesoftware.smack.packet.IqView

    isRequestIQ, isResponseIQ

    Methods inherited from interface org.jivesoftware.smack.packet.StanzaView

    getError, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getFrom, getStanzaId, getTo, hasExtension, hasExtension, hasExtension

    Methods inherited from interface org.jivesoftware.smack.packet.XmlElement

    getQName

  • Field Details

  • Constructor Details

    • Open

      public Open(String sessionID, int blockSize, InBandBytestreamManager.StanzaType stanza)
      Creates a new In-Band Bytestream open request packet.

      The data sent over this In-Band Bytestream will be fragmented in blocks with the given block size. The block size should not be greater than 65535. A recommended default value is 4096.

      The data can be sent using IQ stanzas or message stanzas.

      Parameters:
      sessionID - unique session ID identifying this In-Band Bytestream
      blockSize - block size in which the data will be fragmented
      stanza - stanza type used to encapsulate the data

    • Open

      public Open(String sessionID, int blockSize)
      Creates a new In-Band Bytestream open request packet.

      The data sent over this In-Band Bytestream will be fragmented in blocks with the given block size. The block size should not be greater than 65535. A recommended default value is 4096.

      The data will be sent using IQ stanzas.

      Parameters:
      sessionID - unique session ID identifying this In-Band Bytestream
      blockSize - block size in which the data will be fragmented

  • Method Details

    • getSessionID

      public String getSessionID()
      Returns the unique session ID identifying this In-Band Bytestream.
      Returns:
      the unique session ID identifying this In-Band Bytestream

    • getBlockSize

      public int getBlockSize()
      Returns the block size in which the data will be fragmented.
      Returns:
      the block size in which the data will be fragmented

    • getStanza

      public InBandBytestreamManager.StanzaType getStanza()
      Returns the stanza type used to encapsulate the data.
      Returns:
      the stanza type used to encapsulate the data

    • getIQChildElementBuilder

      protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder xml)
      Specified by:
      getIQChildElementBuilder in class org.jivesoftware.smack.packet.IQ