Class Jingle

    • Constructor Detail

      • Jingle

        public Jingle​(java.util.List<JingleContent> contents,
                      JingleContentInfo mi,
                      java.lang.String sid)
        A constructor where the main components can be initialized.
        Parameters:
        contents - the contents.
        mi - the jingle content info
        sid - the sid.
      • Jingle

        public Jingle​(JingleContent content)
        Constructor with a contents.
        Parameters:
        content - a content
      • Jingle

        public Jingle​(JingleContentInfo info)
        Constructor with a content info.
        Parameters:
        info - The content info
      • Jingle

        public Jingle​(JingleActionEnum action)
        A constructor where the action can be specified.
        Parameters:
        action - The action.
      • Jingle

        public Jingle​(java.lang.String sid)
        A constructor where the session ID can be specified.
        Parameters:
        sid - The session ID related to the negotiation.
        See Also:
        setSid(String)
      • Jingle

        public Jingle()
        The default constructor.
    • Method Detail

      • setSid

        public final void setSid​(java.lang.String sid)
        Set the session ID related to this session. The session ID is a unique identifier generated by the initiator. This should match the XML Nmtoken production so that XML character escaping is not needed for characters such as &.
        Parameters:
        sid - the session ID
      • getSid

        public java.lang.String getSid()
        Returns the session ID related to the session. The session ID is a unique identifier generated by the initiator. This should match the XML Nmtoken production so that XML character escaping is not needed for characters such as &.
        Returns:
        Returns the session ID related to the session.
        See Also:
        setSid(String)
      • getContents

        public java.util.Iterator<JingleContentgetContents()
        Get an iterator for the contents.
        Returns:
        the contents
      • addContent

        public void addContent​(JingleContent content)
        Add a new content.
        Parameters:
        content - the content to add
      • addContents

        public void addContents​(java.util.List<JingleContent> contentList)
        Add a list of JingleContent elements.
        Parameters:
        contentList - the list of contents to add
      • setAction

        public void setAction​(JingleActionEnum action)
        Set the action in the packet.
        Parameters:
        action - the action to set
      • getInitiator

        public Jid getInitiator()
        Get the initiator. The initiator will be the full JID of the entity that has initiated the flow (which may be different to the "from" address in the IQ)
        Returns:
        the initiator
      • setInitiator

        public void setInitiator​(Jid initiator)
        Set the initiator. The initiator must be the full JID of the entity that has initiated the flow (which may be different to the "from" address in the IQ)
        Parameters:
        initiator - the initiator to set
      • getResponder

        public Jid getResponder()
        Get the responder. The responder is the full JID of the entity that has replied to the initiation (which may be different to the "to" address in the IQ).
        Returns:
        the responder
      • setResponder

        public void setResponder​(Jid resp)
        Set the responder. The responder must be the full JID of the entity that has replied to the initiation (which may be different to the "to" address in the IQ).
        Parameters:
        resp - the responder to set
      • getSessionHash

        public static int getSessionHash​(java.lang.String sid,
                                         Jid initiator)
        Get a hash key for the session this stanza belongs to.
        Parameters:
        sid - The session id
        initiator - The initiator
        Returns:
        A hash key