Package com.opencloud.javax.sip.header

Interface JoinHeader

  • All Superinterfaces:
    Cloneable, javax.sip.header.Header, javax.sip.header.Parameters, Serializable
    public interface JoinHeader
extends javax.sip.header.Header, javax.sip.header.Parameters
    RFC 3911 Join header. 
     The syntax of the Join header is described as
    follows:
 
       Join            = "Join" HCOLON callid *(SEMI join-param)
       join-param      = to-tag / from-tag / generic-param
       to-tag          = "to-tag" EQUAL token
       from-tag        = "from-tag" EQUAL token
       
       
     Examples:
 
       Join: 98732@sip.example.com
              ;from-tag=r33th4x0r
              ;to-tag=ff87ff
 
       Join: 12adf2f34456gs5;to-tag=12345;from-tag=54321
 
       Join: 87134@192.0.2.23;to-tag=24796;from-tag=0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String NAME  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getCallId()
      Returns the Call-Id of JoinHeader.
      String getFromTag()
      Gets the from tag of JoinHeader.
      String getToTag()
      Gets to tag of JoinHeader.
      void setCallId​(String callId)
      Sets the Call-Id of the JoinHeader.
      void setFromTag​(String tag)
      Sets the from tag parameter of the JoinHeader.
      void setToTag​(String tag)
      Sets the to tag parameter of the JoinHeader.

      • Methods inherited from interface javax.sip.header.Header

        clone, equals, getName, hashCode, toString

      • Methods inherited from interface javax.sip.header.Parameters

        getParameter, getParameterNames, removeParameter, setParameter

    • Method Detail

      • setCallId

        void setCallId​(String callId)
        throws ParseException
        Sets the Call-Id of the JoinHeader. The CallId parameter uniquely identifies a serious of messages within a dialogue.
        Parameters:
        callId - the string value of the Call-Id of this JoinHeader.
        Throws:
        ParseException - which signals that an error has been reached unexpectedly while parsing the callId value.

      • getCallId

        String getCallId()
        Returns the Call-Id of JoinHeader. The CallId parameter uniquely identifies a series of messages within a dialogue.
        Returns:
        the String value of the Call-Id of this JoinHeader.

      • setFromTag

        void setFromTag​(String tag)
         throws ParseException
        Sets the from tag parameter of the JoinHeader. The from tag in the Join field of a request identifies the peer of the dialog.
        Parameters:
        tag - the from tag of the JoinHeader.
        Throws:
        ParseException - which signals that an error has been reached unexpectedly while parsing the from tag value.

      • getFromTag

        String getFromTag()
        Gets the from tag of JoinHeader. The from tag parameter identified the Peer of the dialogue and must always be present.
        Returns:
        the from tag parameter of the JoinHeader.

      • setToTag

        void setToTag​(String tag)
       throws ParseException
        Sets the to tag parameter of the JoinHeader. The to tag in the Join field of a request identifies the peer of the dialog.
        Parameters:
        tag - the new to tag of the JoinHeader.
        Throws:
        ParseException - which signals that an error has been reached unexpectedly while parsing the to tag value.

      • getToTag

        String getToTag()
        Gets to tag of JoinHeader. The Tag parameter identified the Peer of the dialogue.
        Returns:
        the tag parameter of the JoinHeader.