Interface TargetDialogHeader

  • All Superinterfaces:
    Cloneable, javax.sip.header.Header, javax.sip.header.Parameters, Serializable

    public interface TargetDialogHeader
    extends javax.sip.header.Header, javax.sip.header.Parameters
    RFC 4538 Target-Dialog header
     The grammar for the Target-Dialog header field is defined as follows:
    
     Target-Dialog      =     "Target-Dialog" HCOLON callid *(SEMI td-param)
                              ;callid from RFC 3261
     td-param           =     remote-param / local-param / generic-param
     remote-param       =     "remote-tag" EQUAL token
     local-param        =     "local-tag" EQUAL token
                              ;token and generic-param from RFC 3261
     
    • 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()
      Gets the Target-Dialog's Call-ID value.
      String getLocalTag()
      Gets the Target-Dialog's local-tag value.
      String getRemoteTag()
      Gets the Target-Dialog's remote-tag value.
      void setCallId​(String callId)
      Sets the Target-Dialog's Call-ID value.
      void setLocalTag​(String tag)
      Sets the Target-Dialog's local-tag value.
      void setRemoteTag​(String tag)
      Sets the Target-Dialog's remote-tag value.
      • 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 Target-Dialog's Call-ID value.
        Parameters:
        callId - the string value of the Call-ID.
        Throws:
        ParseException - if unable to parse the Call-ID value.
      • getCallId

        String getCallId()
        Gets the Target-Dialog's Call-ID value.
        Returns:
        the string value of the Call-ID.
      • setRemoteTag

        void setRemoteTag​(String tag)
                   throws ParseException
        Sets the Target-Dialog's remote-tag value.
        Parameters:
        tag - the tag value.
        Throws:
        ParseException - if unable to parse the tag value.
      • getRemoteTag

        String getRemoteTag()
        Gets the Target-Dialog's remote-tag value.
        Returns:
        the tag value.
      • setLocalTag

        void setLocalTag​(String tag)
                  throws ParseException
        Sets the Target-Dialog's local-tag value.
        Parameters:
        tag - the tag value.
        Throws:
        ParseException - if unable to parse the tag value.
      • getLocalTag

        String getLocalTag()
        Gets the Target-Dialog's local-tag value.
        Returns:
        the tag value.