Package com.opencloud.javax.sip.header

Interface ReplacesHeader

  • All Superinterfaces:
    Cloneable, javax.sip.header.Header, javax.sip.header.Parameters, Serializable
    public interface ReplacesHeader
extends javax.sip.header.Header, javax.sip.header.Parameters
    RFC 3891 Replaces header. 
     The syntax of the Replaces header is described as
    follows:
 
       Replaces        = "Replaces" HCOLON callid *(SEMI replaces-param)
       replaces-param  = to-tag / from-tag / early-flag / generic-param
       to-tag          = "to-tag" EQUAL token
       from-tag        = "from-tag" EQUAL token
       early-flag      = "early-only"
    
    Examples:
 
       Replaces: 98732@sip.example.com
                 ;from-tag=r33th4x0r
                 ;to-tag=ff87ff
 
       Replaces: 12adf2f34456gs5;to-tag=12345;from-tag=54321;early-only
 
       Replaces: 87134@171.161.34.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 ReplacesHeader.
      String getFromTag()
      Gets the from tag of ReplacesHeader.
      String getToTag()
      Gets to tag of ReplacesHeader.
      boolean isEarlyOnly()
      Determine if early only parameter is present in the ReplacesHeader.
      void setCallId​(String callId)
      Sets the Call-Id of the ReplacesHeader.
      void setEarlyOnly​(boolean earlyOnly)
      Sets the early only parameter in the ReplacesHeader.
      void setFromTag​(String tag)
      Sets the from tag parameter of the ReplacesHeader.
      void setToTag​(String tag)
      Sets the to tag parameter of the ReplacesHeader.

      • 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 ReplacesHeader. The CallId parameter uniquely identifies a serious of messages within a dialogue.
        Parameters:
        callId - the string value of the Call-Id of this ReplacesHeader.
        Throws:
        ParseException - which signals that an error has been reached unexpectedly while parsing the callId value.

      • getCallId

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

      • setFromTag

        void setFromTag​(String tag)
         throws ParseException
        Sets the from tag parameter of the ReplacesHeader. The from tag in the Replaces field of a request identifies the peer of the dialog.
        Parameters:
        tag - the from tag of the ReplacesHeader.
        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 ReplacesHeader. The from tag parameter identified the Peer of the dialogue and must always be present.
        Returns:
        the from tag parameter of the ReplacesHeader.

      • setToTag

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

      • getToTag

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

      • isEarlyOnly

        boolean isEarlyOnly()
        Determine if early only parameter is present in the ReplacesHeader.
        Returns:
        true if early-only parameter is present, false otherwise.

      • setEarlyOnly

        void setEarlyOnly​(boolean earlyOnly)
        Sets the early only parameter in the ReplacesHeader.
        Parameters:
        earlyOnly - true to add early-only parameter, false to remove it.